C#在.NET Core中的WebSocket支持與應(yīng)用

在.NET Core中，WebSocket是一種常用的通信協(xié)議，它提供了一個(gè)全雙工的通信通道，使得客戶端和服務(wù)器之間可以實(shí)時(shí)地發(fā)送和接收數(shù)據(jù)

1. 安裝Microsoft.AspNetCore.WebSockets包：

在項(xiàng)目中使用WebSocket，首先需要安裝Microsoft.AspNetCore.WebSockets包?？梢酝ㄟ^(guò)NuGet包管理器或者在項(xiàng)目文件夾下的.csproj文件中添加以下代碼來(lái)安裝：

<ItemGroup>
   <PackageReference Include="Microsoft.AspNetCore.WebSockets" Version="5.0.10" />
</ItemGroup>

2. 配置WebSocket中間件：

在Startup類的Configure方法中，添加WebSocket中間件。這將允許應(yīng)用程序處理WebSocket請(qǐng)求。

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ...
    app.UseWebSockets();
    // ...
}

3. 創(chuàng)建WebSocket處理器：

創(chuàng)建一個(gè)新的類，用于處理WebSocket連接。這個(gè)類需要繼承自Microsoft.AspNetCore.Http.Connections.ConnectionHandler類，并重寫OnConnectedAsync、OnDisconnectedAsync和OnReceiveAsync方法。

using Microsoft.AspNetCore.Http.Connections;
using System.Threading.Tasks;

public class MyWebSocketHandler : ConnectionHandler
{
    public override Task OnConnectedAsync(ConnectionContext connection)
    {
        // 處理連接建立時(shí)的邏輯
        return base.OnConnectedAsync(connection);
    }

    public override Task OnDisconnectedAsync(ConnectionContext connection)
    {
        // 處理連接斷開(kāi)時(shí)的邏輯
        return base.OnDisconnectedAsync(connection);
    }

    public override Task OnReceiveAsync(ConnectionContext connection, byte[] data)
    {
        // 處理接收到的數(shù)據(jù)
        return base.OnReceiveAsync(connection, data);
    }
}

4. 注冊(cè)WebSocket處理器：

在Startup類的Configure方法中，添加一個(gè)路由，將WebSocket請(qǐng)求映射到剛剛創(chuàng)建的處理器。

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ...
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapConnectionHandler<MyWebSocketHandler>("/ws");
    });
    // ...
}

5. 客戶端連接：

客戶端可以使用標(biāo)準(zhǔn)的WebSocket API連接到服務(wù)器。以下是一個(gè)JavaScript示例：

const socket = new WebSocket('ws://localhost:5000/ws');

socket.onopen = (event) => {
    console.log('WebSocket連接已打開(kāi)', event);
};

socket.onmessage = (event) => {
    console.log('WebSocket收到消息', event.data);
};

socket.onclose = (event) => {
    console.log('WebSocket連接已關(guān)閉', event);
};

socket.onerror = (event) => {
    console.error('WebSocket錯(cuò)誤', event);
};

現(xiàn)在，當(dāng)客戶端連接到服務(wù)器時(shí)，服務(wù)器會(huì)接收到WebSocket連接請(qǐng)求，并觸發(fā)MyWebSocketHandler中的OnConnectedAsync方法。客戶端可以通過(guò)WebSocket API發(fā)送和接收數(shù)據(jù)，服務(wù)器端可以在MyWebSocketHandler的OnReceiveAsync方法中處理接收到的數(shù)據(jù)。當(dāng)連接關(guān)閉時(shí)，服務(wù)器會(huì)觸發(fā)OnDisconnectedAsync方法。