.NET 即時通訊,WebSocket服務端例項
即時通訊常用手段
1.第三方平臺 谷歌、騰訊 環信等多如牛毛,其中谷歌即時通訊是免費的,但免費就是免費的並不好用。其他的一些第三方一般收費的,使用要則限流(1s/限制x條訊息)要麼則限制使用者數。
但穩定性什麼都還不錯,又能將服務壓力甩出
2.System.Net.Sockets.Socket,也能寫一套較好的伺服器端。在.NET 4.5之前用較多,使用起來麻煩。需要對資料包進行解析等操作(但貌似網上有對超長包的處理方法)
3.System.Net.WebSockets.WebSocket,這個,是.NET 4.5出來的東西,對伺服器環境也有所要求,IIS8及以上。意味著Windows Server2008R2自帶的IIS不支援,Windows8及Server2012以上自帶的IIS可以。本文主要將這種方式的例項
完整流程
1).客戶端請求連線
ws = new WebSocket('ws://' + window.location.hostname + ':' + window.location.port + '/Handler1.ashx?user=' + $("#user").val());
2).服務端獲取連線物件並存儲到連線池中
CONNECT_POOL.Add(user, socket);
3).連線物件開始監聽(每個客戶端與伺服器儲存長連結)
WebSocketReceiveResult result = await socket.ReceiveAsync(buffer, CancellationToken.None);
4).客戶端A傳送訊息給B
ws.send($("#to").val() + "|" + $('#content').val());
5).服務端A的連線物件監聽到來自A的訊息
string userMsg = Encoding.UTF8.GetString(buffer.Array, 0, result.Count);
6).解析訊息體(B|你好我是A)得到接收者ID,根據接收者ID到連線池中查詢B的服務端連線物件,並通過B的連線物件將訊息推送給B客戶端
WebSocket destSocket = CONNECT_POOL[descUser];
...
...
await destSocket.SendAsync(buffer, WebSocketMessageType.Text, true, CancellationToken.None);
7).服務端A連線物件繼續監聽
WebSocketReceiveResult result = await socket.ReceiveAsync(buffer, CancellationToken.None);
8).B客戶端接收到推送過來的訊息
ws.onmessage = function (evt) {
$('#msg').append('<p>' + evt.data + '</p>');
}
下面則是完整程式碼
客戶端部分
客戶端異常簡單,正常情況直接用WebSocket,然後監聽WebSocket的幾個事件就ok。連線的時候可將當前連線者的ID傳入(使用者編號),傳送訊息的時候 採用 “接收者ID|我是訊息內容” 這種方式,如“A|A你好,我是B!”
但如用移動端使用還是有一些常見的場景需要處理下的
1:手機關螢幕,IOS關掉螢幕的時候WebSocket會立即失去連線,Android則會等待一段時間才會失去連線。伺服器端能檢測到失去連線
2:網路不穩定,斷網情況WebSocket也不會立即失去連線,伺服器端不能知道。(可以服務端設計心跳機制,定時給連線池中的使用者傳送訊息,來檢測使用者是否保持連線)
3:其他等等...(突然關機、後臺結束應用)
無論哪種,客戶端在傳送訊息(或者網路恢復連線、亮屏)的時候可以先判斷ws的狀態,如果不是連線狀態則需要重連(new下即可)
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0"/> <title></title> <script src="jquery-1.11.3.min.js"></script> <script> var ws; $().ready(function () { $('#conn').click(function () { ws = new WebSocket('ws://' + window.location.hostname + ':' + window.location.port + '/Handler1.ashx?user=' + $("#user").val()); $('#msg').append('<p>正在連線</p>'); ws.onopen = function () { $('#msg').append('<p>已經連線</p>'); } ws.onmessage = function (evt) { $('#msg').append('<p>' + evt.data + '</p>'); } ws.onerror = function (evt) { $('#msg').append('<p>' + JSON.stringify(evt) + '</p>'); } ws.onclose = function () { $('#msg').append('<p>已經關閉</p>'); } }); $('#close').click(function () { ws.close(); }); $('#send').click(function () { if (ws.readyState == WebSocket.OPEN) { ws.send($("#to").val() + "|" + $('#content').val()); } else { $('#tips').text('連線已經關閉'); } }); }); </script> </head> <body> <div> <input id="user" type="text" /> <input id="conn" type="button" value="連線" /> <input id="close" type="button" value="關閉"/><br /> <span id="tips"></span> <input id="content" type="text" /> <input id="send" type="button" value="傳送"/><br /> <input id="to" type="text" />目的使用者 <div id="msg"> </div> </div> </body> </html>
伺服器端部分
伺服器端使用Handler(也可用WebAPI)來做,主要用WebSocket的類來實現。程式碼中都有相對詳細的註釋,這邊只說一些需要注意的問題
1:Dictionary<string,WebSocket> CONNECT_POOL:使用者連線池。請求Handler的時候會將當前連線者的使用者ID傳入,伺服器端維護著所有已連線的使用者ID和當前使用者的WebSocket連線物件
2:Dictionary<string,List<MessageInfo>> MESSAGE_POOL:離線訊息池。如果A->B傳送訊息,B當前因為某種原因沒線上(突然斷網/黑屏等原因),會將這條訊息先儲存起來(2天),待B連線後立馬將B的離線訊息推送給他。(2:MessageInfo:離線Entity。記錄當前離線訊息的時間、內容)
using System; using System.Collections; using System.Collections.Generic; using System.Linq; using System.Net.WebSockets; using System.Text; using System.Threading; using System.Threading.Tasks; using System.Web; using System.Web.WebSockets; namespace WebApplication1 { /// <summary> /// 離線訊息 /// </summary> public class MessageInfo { public MessageInfo(DateTime _MsgTime, ArraySegment<byte> _MsgContent) { MsgTime = _MsgTime; MsgContent = _MsgContent; } public DateTime MsgTime { get; set; } public ArraySegment<byte> MsgContent { get; set; } } /// <summary> /// Handler1 的摘要說明 /// </summary> public class Handler1 : IHttpHandler { private static Dictionary<string, WebSocket> CONNECT_POOL = new Dictionary<string, WebSocket>();//使用者連線池 private static Dictionary<string, List<MessageInfo>> MESSAGE_POOL = new Dictionary<string, List<MessageInfo>>();//離線訊息池 public void ProcessRequest(HttpContext context) { if (context.IsWebSocketRequest) { context.AcceptWebSocketRequest(ProcessChat); } } private async Task ProcessChat(AspNetWebSocketContext context) { WebSocket socket = context.WebSocket; string user = context.QueryString["user"].ToString(); try { #region 使用者新增連線池 //第一次open時,新增到連線池中 if (!CONNECT_POOL.ContainsKey(user)) CONNECT_POOL.Add(user, socket);//不存在,新增 else if (socket != CONNECT_POOL[user])//當前物件不一致,更新 CONNECT_POOL[user] = socket; #endregion #region 離線訊息處理 if (MESSAGE_POOL.ContainsKey(user)) { List<MessageInfo> msgs = MESSAGE_POOL[user]; foreach (MessageInfo item in msgs) { await socket.SendAsync(item.MsgContent, WebSocketMessageType.Text, true, CancellationToken.None); } MESSAGE_POOL.Remove(user);//移除離線訊息 } #endregion string descUser = string.Empty;//目的使用者 while (true) { if (socket.State == WebSocketState.Open) { ArraySegment<byte> buffer = new ArraySegment<byte>(new byte[2048]); WebSocketReceiveResult result = await socket.ReceiveAsync(buffer, CancellationToken.None); #region 訊息處理(字元擷取、訊息轉發) try { #region 關閉Socket處理,刪除連線池 if (socket.State != WebSocketState.Open)//連線關閉 { if (CONNECT_POOL.ContainsKey(user)) CONNECT_POOL.Remove(user);//刪除連線池 break; } #endregion string userMsg = Encoding.UTF8.GetString(buffer.Array, 0, result.Count);//傳送過來的訊息 string[] msgList = userMsg.Split('|'); if (msgList.Length == 2) { if (msgList[0].Trim().Length > 0) descUser = msgList[0].Trim();//記錄訊息目的使用者 buffer = new ArraySegment<byte>(Encoding.UTF8.GetBytes(msgList[1])); } else buffer = new ArraySegment<byte>(Encoding.UTF8.GetBytes(userMsg)); if (CONNECT_POOL.ContainsKey(descUser))//判斷客戶端是否線上 { WebSocket destSocket = CONNECT_POOL[descUser];//目的客戶端 if (destSocket != null && destSocket.State == WebSocketState.Open) await destSocket.SendAsync(buffer, WebSocketMessageType.Text, true, CancellationToken.None); } else { Task.Run(() => { if (!MESSAGE_POOL.ContainsKey(descUser))//將使用者新增至離線訊息池中 MESSAGE_POOL.Add(descUser, new List<MessageInfo>()); MESSAGE_POOL[descUser].Add(new MessageInfo(DateTime.Now, buffer));//新增離線訊息 }); } } catch (Exception exs) { //訊息轉發異常處理,本次訊息忽略 繼續監聽接下來的訊息 } #endregion } else { break; } }//while end } catch (Exception ex) { //整體異常處理 if (CONNECT_POOL.ContainsKey(user)) CONNECT_POOL.Remove(user); } } public bool IsReusable { get { return false; } } } }
PS:對Dictionary的操作可以寫兩個方案Add和Remove,並用lock,這樣子併發會穩定點