使用C#來(lái)編寫一個(gè)異步的Socket服務(wù)器
介紹
我最近需要為一個(gè).net項(xiàng)目準(zhǔn)備一個(gè)內(nèi)部線程通信機(jī)制. 項(xiàng)目有多個(gè)使用ASP.NET,Windows 表單和控制臺(tái)應(yīng)用程序的服務(wù)器和客戶端構(gòu)成. 考慮到實(shí)現(xiàn)的可能性,我下定決心要使用原生的socket,而不是許多.NET中已經(jīng)提前為我們構(gòu)建好的組件, 像是所謂的管道, NetTcpClient 還有 Azure 服務(wù)總線.
這篇文章中的服務(wù)器基于System.Net.Sockets類異步方法. 這些允許你支持大量的socket客戶端, 而一個(gè)客戶端的連接是唯一的阻塞機(jī)制. 阻塞的時(shí)間是可以忽略不記得,所以服務(wù)器基本上是在當(dāng)做一個(gè)多線程socket服務(wù)器在運(yùn)作的.
背景
原生的socket在為你提供通信層面的完全控制權(quán)上具有優(yōu)勢(shì), 而在處理不同的數(shù)據(jù)類型是具有很大的靈活性. 你甚至可以通過(guò)socket發(fā)送序列化了的CLR對(duì)象,盡管我在這里不會(huì)那樣做. 這個(gè)項(xiàng)目將會(huì)想你展示如何在socket之間發(fā)送文本.
代碼的運(yùn)用
使用下面的代碼,你初始化了一個(gè)Server類,并運(yùn)行了Start()方法:
Server myServer = new Server(); myServer.Start();
如果你計(jì)劃在一個(gè)Windows表單中管理服務(wù)器的話,我建議使用一個(gè)BackgroundWorker, 因?yàn)閟ocket方法(一般會(huì)是ManualResentEvent) 將會(huì)阻塞GUI線程的運(yùn)行.
Server 類:
using System.Net.Sockets; public class Server { private static Socket listener; public static ManualResetEvent allDone = new ManualResetEvent(false); public const int _bufferSize = 1024; public const int _port = 50000; public static bool _isRunning = true; class StateObject { public Socket workSocket = null; public byte[] buffer = new byte[bufferSize]; public StringBuilder sb = new StringBuilder(); } // Returns the string between str1 and str2 static string Between(string str, string str1, string str2) { int i1 = 0, i2 = 0; string rtn = ""; i1 = str.IndexOf(str1, StringComparison.InvariantCultureIgnoreCase); if (i1 > -1) { i2 = str.IndexOf(str2, i1 + 1, StringComparison.InvariantCultureIgnoreCase); if (i2 > -1) { rtn = str.Substring(i1 + str1.Length, i2 - i1 - str1.Length); } } return rtn; } // Checks if the socket is connected static bool IsSocketConnected(Socket s) { return !((s.Poll(1000, SelectMode.SelectRead) && (s.Available == 0)) || !s.Connected); } // Insert all the other methods here. }
ManualResetEvent 是一個(gè)實(shí)現(xiàn)了你的socket服務(wù)器中事件的.NET類. 我們需要這個(gè)項(xiàng)目在我們想要發(fā)布阻塞操作的時(shí)候向代碼發(fā)送信號(hào). 你可以試驗(yàn)一下用bufferSize來(lái)適配你的需求. 如果能預(yù)期到消息的大小, 使用byte單位來(lái)設(shè)置消息的大小參數(shù)bufferSize. port是偵聽(tīng)TCP的端口參數(shù). 要意識(shí)到為其它應(yīng)用程序伺服所使用的接口. 如果你想要能夠方便地停止服務(wù)器,你需要實(shí)現(xiàn)一些機(jī)制來(lái)將_isRunning設(shè)置成false. 這一般可以借助于使用一個(gè) BackgroundWorker做到, 其中你可以使用myWorker.CancellationPending替換_isRunning. 我提到_isRunning的原因是給你在處理取消操作的問(wèn)題上提供一個(gè)方向, 并向你展示偵聽(tīng)器可以方便的停止的.
Between() 和IsSocketConnected() 是輔助方法.
現(xiàn)在轉(zhuǎn)過(guò)來(lái)看看方法. 首先是Start()方法:
public void Start() { IPHostEntry ipHostInfo = Dns.GetHostEntry(Dns.GetHostName()); IPEndPoint localEP = new IPEndPoint(IPAddress.Any, _port); listener = new Socket(localEP.Address.AddressFamily, SocketType.Stream, ProtocolType.Tcp); listener.Bind(localEP); while (_IsRunning) { allDone.Reset(); listener.Listen(10); listener.BeginAccept(new AsyncCallback(acceptCallback), listener); bool isRequest = allDone.WaitOne(new TimeSpan(12, 0, 0)); // Blocks for 12 hours if (!isRequest) { allDone.Set(); // Do some work here every 12 hours } } listener.Close(); }
這個(gè)方法初始化了偵聽(tīng)器socket, 并開(kāi)始等待用戶連接的到來(lái). 項(xiàng)目中主要的模式是使用異步委派. 異步委派是在調(diào)用者中的狀態(tài)改變時(shí)被異步調(diào)用的方法. isRequest 告訴你WaitOne 是否已經(jīng)因?yàn)橛锌蛻舳诉B接或者超時(shí)而退出.
如果你有大量的客戶端連接同時(shí)發(fā)生, 考慮提高Listen()方法的隊(duì)列參數(shù).
現(xiàn)在來(lái)看看下一個(gè)方法, acceptCallback . 這個(gè)方法由listener.BeginAccept異步調(diào)用. 當(dāng)方法完成執(zhí)行時(shí),偵聽(tīng)器會(huì)立即偵聽(tīng)新的客戶端.
static void acceptCallback(IAsyncResult ar) { // Get the listener that handles the client request. Socket listener = (Socket)ar.AsyncState; if (listener != null) { Socket handler = listener.EndAccept(ar); // Signal main thread to continue allDone.Set(); // Create state StateObject state = new StateObject(); state.workSocket = handler; handler.BeginReceive(state.buffer, 0, _bufferSize, 0, new AsyncCallback(readCallback), state); } }
acceptCallback 會(huì)派生出另外一個(gè)異步指派: readCallback. 這個(gè)方法會(huì)讀取來(lái)自socket的實(shí)際數(shù)據(jù). 我已經(jīng)為收發(fā)數(shù)據(jù)作了我自己的控制, 對(duì)于_bufferSize來(lái)說(shuō)是不變的. 所有發(fā)送到服務(wù)器的字符串都必須用<!--SOCKET--> 和 <!--ENDSOCKET-->包起來(lái). 同樣,客戶端在收到服務(wù)器的響應(yīng)式,必須解除響應(yīng)信息的包裹, 后者被<!--RESPONSE--> 和 <!--ENDRESPONSE-->包了起來(lái)。
static void readCallback(IAsyncResult ar) { StateObject state = (StateObject)ar.AsyncState; Socket handler = state.workSocket; if (!IsSocketConnected(handler)) { handler.Close(); return; } int read = handler.EndReceive(ar); // Data was read from the client socket. if (read > 0) { state.sb.Append(Encoding.UTF8.GetString(state.buffer, 0, read)); if (state.sb.ToString().Contains("<!--ENDSOCKET-->")) { string toSend = ""; string cmd = ts.Strings.Between(state.sb.ToString(), "<!--SOCKET-->", "<!--ENDSOCKET-->"); switch (cmd) { case "Hi!": toSend = "How are you?"; break; case "Milky Way?": toSend = "No I am not."; break; } toSend = "<!--RESPONSE-->" + toSend + "<!--ENDRESPONSE-->"; byte[] bytesToSend = Encoding.UTF8.GetBytes(toSend); handler.BeginSend(bytesToSend, 0, bytesToSend.Length, SocketFlags.None , new AsyncCallback(sendCallback), state); } else { handler.BeginReceive(state.buffer, 0, _bufferSize, 0 , new AsyncCallback(readCallback), state); } } else { handler.Close(); } }
readCallback 會(huì)派生另外一個(gè)方法, sendCallback, 它將會(huì)向客戶端發(fā)送請(qǐng)求. 如果客戶端沒(méi)有關(guān)閉連接, sendCallback 將會(huì)向socket發(fā)送信號(hào)以獲得更多的數(shù)據(jù).
static void sendCallback(IAsyncResult ar) { StateObject state = (StateObject)ar.AsyncState; Socket handler = state.workSocket; handler.EndSend(ar); StateObject newstate = new StateObject(); newstate.workSocket = handler; handler.BeginReceive(newstate.buffer, 0, StateObject.BufferSize, 0, new AsyncCallback(readCallback), newstate); }
我會(huì)將寫一個(gè)socket客戶端作為聯(lián)系留給讀者. socket客戶端應(yīng)該使用同異步調(diào)用同樣的編程模式. 我希望你能從這篇文章中收獲樂(lè)趣,并且會(huì)像一個(gè)socket程序員那樣付諸實(shí)踐!
要點(diǎn)
我在生產(chǎn)環(huán)境下使用了此代碼,其中的socket服務(wù)器是一個(gè)自由文本搜索引擎。 SQL Server缺乏對(duì)自由文本搜索支持(你可以使用自由文本索引,但它們是緩慢和昂貴的)。socket服務(wù)器負(fù)載了大量導(dǎo)向IEnumerables的文本數(shù)據(jù),并使用Linq來(lái)搜索文本。來(lái)自socket服務(wù)器的響應(yīng)從數(shù)百萬(wàn)行的Unicode文本數(shù)據(jù)中搜索時(shí)間在幾毫秒內(nèi)。我們還使用了三個(gè)分布式的Sphinx服務(wù)器(www.sphinxsearch.com)。socket服務(wù)器充當(dāng)了Sphinx服務(wù)器的高速緩存。如果你需要一個(gè)快速的自由文本搜索引擎,我強(qiáng)烈建議使用Sphinx。
- 詳解C#中通過(guò)委托來(lái)實(shí)現(xiàn)回調(diào)函數(shù)功能的方法
- C#基于委托實(shí)現(xiàn)多線程之間操作的方法
- C#用匿名方法定義委托的實(shí)現(xiàn)方法
- C#實(shí)現(xiàn)可捕獲幾乎所有鍵盤鼠標(biāo)事件的鉤子類完整實(shí)例
- C#中事件的定義和使用
- C#自定義事件監(jiān)聽(tīng)實(shí)現(xiàn)方法
- C#實(shí)現(xiàn)給DataGrid單元行添加雙擊事件的方法
- C#基于UDP進(jìn)行異步通信的方法
- C# 委托的三種調(diào)用示例(同步調(diào)用 異步調(diào)用 異步回調(diào))
- 淺談C#中的委托、事件與異步
相關(guān)文章
C#實(shí)現(xiàn)可緩存網(wǎng)頁(yè)到本地的反向代理工具實(shí)例
這篇文章主要介紹了C#實(shí)現(xiàn)可緩存網(wǎng)頁(yè)到本地的反向代理工具,實(shí)例分析了C#實(shí)現(xiàn)反向代理的相關(guān)技巧,非常具有實(shí)用價(jià)值,需要的朋友可以參考下2015-04-04C#數(shù)據(jù)類型實(shí)現(xiàn)背包、隊(duì)列和棧
本文詳細(xì)講解了C#數(shù)據(jù)結(jié)構(gòu)類型,并實(shí)現(xiàn)背包、隊(duì)列和棧的方法,文中通過(guò)示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-04-04c# SQLHelper(for winForm)實(shí)現(xiàn)代碼
數(shù)據(jù)連接池c# SQLHelper 實(shí)現(xiàn)代碼2009-02-02C#多線程學(xué)習(xí)之(三)生產(chǎn)者和消費(fèi)者用法分析
這篇文章主要介紹了C#多線程學(xué)習(xí)之生產(chǎn)者和消費(fèi)者用法,實(shí)例分析了C#中線程沖突的原理與資源分配的技巧,非常具有實(shí)用價(jià)值,需要的朋友可以參考下2015-04-04