過去由於 http 的特性,並沒有辦法做到即時通訊,簡單的解法就是 long polling。但這做法不僅影響頻寬,也影響執行效能,後來出現了 WebSocket 這樣的解決方案,才讓網頁有更加豐富的功能。

而且在現階段的 ASP.NET Core,也對 WebSocket 做了良好的支援。以下就 WebSocket 的使用做簡單介紹:

以下連結為本篇文章的範例位置: 註:前端頁面為微軟的官方範例

範例下載

首先在 Startup.cs 設定 WebSocket:

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    ......

    //websocket setup
    var webSocketOptions = new WebSocketOptions()
    {
        KeepAliveInterval = TimeSpan.FromSeconds(30),
        //ReceiveBufferSize = 4 * 1024
    };
    webSocketOptions.KeepAliveInterval = TimeSpan.FromMinutes(30);

    app.UseWebSockets(webSocketOptions);

    app.Use(async (context, next) =>
    {
        if (context.Request.Path == "/ws")
        {
            if (context.WebSockets.IsWebSocketRequest)
            {
                WebSocket webSocket = await context.WebSockets.AcceptWebSocketAsync();
                await Libs.WebSocket.WebSocketManager.ExecuteAPI(context, webSocket);
            }
            else
            {
                context.Response.StatusCode = 400;
            }
        }
        else
        {
            await next();
        }

    });
    //end
}

其中 Libs.WebSocket.WebSocketManager.ExecuteAPI 的程式碼如下:

public static async Task ExecuteAPI(HttpContext context, System.Net.WebSockets.WebSocket webSocket)
{
    var buffer = new byte[1024 * 20];
    WebSocketReceiveResult result = await webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), CancellationToken.None);
    while (!result.CloseStatus.HasValue)
    {
        string strRequest = Encoding.UTF8.GetString(buffer);
        string str = strRequest.Replace("\0", string.Empty);
        ......
        await webSocket.SendAsync(new ArraySegment<byte>(buffer, 0, jsonStr.Length), result.MessageType, result.EndOfMessage, CancellationToken.None);
        buffer = new byte[1024 * 20];
        result = await webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), CancellationToken.None);
    }
    await webSocket.CloseAsync(result.CloseStatus.Value, result.CloseStatusDescription, CancellationToken.None);
}

上述完整的程式碼可參考放在 GitHub 上的範例,這邊只列出收跟送封包的關鍵程式碼。

參考資料