WebSocket in ASP.NET Core

一、WebSocket

　　WebSocket是HTML5出的東西（協議），也就是說HTTP協議沒有變化，或者說沒關系，但HTTP是不支持持久連接的（長連接，循環連接的不算）

首先HTTP有1.1和1.0之說，也就是所謂的keep-alive，把多個HTTP請求合並為一個，但是Websocket其實是一個新協議，跟HTTP協議基本沒有關系，只是為了兼容現有瀏覽器的握手規范而已，也就是說它是HTTP協議上的一種補充。WS和WSS協議類似於HTTP和HTTPS，允許使用安全和保密的通信方案。

二、ASP.NET Core中的WebSocket

　　要在ASP.NET Core中使用WebSocket，要先引用Microsoft.AspNetCore.WebSockets.Server的NuGet Package包。

　　下面我們創建一個名為WebSocketHandler.cs的類，內容如下：

　　通過對HttpContext中的WebSockets.AcceptWebSocketAsync方法，接受WebSocket請求；並在EchoLoop函數中進行請求的處理。

 public class SocketHandler
    {
        public const int BufferSize = 4096;

        WebSocket socket;

        SocketHandler(WebSocket socket)
        {
            this.socket = socket;
        }

        async Task EchoLoop()
        {
            var buffer = new byte[BufferSize];
            var seg = new ArraySegment<byte>(buffer);

            while (this.socket.State == WebSocketState.Open)
            {
                var incoming = await this.socket.ReceiveAsync(seg, CancellationToken.None);
                var outgoing = new ArraySegment<byte>(buffer, 0, incoming.Count);
                await this.socket.SendAsync(outgoing, WebSocketMessageType.Text, true, CancellationToken.None);
            }
        }

        static async Task Acceptor(HttpContext hc, Func<Task> n)
        {
            if (!hc.WebSockets.IsWebSocketRequest)
                return;

            var socket = await hc.WebSockets.AcceptWebSocketAsync();
            var h = new SocketHandler(socket);
            await h.EchoLoop();
        }

        /// <summary>
        /// branches the request pipeline for this SocketHandler usage
        /// </summary>
        /// <param name="app"></param>
        public static void Map(IApplicationBuilder app)
        {
            app.UseWebSockets();
            app.Use(SocketHandler.Acceptor);
        }
    }

　　這個類只處理了最簡單的客戶端發送信息並將原文返回客戶端。

　　接着就要做路由映射了：

  app.UseStaticFiles();
  app.Map("/ws", SocketHandler.Map);

　　要驗證並看到運行的結果，我們還要創建一個Html。並在Html頁面里面創建一個Div內容如下：

<div id="output"></div>

　　並且添加一個WebSocket的客戶端腳本：

 

<script language="javascript" type="text/javascript">
var socket;
var uri = "ws://" + window.location.host + "/ws";
var output;
var text = "test echo";

function write(s) {
    var p = document.createElement("p");
    p.innerHTML = s;
    output.appendChild(p);
}

function doConnect() {
    socket = new WebSocket(uri);
    socket.onopen = function (e) { write("opened " + uri); doSend(); };
    socket.onclose = function (e) { write("closed"); };
    socket.onmessage = function (e) { write("Received: " + e.data); socket.close(); };
    socket.onerror = function (e) { write("Error: " + e.data); };
}

function doSend() {
    write("Sending: " + text);
    socket.send(text);
}

function onInit() {
    output = document.getElementById("output");
    doConnect();
}

window.onload = onInit;

</script>

 

　　下面就可以看到運行結果了：

　

 

　　這個例子可以在如下Github中獲取到：https://github.com/zbrad/wsweb

　.NET Core 開源學習群： 214741894