C# .NET中Socket簡(jiǎn)單實(shí)用框架的使用教程
更新時(shí)間：2017年09月12日 09:53:58 作者：寒空飛箭
最近一個(gè)項(xiàng)目因?yàn)橐玫絊ocket傳輸問題，所以決定學(xué)習(xí)一下，將自己學(xué)習(xí)的內(nèi)容總結(jié)分享出來，下面這篇文章主要給大家介紹了關(guān)于C# .NET中Socket簡(jiǎn)單實(shí)用框架使用的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，需要的朋友可以參考下。
前言
一說到Socket，想必大家都或多或少有所涉及，從最初的計(jì)算機(jī)網(wǎng)絡(luò)課程，講述了tcp協(xié)議，而Socket就是對(duì)協(xié)議的進(jìn)一步封裝，使我們開發(fā)人員能夠更加容易輕松的進(jìn)行軟件之間的通信。
這個(gè)星期剛好接受一個(gè)共享車位鎖的項(xiàng)目，需要使用Socket與硬件進(jìn)行通信控制，說白了也就是給鎖發(fā)送指令，控制其打開或者關(guān)閉，再就是對(duì)App開放操作接口，使其方便測(cè)試以及用戶的使用。這其中核心就是Socket的使用，再開發(fā)出這個(gè)功能之后，我發(fā)現(xiàn)使用起來很不方便，于是耗時(shí)2天抽象其核心功能并封裝成框架，最后使用這個(gè)框架將原來的項(xiàng)目重構(gòu)并上線，極大的提高了軟件的可拓展性，健壯性，容錯(cuò)率。
個(gè)人堅(jiān)信的原則：萬物皆對(duì)象
好了，不廢話了，下面進(jìn)入正文
正文：
1、首先簡(jiǎn)單講下C#中Socket的簡(jiǎn)單使用。
第一步：服務(wù)端監(jiān)聽某個(gè)端口
第二步：客戶端向服務(wù)端地址和端口發(fā)起Socket連接請(qǐng)求
第三步：服務(wù)端收到連接請(qǐng)求后創(chuàng)建Socket連接，并維護(hù)這個(gè)連接隊(duì)列。
第四步：客戶端和服務(wù)端已經(jīng)建立雙工通信（即雙向通信），客戶端和服務(wù)端可以輕松方便的給彼此發(fā)送信息。
至于簡(jiǎn)單使用的具體實(shí)現(xiàn)代碼全部被我封裝到項(xiàng)目中了，如果需要學(xué)習(xí)簡(jiǎn)單的實(shí)現(xiàn)，可以看我的源碼，也可以自行百度，有很多的教程
2、核心，框架的使用
其實(shí)，說其為框架，可能有點(diǎn)牽強(qiáng)，因?yàn)槊總€(gè)人對(duì)框架都有自己的理解，但是類庫(kù)和框架又有什么本質(zhì)區(qū)別呢？全部都是代碼~哈哈，扯遠(yuǎn)了
首先，空說無憑，先放上所有的代碼：
服務(wù)端源文件：
SocketServer.cs
using System;
using System.Collections.Generic;
using System.Net;
using System.Net.Sockets;
namespace Coldairarrow.Util.Sockets
{
/// <summary>
/// Socket服務(wù)端
/// </summary>
public class SocketServer
{
#region 構(gòu)造函數(shù)
/// <summary>
/// 構(gòu)造函數(shù)
/// </summary>
/// <param name="ip">監(jiān)聽的IP地址</param>
/// <param name="port">監(jiān)聽的端口</param>
public SocketServer(string ip, int port)
{
_ip = ip;
_port = port;
}
/// <summary>
/// 構(gòu)造函數(shù),監(jiān)聽I(yíng)P地址默認(rèn)為本機(jī)0.0.0.0
/// </summary>
/// <param name="port">監(jiān)聽的端口</param>
public SocketServer(int port)
{
_ip = "0.0.0.0";
_port = port;
}
#endregion
#region 內(nèi)部成員
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);
//馬上進(jìn)行下一輪監(jiān)聽,增加吞吐量
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>
/// 開始服務(wù)，監(jiān)聽客戶端
/// </summary>
public void StartServer()
{
try
{
//實(shí)例化套接字（ip4尋址協(xié)議，流式傳輸，TCP協(xié)議）
_socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
//創(chuàng)建ip對(duì)象
IPAddress address = IPAddress.Parse(_ip);
//創(chuàng)建網(wǎng)絡(luò)節(jié)點(diǎn)對(duì)象包含ip和port
IPEndPoint endpoint = new IPEndPoint(address, _port);
//將 監(jiān)聽套接字綁定到 對(duì)應(yīng)的IP和端口
_socket.Bind(endpoint);
//設(shè)置監(jiān)聽隊(duì)列長(zhǎng)度為Int32最大值(同時(shí)能夠處理連接請(qǐng)求數(shù)量)
_socket.Listen(int.MaxValue);
//開始監(jiān)聽客戶端
StartListen();
HandleServerStarted?.Invoke(this);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
}
/// <summary>
/// 所有連接的客戶端列表
/// </summary>
public LinkedList<SocketConnection> ClientList { get; set; } = new LinkedList<SocketConnection>();
/// <summary>
/// 關(guān)閉指定客戶端連接
/// </summary>
/// <param name="theClient">指定的客戶端連接</param>
public void CloseClient(SocketConnection theClient)
{
theClient.Close();
}
#endregion
#region 公共事件
/// <summary>
/// 異常處理程序
/// </summary>
public Action<Exception> HandleException { get; set; }
#endregion
#region 服務(wù)端事件
/// <summary>
/// 服務(wù)啟動(dòng)后執(zhí)行
/// </summary>
public Action<SocketServer> HandleServerStarted { get; set; }
/// <summary>
/// 當(dāng)新客戶端連接后執(zhí)行
/// </summary>
public Action<SocketServer, SocketConnection> HandleNewClientConnected { get; set; }
/// <summary>
/// 服務(wù)端關(guān)閉客戶端后執(zhí)行
/// </summary>
public Action<SocketServer, SocketConnection> HandleCloseClient { get; set; }
#endregion
#region 客戶端連接事件
/// <summary>
/// 客戶端連接接受新的消息后調(diào)用
/// </summary>
public Action<byte[], SocketConnection, SocketServer> HandleRecMsg { get; set; }
/// <summary>
/// 客戶端連接發(fā)送消息后回調(diào)
/// </summary>
public Action<byte[], SocketConnection, SocketServer> HandleSendMsg { get; set; }
/// <summary>
/// 客戶端連接關(guān)閉后回調(diào)
/// </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 構(gòu)造函數(shù)
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);
//馬上進(jìn)行下一輪接受，增加吞吐量
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>
/// 發(fā)送數(shù)據(jù)
/// </summary>
/// <param name="bytes">數(shù)據(jù)字節(jié)</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>
/// 發(fā)送字符串（默認(rèn)使用UTF-8編碼）
/// </summary>
/// <param name="msgStr">字符串</param>
public void Send(string msgStr)
{
Send(Encoding.UTF8.GetBytes(msgStr));
}
/// <summary>
/// 發(fā)送字符串（使用自定義編碼）
/// </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>
/// 關(guān)閉當(dāng)前連接
/// </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>
/// 客戶端連接接受新的消息后調(diào)用
/// </summary>
public Action<byte[], SocketConnection, SocketServer> HandleRecMsg { get; set; }
/// <summary>
/// 客戶端連接發(fā)送消息后回調(diào)
/// </summary>
public Action<byte[], SocketConnection, SocketServer> HandleSendMsg { get; set; }
/// <summary>
/// 客戶端連接關(guān)閉后回調(diào)
/// </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 構(gòu)造函數(shù)
/// <summary>
/// 構(gòu)造函數(shù),連接服務(wù)器IP地址默認(rèn)為本機(jī)127.0.0.1
/// </summary>
/// <param name="port">監(jiān)聽的端口</param>
public SocketClient(int port)
{
_ip = "127.0.0.1";
_port = port;
}
/// <summary>
/// 構(gòu)造函數(shù)
/// </summary>
/// <param name="ip">監(jiān)聽的IP地址</param>
/// <param name="port">監(jiān)聽的端口</param>
public SocketClient(string ip, int port)
{
_ip = ip;
_port = port;
}
#endregion
#region 內(nèi)部成員
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);
//馬上進(jìn)行下一輪接受，增加吞吐量
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>
/// 開始服務(wù)，連接服務(wù)端
/// </summary>
public void StartClient()
{
try
{
//實(shí)例化 套接字 （ip4尋址協(xié)議，流式傳輸，TCP協(xié)議）
_socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
//創(chuàng)建 ip對(duì)象
IPAddress address = IPAddress.Parse(_ip);
//創(chuàng)建網(wǎng)絡(luò)節(jié)點(diǎn)對(duì)象 包含 ip和port
IPEndPoint endpoint = new IPEndPoint(address, _port);
//將 監(jiān)聽套接字 綁定到 對(duì)應(yīng)的IP和端口
_socket.BeginConnect(endpoint, asyncResult =>
{
try
{
_socket.EndConnect(asyncResult);
//開始接受服務(wù)器消息
StartRecMsg();
HandleClientStarted?.Invoke(this);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
}, null);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
}
/// <summary>
/// 發(fā)送數(shù)據(jù)
/// </summary>
/// <param name="bytes">數(shù)據(jù)字節(jié)</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>
/// 發(fā)送字符串（默認(rèn)使用UTF-8編碼）
/// </summary>
/// <param name="msgStr">字符串</param>
public void Send(string msgStr)
{
Send(Encoding.UTF8.GetBytes(msgStr));
}
/// <summary>
/// 發(fā)送字符串（使用自定義編碼）
/// </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>
/// 關(guān)閉與服務(wù)器的連接
/// </summary>
public void Close()
{
try
{
_isRec = false;
_socket.Disconnect(false);
HandleClientClose?.Invoke(this);
}
catch (Exception ex)
{
HandleException?.Invoke(ex);
}
}
#endregion
#region 事件處理
/// <summary>
/// 客戶端連接建立后回調(diào)
/// </summary>
public Action<SocketClient> HandleClientStarted { get; set; }
/// <summary>
/// 處理接受消息的委托
/// </summary>
public Action<byte[], SocketClient> HandleRecMsg { get; set; }
/// <summary>
/// 客戶端連接發(fā)送消息后回調(diào)
/// </summary>
public Action<byte[], SocketClient> HandleSendMsg { get; set; }
/// <summary>
/// 客戶端連接關(guān)閉后回調(diào)
/// </summary>
public Action<SocketClient> HandleClientClose { get; set; }
/// <summary>
/// 異常處理程序
/// </summary>
public Action<Exception> HandleException { get; set; }
#endregion
}
}
上面放上的是框架代碼，接下來介紹下如何使用
首先，服務(wù)端使用方式：
using Coldairarrow.Util.Sockets;
using System;
using System.Text;
namespace Console_Server
{
class Program
{
static void Main(string[] args)
{
//創(chuàng)建服務(wù)器對(duì)象，默認(rèn)監(jiān)聽本機(jī)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}");
});
//處理服務(wù)器啟動(dòng)后事件
server.HandleServerStarted = new Action<SocketServer>(theServer =>
{
Console.WriteLine("服務(wù)已啟動(dòng)************");
});
//處理新的客戶端連接后的事件
server.HandleNewClientConnected = new Action<SocketServer, SocketConnection>((theServer, theCon) =>
{
Console.WriteLine($@"一個(gè)新的客戶端接入，當(dāng)前連接數(shù)：{theServer.ClientList.Count}");
});
//處理客戶端連接關(guān)閉后的事件
server.HandleClientClose = new Action<SocketConnection, SocketServer>((theCon, theServer) =>
{
Console.WriteLine($@"一個(gè)客戶端關(guān)閉，當(dāng)前連接數(shù)為：{theServer.ClientList.Count}");
});
//處理異常
server.HandleException = new Action<Exception>(ex =>
{
Console.WriteLine(ex.Message);
});
//服務(wù)器啟動(dòng)
server.StartServer();
while (true)
{
Console.WriteLine("輸入:quit，關(guān)閉服務(wù)器");
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)
{
//創(chuàng)建客戶端對(duì)象，默認(rèn)連接本機(jī)127.0.0.1,端口為12345
SocketClient client = new SocketClient(12345);
//綁定當(dāng)收到服務(wù)器發(fā)送的消息后的處理事件
client.HandleRecMsg = new Action<byte[], SocketClient>((bytes, theClient) =>
{
string msg = Encoding.UTF8.GetString(bytes);
Console.WriteLine($"收到消息:{msg}");
});
//綁定向服務(wù)器發(fā)送消息后的處理事件
client.HandleSendMsg = new Action<byte[], SocketClient>((bytes, theClient) =>
{
string msg = Encoding.UTF8.GetString(bytes);
Console.WriteLine($"向服務(wù)器發(fā)送消息:{msg}");
});
//開始運(yùn)行客戶端
client.StartClient();
while (true)
{
Console.WriteLine("輸入:quit關(guān)閉客戶端，輸入其它消息發(fā)送到服務(wù)器");
string str = Console.ReadLine();
if (str == "quit")
{
client.Close();
break;
}
else
{
client.Send(str);
}
}
}
}
}
最后運(yùn)行測(cè)試截圖：
總結(jié)：
其最方便之處在于，將如何創(chuàng)建連接封裝掉，使用人員只需關(guān)注連接后發(fā)送什么數(shù)據(jù)，接收到數(shù)據(jù)后應(yīng)該如何處理，等等其它的很多事件的處理，這其中主要依托于匿名委托的使用，Lambda表達(dá)式的使用。
框架里面主要使用了異步通訊，以及如何控制連接，詳細(xì)我就不多說了，大家應(yīng)該一看就懂，我只希望能給大家?guī)肀憷?/p>
好了，以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，如果有疑問大家可以留言交流，謝謝大家對(duì)腳本之家的支持。
最后，附上所有源碼項(xiàng)目地址，若覺得有一定價(jià)值，還請(qǐng)點(diǎn)贊~
GitHub地址：https://github.com/Coldairarrow/Sockets
本地下載：http://xiazai.jb51.net/201709/yuanma/Sockets(jb51.net).rar
您可能感興趣的文章:
相關(guān)文章
C#基于Extension Method(擴(kuò)展方法)獲得文件大小的方法
這篇文章主要介紹了C#基于Extension Method(擴(kuò)展方法)獲得文件大小的方法,實(shí)例分析了C#擴(kuò)展方法的定義與文件操作的相關(guān)技巧,需要的朋友可以參考下2015-06-06
C#數(shù)據(jù)結(jié)構(gòu)之循環(huán)鏈表的實(shí)例代碼
C#數(shù)據(jù)結(jié)構(gòu)之循環(huán)鏈表的實(shí)例代碼，需要的朋友可以參考一下2013-03-03
這篇文章主要介紹了C#使用timer定時(shí)在屏幕上輸出信息的方法,涉及C#中timer定時(shí)器的使用技巧,具有一定參考借鑒價(jià)值,需要的朋友可以參考下2015-03-03
WinForm 自動(dòng)完成控件實(shí)例代碼簡(jiǎn)析
在Web的應(yīng)用方面有js的插件實(shí)現(xiàn)自動(dòng)完成（或叫智能提示）功能，但在WinForm窗體應(yīng)用方面就沒那么好了,接下來參考一下這個(gè)實(shí)例，看看有沒有以外收獲，感興趣的朋友可以了解下啊，希望本文對(duì)你有幫助啊2013-01-01
這篇文章主要介紹了C#域名解析簡(jiǎn)單實(shí)現(xiàn)方法,可實(shí)現(xiàn)針對(duì)域名解析顯示出主機(jī)名、IP地址、別名等功能,需要的朋友可以參考下2015-07-07
文章介紹了命名空間在C#編程中的作用,包括命名空間的定義與使用、using關(guān)鍵字的使用以及嵌套命名空間的實(shí)現(xiàn),通過這些機(jī)制,開發(fā)者可以有效地組織和隔離代碼,避免命名沖突,提高代碼的可讀性和可維護(hù)性2024-12-12
C#記一次http協(xié)議multipart/form-data的boundary問題
這篇文章主要介紹了C#記一次http協(xié)議multipart/form-data的boundary問題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-06-06
算法證明每一位都相同十進(jìn)制數(shù)不是完全平方數(shù)
這篇文章主要為大家介紹了算法證明每一位都相同十進(jìn)制數(shù)不是完全平方數(shù)的過程論述，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-05-05
WPF自定義實(shí)現(xiàn)上傳文件顯示進(jìn)度的按鈕控件
自定義控件在WPF開發(fā)中是很常見的，有時(shí)候某些控件需要契合業(yè)務(wù)或者美化統(tǒng)一樣式，這時(shí)候就需要對(duì)控件做出一些改造，本文就來自定義實(shí)現(xiàn)一個(gè)上傳文件顯示進(jìn)度的按鈕控件吧2023-06-06
在許多應(yīng)用場(chǎng)景中,屏幕錄制是一項(xiàng)非常有用的功能,不管是用于教學(xué)、演示、故障排查還是游戲錄制,本文將詳細(xì)介紹如何使用?C#?實(shí)現(xiàn)屏幕錄制功能,幫助大家快速掌握這一實(shí)用技能,需要的朋友可以參考下2025-03-03