欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

C#基于Socket的TCP通讯例程 Server Client

程序员文章站 2022-06-14 10:18:31
...

一、简单了解服务端和客户端各自的功能

首先应该清楚服务端(Server)和客户端(Client)它们各自的功能。
(1)服务端(Server):负责接收客户端的请求,然后根据客户端请求的内容不同而给客户端返回相应的数据。
(2)客户端(Client):接服务端,向服务端发送自己的业务需求(也就是数据),然后接受服务端返回过来的信息。
(3)分析服务端和客户端的功能,可以很清楚的知道,它们完成了数据之间的交流,或者说是业务之间的相互传递与获取。

二、服务器与客户端之间信息传递的桥梁(Socket)

(1)服务器和客户端进行信息传递的通道,socket套接字分为很多种类型,它是一个协议族,常用的协议TCP/IP和UDP两种。
(2)简单来说就是通过socket协议能够进行通信,每种编程语言socket的写法都八九不离十,创建socket通信的步骤都十分接近。
(3)服务端socket和客户端socket通过对方的IP地址和对应应用程序的PORT(端口号)进行连接和数据传输。

三、代码功能

功能如下:
1、基础功能包括服务器开启监听服务,监听客户端,可以断开监听,客户端可以连接服务器,断开服务器,当客户端和服务器连接成功后,两者可以相互通讯;
2、扩展功能包括一个服务器可以连接多个客户端,每个客户端连接成功后,都会记录并显示对应的IP及端口,断开后删除对应的IP及端口,在发送消息时会加上对应的IP及端口,服务器在发送消息时,可以在列表那选择某个客户端进行发送消息,也可以对所有客户端进行群发消息。

四、代码实现效果图

C#基于Socket的TCP通讯例程 Server Client
C#基于Socket的TCP通讯例程 Server Client
C#基于Socket的TCP通讯例程 Server Client

五、代码实现

