用.NET實現WebSocket後端

阿新 • • 發佈：2020-08-17

以下內容都摘自其它網頁，作為學習的筆記，其中可能存在修改，具體可檢視來源頁。

WebSocket

概述

來源：https://www.runoob.com/html/html5-websocket.html

WebSocket 是 HTML5 開始提供的一種在單個 TCP 連線上進行全雙工通訊的協議。

WebSocket 使得客戶端和伺服器之間的資料交換變得更加簡單，允許服務端主動向客戶端推送資料。在 WebSocket API 中，瀏覽器和伺服器只需要完成一次握手，兩者之間就直接可以建立永續性的連線，並進行雙向資料傳輸。

在 WebSocket API 中，瀏覽器和伺服器只需要做一個握手的動作，然後，瀏覽器和伺服器之間就形成了一條快速通道。兩者之間就直接可以資料互相傳送。

現在，很多網站為了實現推送技術，所用的技術都是 Ajax 輪詢。輪詢是在特定的的時間間隔（如每1秒），由瀏覽器對伺服器發出HTTP請求，然後由伺服器返回最新的資料給客戶端的瀏覽器。這種傳統的模式帶來很明顯的缺點，即瀏覽器需要不斷的向伺服器發出請求，然而HTTP請求可能包含較長的頭部，其中真正有效的資料可能只是很小的一部分，顯然這樣會浪費很多的頻寬等資源。

HTML5 定義的 WebSocket 協議，能更好的節省伺服器資源和頻寬，並且能夠更實時地進行通訊。

客戶端部分

客戶端異常簡單，正常情況直接用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="~/Scripts/jquery-3.3.1.min.js"></script>
    <script>
        var ws;
        $().ready(function () {
            $('#conn').click(function () {
                ws = new WebSocket('ws://' + window.location.hostname + ':' + window.location.port + '/api/values/' + $("#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="to" type="text" />
        <input id="send" type="button" value="傳送" /><br />
        <div id="msg">
        </div>
    </div>
</body>
</html>

View Code

伺服器端部分

伺服器端使用WebAPI，原例子是用的Handler來做，主要用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.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web;
using System.Web.Http;
using System.Net.WebSockets;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Web.WebSockets;

namespace WebSocketService.Controllers
{
    public class ValuesController : ApiController
    {
        private static Dictionary<string, WebSocket> CONNECT_POOL = new Dictionary<string, WebSocket>();//使用者連線池
        private static Dictionary<string, List<MessageInfo>> MESSAGE_POOL = new Dictionary<string, List<MessageInfo>>();//離線訊息池
        //[Route]
        [HttpGet]
        public HttpResponseMessage Get(string user)
        {
            //在服務端接受web socket請求，傳入的函式作為web socket的處理函式，待web socket建立後該函式會被呼叫，
            //在該函式中可以對web socket進行訊息收發
            HttpContext.Current.AcceptWebSocketRequest(ProcessRequest);

            //構造同意切換至web socket的response
            return Request.CreateResponse(HttpStatusCode.SwitchingProtocols);
        }
        private async Task ProcessRequest(AspNetWebSocketContext context)
        {
            WebSocket socket = context.WebSocket;
            //HttpContextBase context2 = (HttpContextBase)Request.Properties["MS_HttpContext"];//獲取傳統context
            //HttpRequestBase request = context2.Request;//定義傳統request物件
            string user = context.RawUrl.Substring(context.RawUrl.LastIndexOf('/') + 1);// request.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
                            {
                                await 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);
            }
        }

        /// <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; }
        }
        // POST api/values
        public void Post([FromBody]string value)
        {
        }

        // PUT api/values/5
        public void Put(int id, [FromBody]string value)
        {
        }

        // DELETE api/values/5
        public void Delete(int id)
        {
        }
    }
}

View Code

PS:對Dictionary的操作可以寫兩個方案Add和Remove，並用lock，這樣子併發會穩定點

在本地測試過程中遇到的問題：

1、WebSocket請求提示握手失敗，這個是因為IIS沒有安裝WebSocket協議，在如下目錄安裝

來源：https://www.cnblogs.com/Tsong/p/6385585.html

用.NET實現WebSocket後端

WebSocket

用.NET實現WebSocket後端

用ldap作為django後端使用者登入驗證的實現

老司機帶你用php實現websocket

python實現WebSocket服務端過程解析

微信小程式開發搜尋功能實現(前端+後端+資料庫)

用Python開發app後端有優勢嗎

aop實現記錄後端使用者訪問

HTTPS請求HTTP介面被瀏覽器阻塞，python實現websocket客戶端，websocket伺服器，跨域問題，dwebsocket,https,攔截,服務端

C# 實現WebSocket服務端教程

用PHP實現的服務端socket具體例項

用Java實現一個查詢端口占用並且結束程序的小工具killPort

Netty(9)：實現WebSocket服務端

.net js 呼叫後端方法取div元素

【.Net Core】RSA演算法前端及後端加密實現

SpringBoot整合websocket實現後端向頁面傳送訊息

淺談.Net Core後端單元測試的實現

asp.net core配合vue實現後端驗證碼邏輯

Java後端WebSocket的Tomcat實現

基於servlet+filter+反射模擬實現天貓首頁的後端

寫給後端的Docker初級入門教程:實現高效率自動化部署

用.NET實現WebSocket後端

WebSocket

相關推薦