C#中Socket架構的使用教程

最近一個項目因為要用到Socket傳輸問題，所以決定學習一下，將自己學習的內容總結分享出來，下面這篇文章主要給大家介紹了關於C# .NET中Socket簡單實用架構使用的相關資料，文中通過範例程式碼介紹的非常詳細，需要的朋友可以參考下。

前言

一說到Socket，想必大家都或多或少有所涉及，從最初的電腦網路課程，講述了tcp協議，而Socket就是對協議的進一步封裝，使我們開發人員能夠更加容易輕鬆的進行軟體之間的通訊。

這個星期剛好接受一個共用車位鎖的項目，需要使用Socket與硬體進行通訊控制，說白了也就是給鎖發送指令，控制其開啟或者關閉，再就是對App開放操作介面，使其方便測試以及使用者的使用。這其中核心就是Socket的使用，再開發出這個功能之後，我發現使用起來很不方便，於是耗時2天抽象其核心功能並封裝成架構，最後使用這個架構將原來的項目重構並上線，極大的提高了軟體的可拓展性，健壯性，容錯率。

個人堅信的原則：萬物皆對象

好了，不廢話了，下面進入本文

本文：

1、首先簡單講下C#中Socket的簡單使用。

第一步：服務端監聽某個連接埠

第二步：用戶端向服務端地址和連接埠發起Socket串連請求

第三步：服務端收到串連請求後建立Socket串連，並維護這個串連隊列。

第四步：用戶端和服務端已經建立雙工通訊（即雙向通訊），用戶端和服務端可以輕鬆方便的給彼此發送資訊。

至於簡單使用的具體實現代碼全部被我封裝到項目中了，如果需要學習簡單的實現，可以看我的源碼，也可以自行百度，有很多的教程

2、核心，架構的使用

其實，說其為架構，可能有點牽強，因為每個人對架構都有自己的理解，但是類庫和架構又有什麼本質區別呢？全部都是代碼~哈哈，扯遠了

首先，空說無憑，先放上所有的代碼：

服務端源檔案：

SocketServer.cs