服务器的.cs文件

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Net;
using System.Net.Sockets;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace TcpMsgServer
{
    public partial class FrmServer : Form
    {
        public FrmServer()
        {
            InitializeComponent();
            //关闭对文本框的非法线程操作检查
            TextBox.CheckForIllegalCrossThreadCalls = false;
        }

        Thread threadWatch = null; //负责监听客户端的线程
        Socket socketWatch = null; //负责监听客户端的套接字     

        Dictionary<string, Socket> dict = new Dictionary<string, Socket>(); //套接字集合
        Dictionary<string, Thread> dictThread = new Dictionary<string, Thread>();  //线程集合

        /// <summary>
        /// 启动服务
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void btnServerConn_Click(object sender, EventArgs e)
        {
            try
            {
                //定义一个套接字用于监听客户端发来的信息 包含3个参数(IP4寻址协议,流式连接,TCP协议)
                socketWatch = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
                //服务端发送信息 需要1个IP地址和端口号              
                IPAddress ipaddress = IPAddress.Parse(this.txtIP.Text.Trim());  //获取文本框输入的IP地址
                //将IP地址和端口号绑定到网络节点endpoint上 
                IPEndPoint endpoint = new IPEndPoint(ipaddress, int.Parse(this.txtPort.Text.Trim())); //获取文本框上输入的端口号
                //监听绑定的网络节点
                socketWatch.Bind(endpoint);
                //将套接字的监听队列长度限制为20
                socketWatch.Listen(20);
                //创建一个监听委托
                ThreadStart ts = new ThreadStart(WatchConnecting);
                //创建一个监听线程 
                threadWatch = new Thread(ts);
                //将窗体线程设置为与后台同步
                threadWatch.IsBackground = true;
                //启动线程
                threadWatch.Start();
                //启动线程后 txtMsg文本框显示相应提示
                txtMsg.AppendText("开始监听客户端传来的信息!" + "\r\n");

                this.btnServerConn.Enabled = false;
                this.btnServerDisConn.Enabled = true;
            }
            catch (Exception ex) {
                Console.WriteLine("错误:"+ex.ToString());
                txtMsg.AppendText("服务端启动服务失败!" + "\r\n");
                this.btnServerConn.Enabled = true;
            }
        }

        private void btnServerDisConn_Click(object sender, EventArgs e)
        {
            //有问题
            socketWatch.Close();
            threadWatch.Abort();
            
            txtMsg.AppendText("结束监听客户端传来的信息!" + "\r\n");
            this.btnServerConn.Enabled = true;
            this.btnServerDisConn.Enabled = false;

        }


        //创建一个负责和客户端通信的套接字 
        Socket socConnection = null;

        /// <summary>
        /// 监听客户端发来的请求
        /// </summary>
        private void WatchConnecting()
        {
            while (true)  //持续不断监听客户端发来的请求
            {
                try
                {

                    socConnection = socketWatch.Accept();  //等待客户端的连接 并且创建一个负责通信的Socket        
                    // 向列表控件中添加客户端的IP信息;
                    lb_ipOnline.Items.Add(socConnection.RemoteEndPoint.ToString());
                    // 将与客户端连接的 套接字 对象添加到集合中;
                    dict.Add(socConnection.RemoteEndPoint.ToString(), socConnection);
                    //txtMsg.AppendText("客户端连接成功! " + "\r\n");
                    txtMsg.AppendText(socConnection.RemoteEndPoint.ToString() + "客户端连接成功! " + "\r\n"); //客户端IP
                    //创建一个通信线程 
                    ParameterizedThreadStart pts = new ParameterizedThreadStart(ServerRecMsg);
                    Thread thr = new Thread(pts);
                    thr.IsBackground = true;
                    //启动线程
                    thr.Start(socConnection);

                    dictThread.Add(socConnection.RemoteEndPoint.ToString(), thr);   // 将新建的线程 添加 到线程的集合中去。
                }
                catch (Exception ex)
                {
                    Console.WriteLine("错误:" + ex.ToString());
                    txtMsg.AppendText("客户端连接失败!" + "\r\n");
                }
                
            }
        }

        /// <summary>
        /// 发送信息到客户端的方法
        /// </summary>
        /// <param name="sendMsg">发送的字符串信息</param>
        private void ServerSendMsg(string sendMsg)
        {
            string strKey = "";
            try
            {
                //将输入的字符串转换成 机器可以识别的字节数组
                byte[] arrSendMsg = Encoding.UTF8.GetBytes(sendMsg);
                //向客户端发送字节数组信息
                //socConnection.Send(arrSendMsg);

                
                strKey = lb_ipOnline.Text.Trim();
                if (string.IsNullOrEmpty(strKey))   // 判断是不是选择了发送的对象;
                {
                    MessageBox.Show("请选择你要发送的好友!!!");
                }
                else
                {
                    dict[strKey].Send(arrSendMsg);// 解决了 sokConnection是局部变量,不能再本函数中引用的问题;

                    //将发送的字符串信息附加到文本框txtMsg上
                    txtMsg.AppendText(socConnection.LocalEndPoint.ToString() + "服务器 " + GetCurrentTime() + "\r\n" + sendMsg + "\r\n");                    
                }                

            }
            catch (Exception ex) {
                Console.WriteLine("错误:" + ex.ToString());
                txtMsg.AppendText(dict[strKey].RemoteEndPoint.ToString() + "客户端已断开连接,无法发送信息!" + "\r\n");
            }
        }

        /// <summary>
        /// 发送信息到客户端的方法
        /// </summary>
        /// <param name="sendMsg">发送的字符串信息</param>
        private void ServerSendMsgAll(string sendMsg)
        {
            
            try
            {
                //将输入的字符串转换成 机器可以识别的字节数组
                byte[] arrSendMsg = Encoding.UTF8.GetBytes(sendMsg);
                //向客户端发送字节数组信息
                //socConnection.Send(arrSendMsg);

                foreach (Socket s in dict.Values)
                {
                    //s.Send(arrMsg);
                    s.Send(arrSendMsg);                    
                }
                txtMsg.AppendText(socConnection.LocalEndPoint.ToString() + "服务器群发 " + GetCurrentTime() + "\r\n" + sendMsg + "\r\n");

            }
            catch (Exception ex)
            {
                Console.WriteLine("错误:" + ex.ToString());
                txtMsg.AppendText("客户端已断开连接,无法发送信息!" + "\r\n");
            }
        }


        /// <summary>
        /// 接收客户端发来的信息 
        /// </summary>
        /// <param name="socketClientPara">客户端套接字对象</param>
        private void ServerRecMsg(object socketClientPara)
        {
            Socket socketServer = socketClientPara as Socket; //类型转换 objec->Socket
            while (true)
            {
                //创建一个内存缓冲区 其大小为1024*1024字节  即1M
                byte[] arrServerRecMsg = new byte[1024 * 1024];
                try
                {
                    //将接收到的信息存入到内存缓冲区,并返回其字节数组的长度
                    int length = socketServer.Receive(arrServerRecMsg);
                    //将机器接受到的字节数组转换为人可以读懂的字符串
                    string strSRecMsg = Encoding.UTF8.GetString(arrServerRecMsg, 0, length);
                    Console.WriteLine(length);
                    if (strSRecMsg.Length != 0)
                    {
                        //将发送的字符串信息附加到文本框txtMsg上   客户端IP 时间  消息
                        
                        txtMsg.AppendText(socketServer.RemoteEndPoint.ToString() + "客户端 " + GetCurrentTime() + "\r\n" + strSRecMsg + "\r\n");
                        System.Console.WriteLine(strSRecMsg);
                    }
                    
                }
                catch (Exception ex) {
                    Console.WriteLine("错误:" + ex.ToString());
                    txtMsg.AppendText(socketServer.RemoteEndPoint.ToString() + "客户端已断开连接!" + "\r\n");

                    // 从 通信套接字 集合中删除被中断连接的通信套接字;
                    dict.Remove(socketServer.RemoteEndPoint.ToString());
                    // 从通信线程集合中删除被中断连接的通信线程对象;
                    dictThread.Remove(socketServer.RemoteEndPoint.ToString());
                    // 从列表中移除被中断的连接IP
                    lb_ipOnline.Items.Remove(socketServer.RemoteEndPoint.ToString());

                    break;
                }
            }
        }

        /// <summary>
        /// 发送消息到客户端
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void btnSendMsg_Click(object sender, EventArgs e)
        {
            if (this.txtSendMsg.Text.Trim() != "")
            {
                //调用 ServerSendMsg方法  发送信息到客户端
                ServerSendMsg(this.txtSendMsg.Text.Trim()); //.Trim()是删除字符串头部及尾部出现的空格
                this.txtSendMsg.Clear();
            }
            
        }

        private void btnSendMsgAll_Click(object sender, EventArgs e)
        {
            if (this.txtSendMsg.Text.Trim() != "")
            {
                //调用 ServerSendMsgAll方法  群发信息到客户端
                ServerSendMsgAll(this.txtSendMsg.Text.Trim()); //.Trim()是删除字符串头部及尾部出现的空格
                this.txtSendMsg.Clear();
            }
        }


        /// <summary>
        /// 快捷键 Enter 发送信息
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void txtSendMsg_KeyDown(object sender, KeyEventArgs e)
        {
            //如果用户按下了Enter键
            if (e.KeyCode == Keys.Enter)
            {
                //则调用 服务器向客户端发送信息的方法
                ServerSendMsg(this.txtSendMsg.Text.Trim());//.Trim()是删除字符串头部及尾部出现的空格
                this.txtSendMsg.Clear();
            }
        }



        /// <summary>
        /// 获取当前系统时间的方法
        /// </summary>
        /// <returns>当前时间</returns>
        private DateTime GetCurrentTime()
        {
            DateTime currentTime = new DateTime();
            currentTime = DateTime.Now;
            return currentTime;
        }

        /// <summary>
        /// 获取本地IPv4地址
        /// </summary>
        /// <returns></returns>
        public IPAddress GetLocalIPv4Address() {
            IPAddress localIpv4 = null;
            //获取本机所有的IP地址列表
            IPAddress[] IpList = Dns.GetHostAddresses(Dns.GetHostName());
            //循环遍历所有IP地址
            foreach (IPAddress IP in IpList) {
                //判断是否是IPv4地址
                if (IP.AddressFamily == AddressFamily.InterNetwork)
                {
                    localIpv4 = IP;
                }
                else {
                    continue;
                }
            }
            return localIpv4;
        }

        /// <summary>
        /// 获取本地IP事件
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void btnGetLocalIP_Click(object sender, EventArgs e)
        {
            //接收IPv4的地址
            IPAddress localIP = GetLocalIPv4Address();
            //赋值给文本框
            this.txtIP.Text = localIP.ToString();
           
        }


    }
}

