WebSocket 通信

WebSocket是一种在单个TCP连接上进行全双工通信的协议，它提供了比传统HTTP请求/响应模型更低的延迟和更高的效率，非常适合实时数据流、聊天应用、在线游戏等场景。在C#中，无论是服务器端还是客户端，都可以使用WebSocket进行通信。
# 1、客户端使用 WebSocket
在C#中，你可以使用System.Net.WebSockets命名空间下的ClientWebSocket类来创建WebSocket客户端。下面是一个简单的示例，展示了如何连接到WebSocket服务器并发送和接收消息：
```java
using System;
using System.IO.Pipelines;
using System.Net.WebSockets;
using System.Text;
using System.Threading;
using System.Threading.Tasks;

/// <summary>
/// WebSocket客户端类，用于与WebSocket服务器建立连接和通信。
/// </summary>
public class WebSocketClient
{
    /// <summary>
    /// 客户端WebSocket实例。
    /// </summary>
    private readonly ClientWebSocket _webSocket = new ClientWebSocket();

/// <summary>
    /// 用于取消操作的CancellationTokenSource。
    /// </summary>
    private readonly CancellationTokenSource _cancellationTokenSource = new CancellationTokenSource();

/// <summary>
    /// 连接到指定的WebSocket服务器。
    /// </summary>
    /// <param name="uri">WebSocket服务器的URI。</param>
    public async Task Connect(string uri)
    {
        // 使用提供的URI连接到WebSocket服务器
        await _webSocket.ConnectAsync(new Uri(uri), _cancellationTokenSource.Token);
    }

/// <summary>
    /// 向WebSocket服务器发送消息。
    /// </summary>
    /// <param name="message">要发送的消息字符串。</param>
    public async Task SendMessage(string message)
    {
        // 将消息转换为UTF8编码的字节
        byte[] buffer = Encoding.UTF8.GetBytes(message);

// 创建ArraySegment，封装要发送的字节缓冲区
        ArraySegment<byte> segment = new ArraySegment<byte>(buffer);

// 发送消息到WebSocket服务器
        await _webSocket.SendAsync(segment, WebSocketMessageType.Text, true, _cancellationTokenSource.Token);
    }

/// <summary>
    /// 接收WebSocket服务器发送的消息。
    /// </summary>
    /// <param name="onMessageReceived">接收到消息时调用的回调函数。</param>
    public async Task ReceiveMessage(Action<string> onMessageReceived)
    {
        // 当WebSocket连接处于打开状态时，持续接收消息
        while (_webSocket.State == WebSocketState.Open)
        {
            var buffer = new byte[1024];

// 接收来自WebSocket服务器的数据
            var result = await _webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), _cancellationTokenSource.Token);

// 如果接收到的类型为关闭，则关闭连接
            if (result.MessageType == WebSocketMessageType.Close)
            {
                await _webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, "Closing", CancellationToken.None);
                break;
            }

// 将接收到的字节转换为字符串，并通过回调函数处理
            var receivedMessage = Encoding.UTF8.GetString(buffer, 0, result.Count);
            onMessageReceived(receivedMessage);
        }
    }

/// <summary>
    /// 断开与WebSocket服务器的连接。
    /// </summary>
    public async Task Disconnect()
    {
        // 取消接收和发送操作
        _cancellationTokenSource.Cancel();

// 关闭WebSocket连接
        await _webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, "Closing", CancellationToken.None);
    }
}
```
# 2、服务器端使用 WebSocket
在服务器端，可以使用ASP.NET Core中的Microsoft.AspNetCore.WebSockets来支持WebSocket。

- Microsoft.AspNetCore.WebSockets

```java
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;
using System;
using System.Threading.Tasks;

public class Startup
{
    /// <summary>
    /// 配置服务容器。
    /// </summary>
    /// <param name="services">服务集合。</param>
    public void ConfigureServices(IServiceCollection services)
    {
        // 添加控制器服务
        services.AddControllers();
    }

/// <summary>
    /// 配置应用管道。
    /// </summary>
    /// <param name="app">应用构建器。</param>
    /// <param name="env">主机环境。</param>
    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        // 在开发环境中启用异常页面
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

// 启用路由
        app.UseRouting();

// 启用WebSocket中间件
        app.UseWebSockets();

// 配置端点处理器
        app.UseEndpoints(endpoints =>
        {
            // 映射默认的GET请求处理器
            endpoints.MapGet("/", async context =>
            {
                await context.Response.WriteAsync("Hello World!");
            });

// 映射WebSocket请求处理器
            endpoints.Map("/ws", async context =>
            {
                // 检查当前请求是否为WebSocket请求
                if (context.WebSockets.IsWebSocketRequest)
                {
                    // 接受WebSocket连接
                    using var webSocket = await context.WebSockets.AcceptWebSocketAsync();

// 持续监听WebSocket消息
                    while (true)
                    {
                        // 准备接收缓冲区
                        var buffer = new byte[1024 * 4];

// 接收WebSocket消息
                        var result = await webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), CancellationToken.None);

// 如果收到的类型为关闭消息，则关闭连接
                        if (result.MessageType == WebSocketMessageType.Close)
                        {
                            await webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, "Closing", CancellationToken.None);
                            break;
                        }

// 解码接收到的消息
                        var message = Encoding.UTF8.GetString(buffer, 0, result.Count);
                        Console.WriteLine($"Received: {message}");

// 回复消息给客户端
                        await webSocket.SendAsync(
                            new ArraySegment<byte>(Encoding.UTF8.GetBytes($"Echo: {message}")),
                            result.MessageType,
                            result.EndOfMessage,
                            CancellationToken.None);
                    }
                }
                else
                {
                    // 如果不是WebSocket请求，则返回400错误
                    context.Response.StatusCode = 400;
                }
            });
        });
    }
}
```

在上面的服务器端代码中，首先启用了WebSocket中间件，然后映射了一个/ws端点来处理WebSocket连接。

当收到连接请求时，我们接受连接并进入循环，监听客户端发送的消息，然后简单地回传一个回显消息。

3、说明
WebSocket为C#开发者提供了强大的实时通信能力，无论是构建复杂的实时数据流应用还是简单的聊天室，WebSocket都是一个值得考虑的选择。通过掌握客户端和服务器端的实现细节，可以充分利用WebSocket的优势，创建高性能和低延迟的实时应用。