在Asp.net core项目中使用WebSocket

在ASP.NET Core项目中使用Websocket是一项非常重要的技能，可以让我们实现实时交互和通讯、推送等功能。下面是在ASP.NET Core项目中使用Websocket的完整攻略：

步骤一：安装Microsoft.AspNetCore.WebSockets NuGet包

WebSocket 是一个独立的协议，所以我们需要安装一个 NuGet 包来帮助处理 WebSockets 的连接和处理。Microsoft.AspNetCore.WebSockets是官方提供的WebSocket处理中间件，使用前必须安装。你可以在NuGet包管理器中安装，也可以使用dotnet cli 使用以下命令进行安装：

$ dotnet add package Microsoft.AspNetCore.WebSockets

步骤二：设置 WebSocket 中间件

在 ASP.NET Core 中，WebSocket 中间件可以很方便地添加到处理管道中。你可以在 Startup.cs 文件中进行设置，在 Configure 方法中添加以下代码：

app.UseWebSockets();

这个中间件可以在管道中插入 WebSocket 核心行为，并协调处理 WebSocket 连接。

步骤三：创建 WebSocket 处理程序

可以使用 Microsoft.AspNetCore.WebSockets 包提供的 WebSocketMiddleware，同时定义一个 WebSocket 处理程序来处理所有传入的 WebSocket 连接。可以创建一个名为 WebSocketHandler 的类来实现这一方法。

public class WebSocketHandler
{
    private readonly WebSocket _webSocket;
    private readonly ILogger<WebSocketHandler> _logger;
    private readonly CancellationToken _cancellationToken;

    public WebSocketHandler(WebSocket webSocket, ILogger<WebSocketHandler> logger, CancellationToken cancellationToken)
    {
        _webSocket = webSocket;
        _logger = logger;
        _cancellationToken = cancellationToken;
    }

    public async Task ProcessWebSocketRequestAsync()
    {
        while (!_cancellationToken.IsCancellationRequested && _webSocket.State == WebSocketState.Open)
        {
            var buffer = new ArraySegment<byte>(new byte[4096]);
            var result = await _webSocket.ReceiveAsync(buffer, _cancellationToken);
            var data = Encoding.UTF8.GetString(buffer.Array, buffer.Offset, result.Count);

            // Process received data here

            //Example sending message back to the client
            var responseBytes = Encoding.UTF8.GetBytes("Received message: " + data);
            var responseBuffer = new ArraySegment<byte>(responseBytes);
            await _webSocket.SendAsync(responseBuffer, WebSocketMessageType.Text, true, _cancellationToken);
        }

        await _webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, "", _cancellationToken);
    }
}

上面的代码展示了如何使用 WebSocket 处理程序来接收和处理所有传入的 WebSocket 连接。你可以在这个类的构造函数中注入 WebSocket 对象、ILogger 对象和 CancellationToken 对象，以方便进行 WebSocket 连接的处理和跟踪。

步骤四：实现WebSocket连接Action

现在我将使用一个简单的控制器来演示如何将 WebSocket 处理程序与 MVC 控制器集成。在控制器中实现一个Action，允许客户端连接到我们的 WebSocket 并处理它们的消息。

[Route("api/ws")]
public class WebSocketController : Controller
{
    private readonly ILogger<WebSocketController> _logger;

    public WebSocketController(ILogger<WebSocketController> logger)
    {
        _logger = logger;
    }

    [HttpGet]
    public async Task Get()
    {
        if (HttpContext.WebSockets.IsWebSocketRequest)
        {
            using (var webSocket = await HttpContext.WebSockets.AcceptWebSocketAsync())
            {
                _logger.LogInformation("WebSocket connection established");

                var handler = new WebSocketHandler(webSocket, _logger, HttpContext.RequestAborted);
                await handler.ProcessWebSocketRequestAsync();
            }
        }
        else
        {
            HttpContext.Response.StatusCode = 400;
        }
    }
}

上面的代码定义了 WebSocket 控制器类，创建 GET 操作来处理 WebSocket 连接请求。如果客户端连接到指定的URL并发送 WebSocket 握手请求，IsWebSocketRequest 属性将返回 true。当这种情况发生时，我们可以调用 AcceptWebSocketAsync() 方法，它将返回一个 WebSocket 对象，允许我们在客户端和服务器之间进行实时通信。

在设置好 WebSocketHandler 后，我们可以将WebSocket对象传递到 WebSocketHandler 的构造函数中，并调用 ProcessWebSocketRequestAsync() 方法. 该方法将执行Websocket连接的消费并处理所有传入的消息，并异步发送响应。

示例一：简单的广播消息

public static class WebSocketCollection
{
    private static readonly ConcurrentDictionary<string, WebSocket> _sockets = new ConcurrentDictionary<string, WebSocket>();

    public static void AddSocket(WebSocket webSocket)
    {
        var id = Guid.NewGuid().ToString();
        _sockets.TryAdd(id, webSocket);
    }

    public static async Task RemoveSocketAsync(string id)
    {
        WebSocket socket;
        _sockets.TryRemove(id, out socket);
        await socket.CloseAsync(WebSocketCloseStatus.NormalClosure, "Connection terminated", CancellationToken.None);
    }

    public static async Task BroadcastMessageAsync(string message)
    {
        var buffer = new ArraySegment<byte>(Encoding.UTF8.GetBytes(message));

        foreach (var pair in _sockets)
        {
            if (pair.Value.State == WebSocketState.Open)
            {
                await pair.Value.SendAsync(buffer, WebSocketMessageType.Text, true, CancellationToken.None);
            }
        }
    }
}

WebSocketCollection 类是一个帮助类，用于管理所有打开的 WebSocket 连接，它包含了对 WebSockets 集合的操作，包括添加、删除 WebSocket 连接和广播消息到 WebSocket 连接。在定义好WebSocketHandler后，将WS对象通过AddSocket方法添加到WebSocketCollection中。

发送消息只需要调用WebSocketCollection的BroadcastMessageAsync方法。

示例二：单独响应请求

public async Task ProcessWebSocketRequestAsync()
{
    while (!_cancellationToken.IsCancellationRequested && _webSocket.State == WebSocketState.Open)
    {
        var buffer = new ArraySegment<byte>(new byte[4096]);
        var result = await _webSocket.ReceiveAsync(buffer, _cancellationToken);

        switch (result.MessageType)
        {
            case WebSocketMessageType.Text:
                var data = Encoding.UTF8.GetString(buffer.Array, buffer.Offset, result.Count);
                if (data == "Get Server Time")
                {
                    var responseBytes = Encoding.UTF8.GetBytes(DateTime.Now.ToString());
                    var responseBuffer = new ArraySegment<byte>(responseBytes);
                    await _webSocket.SendAsync(responseBuffer, WebSocketMessageType.Text, true, _cancellationToken);
                }
                break;
        }
    }
    await _webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, "", _cancellationToken);
}

在此示例中，我们创建了一个简单的 Socket 消息流，允许客户端发送“Get Server Time”消息。如果客户端发送了这个消息，我们就将当前服务器时间转换为文本形式并发送回客户端。

这两个示例都演示了如何在 ASP.NET Core 项目中使用 WebSocket 处理程序来处理 WebSocket 连接。当客户端连接到我们的 WebSocket 时，我们可以使用 WebSocket 处理程序来接收和处理所有传入的消息，并异步发送响应。

以上就是实现 WebSocket 的完整攻略，其中包含了设置 WebSocket 中间件、创建 WebSocket 处理程序、实现 WebSocket 连接的 Action，两个示例的说明等内容。希望对你有帮助。