客户端的.cs文件代码

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Net;
using System.Net.Sockets;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace TcpMsgClient
{
    public partial class FrmClient : Form
    {
        public FrmClient()
        {
            InitializeComponent();
            //关闭对文本框的非法线程操作检查
            TextBox.CheckForIllegalCrossThreadCalls = false;
        }
        //创建 1个客户端套接字 和1个负责监听服务端请求的线程  
        Socket socketClient = null;
        Thread threadClient = null;

        /// <summary>
        /// 连接服务端事件
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void btnListenServer_Click(object sender, EventArgs e)
        {
            //定义一个套字节监听  包含3个参数(IP4寻址协议,流式连接,TCP协议)
            socketClient = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
            ////需要获取文本框中的IP地址
            //IPAddress ipaddress = IPAddress.Parse(this.txtIP.Text.Trim());
            //获取文本框中的域名解析后赋值到IP文本框内
            if(this.txtDns.Text.Trim() != "")
            {
                this.txtIP.Text = Dns.GetHostEntry(this.txtDns.Text.Trim()).AddressList[0].ToString();
            }            

            IPAddress ipaddress = IPAddress.Parse(this.txtIP.Text.Trim()); ;
            //将获取的ip地址和端口号绑定到网络节点endpoint上
            IPEndPoint endpoint = new IPEndPoint(ipaddress, int.Parse(this.txtPort.Text.Trim()));
            //这里客户端套接字连接到网络节点(服务端)用的方法是Connect 而不是Bind
            try
            {
                socketClient.Connect(endpoint);
                this.txtMsg.AppendText("客户端连接服务器端成功!" + "\r\n");
                this.btnListenServer.Enabled = false;
                //创建一个监听委托
                ThreadStart ts = new ThreadStart(RecMsg);
                //创建一个线程用于监听服务端发来的消息
                threadClient = new Thread(ts);
                //将窗体线程设置为与后台同步
                threadClient.IsBackground = true;
                //启动线程
                threadClient.Start();

                this.btnListenServer.Enabled = false;
                this.btnStopServer.Enabled = true;
            }
            catch (Exception ex) {
                Console.WriteLine("错误信息:" + ex.ToString());
                this.txtMsg.AppendText("远程服务端断开,连接失败!" + "\r\n");
            }         
        }

        private void btnStopServer_Click(object sender, EventArgs e)
        {
            socketClient.Close();
            threadClient.Abort();
            this.btnListenServer.Enabled = true;
            this.btnStopServer.Enabled = false;
        }

        /// <summary>
        /// 接收服务端发来信息的方法
        /// </summary>
        private void RecMsg()
        {
            while (true) //持续监听服务端发来的消息
            {
                try
                {
                    //定义一个1M的内存缓冲区 用于临时性存储接收到的信息
                    byte[] arrRecMsg = new byte[1024 * 1024];
                    //将客户端套接字接收到的数据存入内存缓冲区, 并获取其长度
                    int length = socketClient.Receive(arrRecMsg);
                    //将套接字获取到的字节数组转换为人可以看懂的字符串
                    string strRecMsg = Encoding.UTF8.GetString(arrRecMsg, 0, length);
                    //string strRecMsg = Encoding.UTF8.GetString(arrRecMsg, 2, length);
                    //将发送的信息追加到聊天内容文本框中
                    txtMsg.AppendText(socketClient.RemoteEndPoint.ToString() + "服务端 " + GetCurrentTime() + "\r\n" + strRecMsg + "\r\n");
                }
                catch (Exception ex) {
                    Console.WriteLine("错误信息:" + ex.ToString());
                    this.txtMsg.AppendText("远程服务器已中断连接!"+"\r\n");
                    this.btnListenServer.Enabled = true;
                    break;
                }
            }
        }

        /// <summary>
        /// 发送字符串信息到服务端的方法
        /// </summary>
        /// <param name="sendMsg">发送的字符串信息</param>
        private void ClientSendMsg(string sendMsg)
        {
            try { 
                 //将输入的内容字符串转换为机器可以识别的字节数组
                byte[] arrClientSendMsg = Encoding.UTF8.GetBytes(sendMsg);
                Console.WriteLine(arrClientSendMsg);
                //调用客户端套接字发送字节数组
                socketClient.Send(arrClientSendMsg);
                //将发送的信息追加到聊天内容文本框中
                txtMsg.AppendText(socketClient.LocalEndPoint.ToString() + "客户端" + GetCurrentTime() + "\r\n" + sendMsg + "\r\n");
            }
            catch(Exception ex){
                Console.WriteLine("错误信息:" + ex.ToString());
                this.txtMsg.AppendText("远程服务器已中断连接,无法发送消息!" + "\r\n");
            }
        }

        private void btnSendMsg_Click(object sender, EventArgs e)
        {
            //调用ClientSendMsg方法 将文本框中输入的信息发送给服务端
            ClientSendMsg(this.txtClientSendMsg.Text.Trim());
            this.txtClientSendMsg.Clear();
        }

        private void txtClientSendMsg_KeyDown(object sender, KeyEventArgs e)
        {
            //当光标位于文本框时 如果用户按下了键盘上的Enter键 
            if (e.KeyCode == Keys.Enter)
            {
                //则调用客户端向服务端发送信息的方法
                ClientSendMsg(this.txtClientSendMsg.Text.Trim());
                this.txtClientSendMsg.Clear();
            }
        }

        /// <summary>
        /// 获取当前系统时间的方法
        /// </summary>
        /// <returns>当前时间</returns>
        private DateTime GetCurrentTime()
        {
            DateTime currentTime = new DateTime();
            currentTime = DateTime.Now;
            return currentTime;
        }


    }
}

具体代码链接

相关标签: socket c#