如何在SignalR服务端携带状态码与消息终止客户端连接？

一、使用HubFilter（推荐，优雅的全局拦截方式） #

SignalR 2.1及以上版本支持IHubFilter，可在连接生命周期插入统一验证逻辑，适合全局通用的连接规则校验。

1. 自定义连接验证过滤器 #

using Microsoft.AspNetCore.SignalR;
using Microsoft.AspNetCore.Http;

public class ConnectionValidationFilter : IHubFilter
{
    // 拦截Hub方法调用（此处无需处理，直接放行）
    public async ValueTask<object> InvokeMethodAsync(HubInvocationContext invocationContext, Func<HubInvocationContext, ValueTask<object>> next)
    {
        return await next(invocationContext);
    }

    // 拦截连接建立阶段，执行验证逻辑
    public async ValueTask OnConnectedAsync(HubLifetimeContext context, Func<HubLifetimeContext, ValueTask> next)
    {
        var httpContext = context.Context.GetHttpContext();
        if (httpContext == null)
        {
            httpContext.Response.StatusCode = StatusCodes.Status500InternalServerError;
            await httpContext.Response.WriteAsync("无法获取HTTP上下文");
            context.Context.Abort();
            return;
        }

        // 校验必需请求头
        if (!httpContext.Request.Headers.ContainsKey("X-Required-Header"))
        {
            httpContext.Response.StatusCode = StatusCodes.Status400BadRequest;
            await httpContext.Response.WriteAsync("缺少必需的请求头：X-Required-Header");
            context.Context.Abort();
            return;
        }

        // 验证通过，继续执行连接流程
        await next(context);
    }

    // 拦截断开连接阶段（此处无需处理，直接放行）
    public async ValueTask OnDisconnectedAsync(HubLifetimeContext context, Exception exception, Func<HubLifetimeContext, Exception, ValueTask> next)
    {
        await next(context, exception);
    }
}

2. 注册过滤器 #

在Program.cs中把过滤器添加到SignalR服务：

builder.Services.AddSignalR()
    .AddHubFilter<ConnectionValidationFilter>();

二、在单个Hub的OnConnectedAsync中直接校验 #

如果仅需针对特定Hub设置连接规则，可直接在Hub的OnConnectedAsync方法内处理：

using Microsoft.AspNetCore.SignalR;
using Microsoft.AspNetCore.Http;

public class ChatHub : Hub
{
    public override async Task OnConnectedAsync()
    {
        var httpContext = Context.GetHttpContext();
        if (httpContext == null)
        {
            Context.Abort();
            return;
        }

        // 验证请求头
        if (!httpContext.Request.Headers.ContainsKey("X-Required-Header"))
        {
            httpContext.Response.StatusCode = StatusCodes.Status401Unauthorized;
            await httpContext.Response.WriteAsync("未提供有效的连接凭证");
            Context.Abort();
            return;
        }

        // 验证通过，执行后续连接逻辑
        await base.OnConnectedAsync();
    }
}

三、状态码与消息的合理选择 #

根据验证场景匹配对应HTTP状态码：

• 400 Bad Request：请求格式错误，比如缺少必需请求头、参数无效等
• 401 Unauthorized：身份验证失败，比如未提供身份凭证、凭证无效
• 403 Forbidden：身份验证通过但无连接权限
• 500 Internal Server Error：服务端内部异常（仅用于无法获取HTTP上下文等极端场景）

关键注意事项 #

• 必须调用Context.Abort()主动断开连接，避免客户端维持无效连接
• 写入响应消息需在base.OnConnectedAsync()之前执行，确保响应能正常返回给客户端
• WebSocket连接的握手阶段会返回HTTP状态码，客户端可通过对应SDK捕获错误信息

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