using System;using System.Collections.Generic;using System.Net;using System.Net.Sockets;namespace Coldairarrow.Util.Sockets{ /// <summary> /// Socket服務端 /// </summary> public class SocketServer {  #region 建構函式  /// <summary>  /// 建構函式  /// </summary>  /// <param name="ip">監聽的IP地址</param>  /// <param name="port">監聽的連接埠</param>  public SocketServer(string ip, int port)  {   _ip = ip;   _port = port;  }  /// <summary>  /// 建構函式,監聽IP地址預設為本機0.0.0.0  /// </summary>  /// <param name="port">監聽的連接埠</param>  public SocketServer(int port)  {   _ip = "0.0.0.0";   _port = port;  }  #endregion  #region 內部成員  private Socket _socket = null;  private string _ip = "";  private int _port = 0;  private bool _isListen = true;  private void StartListen()  {   try   {    _socket.BeginAccept(asyncResult =>    {     try     {      Socket newSocket = _socket.EndAccept(asyncResult);      //馬上進行下一輪監聽,增加輸送量      if (_isListen)       StartListen();      SocketConnection newClient = new SocketConnection(newSocket, this)      {       HandleRecMsg = HandleRecMsg == null ? null : new Action<byte[], SocketConnection, SocketServer>(HandleRecMsg),       HandleClientClose = HandleClientClose == null ? null : new Action<SocketConnection, SocketServer>(HandleClientClose),       HandleSendMsg = HandleSendMsg == null ? null : new Action<byte[], SocketConnection, SocketServer>(HandleSendMsg),       HandleException = HandleException == null ? null : new Action<Exception>(HandleException)      };      newClient.StartRecMsg();      ClientList.AddLast(newClient);      HandleNewClientConnected?.Invoke(this, newClient);     }     catch (Exception ex)     {      HandleException?.Invoke(ex);     }    }, null);   }   catch (Exception ex)   {    HandleException?.Invoke(ex);   }  }  #endregion  #region 外部介面  /// <summary>  /// 開始服務，監聽用戶端  /// </summary>  public void StartServer()  {   try   {    //執行個體化通訊端（ip4定址協議，串流，TCP協議）    _socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);    //建立ip對象    IPAddress address = IPAddress.Parse(_ip);    //建立網路節點對象包含ip和port    IPEndPoint endpoint = new IPEndPoint(address, _port);    //將 監聽通訊端綁定到 對應的IP和連接埠    _socket.Bind(endpoint);    //設定監聽隊列長度為Int32最大值(同時能夠處理串連請求數量)    _socket.Listen(int.MaxValue);    //開始監聽用戶端    StartListen();    HandleServerStarted?.Invoke(this);   }   catch (Exception ex)   {    HandleException?.Invoke(ex);   }  }  /// <summary>  /// 所有串連的用戶端列表  /// </summary>  public LinkedList<SocketConnection> ClientList { get; set; } = new LinkedList<SocketConnection>();  /// <summary>  /// 關閉指定用戶端串連  /// </summary>  /// <param name="theClient">指定的用戶端串連</param>  public void CloseClient(SocketConnection theClient)  {   theClient.Close();  }  #endregion  #region 公用事件  /// <summary>  /// 例外處理常式  /// </summary>  public Action<Exception> HandleException { get; set; }  #endregion  #region 服務端事件  /// <summary>  /// 服務啟動後執行  /// </summary>  public Action<SocketServer> HandleServerStarted { get; set; }  /// <summary>  /// 當新用戶端串連後執行  /// </summary>  public Action<SocketServer, SocketConnection> HandleNewClientConnected { get; set; }  /// <summary>  /// 服務端關閉用戶端後執行  /// </summary>  public Action<SocketServer, SocketConnection> HandleCloseClient { get; set; }  #endregion  #region 用戶端串連事件  /// <summary>  /// 用戶端串連接受新的訊息後調用  /// </summary>  public Action<byte[], SocketConnection, SocketServer> HandleRecMsg { get; set; }  /// <summary>  /// 用戶端串連發送訊息後回調  /// </summary>  public Action<byte[], SocketConnection, SocketServer> HandleSendMsg { get; set; }  /// <summary>  /// 用戶端串連關閉後回調  /// </summary>  public Action<SocketConnection, SocketServer> HandleClientClose { get; set; }  #endregion }}

using System;using System.Net.Sockets;using System.Text;namespace Coldairarrow.Util.Sockets{ /// <summary> /// Socket串連,雙向通訊 /// </summary> public class SocketConnection {  #region 建構函式  public SocketConnection(Socket socket,SocketServer server)  {   _socket = socket;   _server = server;  }  #endregion  #region 私人成員    private readonly Socket _socket;  private bool _isRec=true;  private SocketServer _server = null;  private bool IsSocketConnected()  {   bool part1 = _socket.Poll(1000, SelectMode.SelectRead);   bool part2 = (_socket.Available == 0);   if (part1 && part2)    return false;   else    return true;  }  #endregion  #region 外部介面  /// <summary>  /// 開始接受用戶端訊息  /// </summary>  public void StartRecMsg()  {   try   {    byte[] container = new byte[1024 * 1024 * 2];    _socket.BeginReceive(container, 0, container.Length, SocketFlags.None, asyncResult =>    {     try     {      int length = _socket.EndReceive(asyncResult);      //馬上進行下一輪接受，增加輸送量      if (length > 0 && _isRec && IsSocketConnected())       StartRecMsg();      if (length > 0)      {       byte[] recBytes = new byte[length];       Array.Copy(container, 0, recBytes, 0, length);       //處理訊息       HandleRecMsg?.Invoke(recBytes, this, _server);      }      else       Close();     }     catch (Exception ex)     {      HandleException?.Invoke(ex);      Close();     }    }, null);   }   catch (Exception ex)   {    HandleException?.Invoke(ex);    Close();   }  }  /// <summary>  /// 發送資料  /// </summary>  /// <param name="bytes">資料位元組</param>  public void Send(byte[] bytes)  {   try   {    _socket.BeginSend(bytes, 0, bytes.Length, SocketFlags.None, asyncResult =>    {     try     {      int length = _socket.EndSend(asyncResult);      HandleSendMsg?.Invoke(bytes, this, _server);     }     catch (Exception ex)     {      HandleException?.Invoke(ex);     }    }, null);   }   catch (Exception ex)   {    HandleException?.Invoke(ex);   }  }  /// <summary>  /// 發送字串（預設使用UTF-8編碼）  /// </summary>  /// <param name="msgStr">字串</param>  public void Send(string msgStr)  {   Send(Encoding.UTF8.GetBytes(msgStr));  }  /// <summary>  /// 發送字串（使用自訂編碼）  /// </summary>  /// <param name="msgStr">字串訊息</param>  /// <param name="encoding">使用的編碼</param>  public void Send(string msgStr,Encoding encoding)  {   Send(encoding.GetBytes(msgStr));  }  /// <summary>  /// 傳入自訂屬性  /// </summary>  public object Property { get; set; }  /// <summary>  /// 關閉當前串連  /// </summary>  public void Close()  {   try   {    _isRec = false;    _socket.Disconnect(false);    _server.ClientList.Remove(this);    HandleClientClose?.Invoke(this, _server);    _socket.Close();    _socket.Dispose();    GC.Collect();   }   catch (Exception ex)   {    HandleException?.Invoke(ex);   }  }  #endregion  #region 事件處理  /// <summary>  /// 用戶端串連接受新的訊息後調用  /// </summary>  public Action<byte[], SocketConnection, SocketServer> HandleRecMsg { get; set; }  /// <summary>  /// 用戶端串連發送訊息後回調  /// </summary>  public Action<byte[], SocketConnection, SocketServer> HandleSendMsg { get; set; }  /// <summary>  /// 用戶端串連關閉後回調  /// </summary>  public Action<SocketConnection, SocketServer> HandleClientClose { get; set; }  /// <summary>  /// 例外處理常式  /// </summary>  public Action<Exception> HandleException { get; set; }  #endregion }}

using System;using System.Net;using System.Net.Sockets;using System.Text;namespace Coldairarrow.Util.Sockets{ /// <summary> /// Socket用戶端 /// </summary> public class SocketClient {  #region 建構函式  /// <summary>  /// 建構函式,串連伺服器IP地址預設為本機127.0.0.1  /// </summary>  /// <param name="port">監聽的連接埠</param>  public SocketClient(int port)  {   _ip = "127.0.0.1";   _port = port;  }  /// <summary>  /// 建構函式  /// </summary>  /// <param name="ip">監聽的IP地址</param>  /// <param name="port">監聽的連接埠</param>  public SocketClient(string ip, int port)  {   _ip = ip;   _port = port;  }  #endregion  #region 內部成員  private Socket _socket = null;  private string _ip = "";  private int _port = 0;  private bool _isRec=true;  private bool IsSocketConnected()  {   bool part1 = _socket.Poll(1000, SelectMode.SelectRead);   bool part2 = (_socket.Available == 0);   if (part1 && part2)    return false;   else    return true;  }  /// <summary>  /// 開始接受用戶端訊息  /// </summary>  public void StartRecMsg()  {   try   {    byte[] container = new byte[1024 * 1024 * 2];    _socket.BeginReceive(container, 0, container.Length, SocketFlags.None, asyncResult =>    {     try     {      int length = _socket.EndReceive(asyncResult);      //馬上進行下一輪接受，增加輸送量      if (length > 0 && _isRec && IsSocketConnected())       StartRecMsg();      if (length > 0)      {       byte[] recBytes = new byte[length];       Array.Copy(container, 0, recBytes, 0, length);       //處理訊息       HandleRecMsg?.Invoke(recBytes, this);      }      else       Close();     }     catch (Exception ex)     {      HandleException?.Invoke(ex);      Close();     }    }, null);   }   catch (Exception ex)   {    HandleException?.Invoke(ex);    Close();   }  }  #endregion  #region 外部介面  /// <summary>  /// 開始服務，串連服務端  /// </summary>  public void StartClient()  {   try   {    //執行個體化 通訊端 （ip4定址協議，串流，TCP協議）    _socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);    //建立 ip對象    IPAddress address = IPAddress.Parse(_ip);    //建立網路節點對象 包含 ip和port    IPEndPoint endpoint = new IPEndPoint(address, _port);    //將 監聽通訊端 綁定到 對應的IP和連接埠    _socket.BeginConnect(endpoint, asyncResult =>    {     try     {      _socket.EndConnect(asyncResult);      //開始接受伺服器訊息      StartRecMsg();      HandleClientStarted?.Invoke(this);     }     catch (Exception ex)     {      HandleException?.Invoke(ex);     }    }, null);   }   catch (Exception ex)   {    HandleException?.Invoke(ex);   }  }  /// <summary>  /// 發送資料  /// </summary>  /// <param name="bytes">資料位元組</param>  public void Send(byte[] bytes)  {   try   {    _socket.BeginSend(bytes, 0, bytes.Length, SocketFlags.None, asyncResult =>    {     try     {      int length = _socket.EndSend(asyncResult);      HandleSendMsg?.Invoke(bytes, this);     }     catch (Exception ex)     {      HandleException?.Invoke(ex);     }    }, null);   }   catch (Exception ex)   {    HandleException?.Invoke(ex);   }  }  /// <summary>  /// 發送字串（預設使用UTF-8編碼）  /// </summary>  /// <param name="msgStr">字串</param>  public void Send(string msgStr)  {   Send(Encoding.UTF8.GetBytes(msgStr));  }  /// <summary>  /// 發送字串（使用自訂編碼）  /// </summary>  /// <param name="msgStr">字串訊息</param>  /// <param name="encoding">使用的編碼</param>  public void Send(string msgStr, Encoding encoding)  {   Send(encoding.GetBytes(msgStr));  }  /// <summary>  /// 傳入自訂屬性  /// </summary>  public object Property { get; set; }  /// <summary>  /// 關閉與伺服器的串連  /// </summary>  public void Close()  {   try   {    _isRec = false;    _socket.Disconnect(false);    HandleClientClose?.Invoke(this);   }   catch (Exception ex)   {    HandleException?.Invoke(ex);   }  }  #endregion  #region 事件處理  /// <summary>  /// 用戶端串連建立後回調  /// </summary>  public Action<SocketClient> HandleClientStarted { get; set; }  /// <summary>  /// 處理接受訊息的委託  /// </summary>  public Action<byte[], SocketClient> HandleRecMsg { get; set; }  /// <summary>  /// 用戶端串連發送訊息後回調  /// </summary>  public Action<byte[], SocketClient> HandleSendMsg { get; set; }  /// <summary>  /// 用戶端串連關閉後回調  /// </summary>  public Action<SocketClient> HandleClientClose { get; set; }  /// <summary>  /// 例外處理常式  /// </summary>  public Action<Exception> HandleException { get; set; }  #endregion }}

上面放上的是架構代碼，接下來介紹下如何使用

首先，服務端使用方式：

using Coldairarrow.Util.Sockets;using System;using System.Text;namespace Console_Server{ class Program {  static void Main(string[] args)  {   //建立伺服器對象，預設監聽本機0.0.0.0，連接埠12345   SocketServer server = new SocketServer(12345);   //處理從用戶端收到的訊息   server.HandleRecMsg = new Action<byte[], SocketConnection, SocketServer>((bytes, client, theServer) =>   {    string msg = Encoding.UTF8.GetString(bytes);    Console.WriteLine($"收到訊息:{msg}");   });   //處理伺服器啟動後事件   server.HandleServerStarted = new Action<SocketServer>(theServer =>   {    Console.WriteLine("服務已啟動************");   });   //處理新的用戶端串連後的事件   server.HandleNewClientConnected = new Action<SocketServer, SocketConnection>((theServer, theCon) =>   {    Console.WriteLine($@"一個新的用戶端接入，當前串連數：{theServer.ClientList.Count}");   });   //處理用戶端串連關閉後的事件   server.HandleClientClose = new Action<SocketConnection, SocketServer>((theCon, theServer) =>   {    Console.WriteLine($@"一個用戶端關閉，當前串連數為：{theServer.ClientList.Count}");   });   //處理異常   server.HandleException = new Action<Exception>(ex =>   {    Console.WriteLine(ex.Message);   });   //伺服器啟動   server.StartServer();   while (true)   {    Console.WriteLine("輸入:quit，關閉伺服器");    string op = Console.ReadLine();    if (op == "quit")     break;   }  } }}

用戶端使用方式：

using Coldairarrow.Util.Sockets;using System;using System.Text;namespace Console_Client{ class Program {  static void Main(string[] args)  {   //建立用戶端對象，預設串連本機127.0.0.1,連接埠為12345   SocketClient client = new SocketClient(12345);   //綁定當收到伺服器發送的訊息後的處理事件   client.HandleRecMsg = new Action<byte[], SocketClient>((bytes, theClient) =>   {    string msg = Encoding.UTF8.GetString(bytes);    Console.WriteLine($"收到訊息:{msg}");   });   //綁定向伺服器發送訊息後的處理事件   client.HandleSendMsg = new Action<byte[], SocketClient>((bytes, theClient) =>   {    string msg = Encoding.UTF8.GetString(bytes);    Console.WriteLine($"向伺服器發送訊息:{msg}");   });   //開始運行用戶端   client.StartClient();   while (true)   {    Console.WriteLine("輸入:quit關閉用戶端，輸入其它訊息發送到伺服器");    string str = Console.ReadLine();    if (str == "quit")    {     client.Close();     break;    }    else    {     client.Send(str);    }   }  } }}

最後運行測試：

總結：

其最方便之處在於，將如何建立串連封裝掉，使用人員只需關注串連後發送什麼資料，接收到資料後應該如何處理，等等其它的很多事件的處理，這其中主要依託於匿名委託的使用，Lambda運算式的使用。