.NET Core WebSocket示例中Echo方法设为static的原因及修改可行性

为什么Echo方法被设为static？ #

• 官方示例里的Echo方法只依赖传入的WebSocket对象，不需要访问控制器的任何实例成员（比如注入的服务、HttpContext属性），用static可以避免不必要的控制器实例创建开销，同时从语义上明确这个方法不依赖任何实例状态，是个纯逻辑方法。
• 这种设计在无状态的基础场景下更简洁，符合单一职责——只处理WebSocket的消息回显逻辑，和控制器实例的其他状态完全隔离。

改成实例方法是否可行？ #

完全可行，这是实际开发中很常见的改造操作：

• 如果你的业务逻辑需要用到注入到控制器的服务（比如日志组件、数据库操作服务），只需要把Echo方法的static修饰符去掉，改成实例方法即可，这样就能在方法内部直接调用控制器里的注入服务了。
• 改造后的方法示例：

private async Task Echo(WebSocket webSocket)
{
    // 这里可以直接调用注入的服务，比如 _logger.LogInformation("WebSocket消息处理中");
    var buffer = new byte[1024 * 4];
    var receiveResult = await webSocket.ReceiveAsync(
        new ArraySegment<byte>(buffer), CancellationToken.None);

    while (!receiveResult.CloseStatus.HasValue)
    {
        await webSocket.SendAsync(
            new ArraySegment<byte>(buffer, 0, receiveResult.Count),
            receiveResult.MessageType,
            receiveResult.EndOfMessage,
            CancellationToken.None);

        receiveResult = await webSocket.ReceiveAsync(
            new ArraySegment<byte>(buffer), CancellationToken.None);
    }

    await webSocket.CloseAsync(
        receiveResult.CloseStatus.Value,
        receiveResult.CloseStatusDescription,
        CancellationToken.None);
}

• 调用逻辑不需要修改，控制器的Get方法原本的await Echo(webSocket)可以直接正常工作，因为实例方法在控制器内部调用时会自动绑定当前实例。

原代码参考 #

public class WebSocketController : ControllerBase
{
    [Route("/ws")]
    public async Task Get()
    {
        if (HttpContext.WebSockets.IsWebSocketRequest)
        {
            using var webSocket = await HttpContext.WebSockets.AcceptWebSocketAsync();
            await Echo(webSocket);
        }
        else
        {
            HttpContext.Response.StatusCode = StatusCodes.Status400BadRequest;
        }
    }

    private static async Task Echo(WebSocket webSocket)
    {
        var buffer = new byte[1024 * 4];
        var receiveResult = await webSocket.ReceiveAsync(
            new ArraySegment<byte>(buffer), CancellationToken.None);

        while (!receiveResult.CloseStatus.HasValue)
        {
            await webSocket.SendAsync(
                new ArraySegment<byte>(buffer, 0, receiveResult.Count),
                receiveResult.MessageType,
                receiveResult.EndOfMessage,
                CancellationToken.None);

            receiveResult = await webSocket.ReceiveAsync(
                new ArraySegment<byte>(buffer), CancellationToken.None);
        }

        await webSocket.CloseAsync(
            receiveResult.CloseStatus.Value,
            receiveResult.CloseStatusDescription,
            CancellationToken.None);
    }
}

内容的提问来源于stack exchange，提问作者Dimt