C# .NET中Socket簡單實用框架的使用教程

分類：IT技術 時間:2017-09-25

前言

一說到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 "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"bytes">數據字節</param>
  public void Send(byte[] bytes)
  {
   try
   {
    _socket.BeginSend(bytes, 0, bytes.Length, SocketFlags.None, asyncResult =>
    {
     try
     {
      int length = _socket.EndSend(asyncResult);
      HandleSendMsg"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"jb51code">

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"bytes">數據字節</param>
  public void Send(byte[] bytes)
  {
   try
   {
    _socket.BeginSend(bytes, 0, bytes.Length, SocketFlags.None, asyncResult =>
    {
     try
     {
      int length = _socket.EndSend(asyncResult);
      HandleSendMsg"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"jb51code">

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表達式的使用。


框架裏面主要使用了異步通訊，以及如何控制連接，詳細我就不多說了，大家應該一看就懂，我只希望能給大家帶來便利。


好了，以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，如果有疑問大家可以留言交流，謝謝大家對電腦玩物的支持。


最後，附上所有源碼項目地址，若覺得有一定價值，還請點贊~


GitHub地址：https://github.com/Coldairarrow/Sockets


本地下載：http://xiazai.jb51.net/201709/yuanma/Sockets(jb51.net).rar
 

Tags:
使用 框架 Socket 簡單 服務 連接         

            文章來源：
ads
ads
相關文章
ads

相關文章

ad