如何在.NET Core版本的SignalR中传递和获取查询字符串参数

一、查询字符串的设置与获取 #

客户端（JS端）设置 #

.NET Core SignalR 不再支持旧版 $.connection.hub.qs 写法，需要在构建 Hub 连接时通过 withUrl 配置项传入查询参数：

const connection = new signalR.HubConnectionBuilder()
    // 替换为你自己的Hub路由地址
    .withUrl("/chatHub", {
        qs: { appId: 123, instanceId: 456 }
    })
    .build();

服务端获取 #

需要先通过 GetHttpContext() 扩展方法拿到Http上下文，再从请求 Query 集合中取值：

// 先引入命名空间
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.SignalR;

// Hub 内取值逻辑
if (Context.GetHttpContext()?.Request.Query.TryGetValue("appId", out var appIdStr) == true)
{
    int.TryParse(appIdStr, out var appId);
}

// 确认参数必传的场景可以用简化写法
int.TryParse(Context.GetHttpContext().Request.Query["appId"], out var appId);

二、Hub全局公共参数的最优传递方案 #

如果是当前Hub下所有方法都需要用到的公共参数，推荐用自定义Hub过滤器统一处理，避免每个方法重复写参数解析逻辑：

1. 首先实现自定义Hub过滤器，在方法执行前统一解析参数存入上下文Items字典

public class GlobalParamFilter : IHubFilter
{
    public async ValueTask<object> InvokeMethodAsync(HubInvocationContext invocationContext, Func<HubInvocationContext, ValueTask<object>> next)
    {
        var httpContext = invocationContext.Context.GetHttpContext();
        if (httpContext != null)
        {
            // 统一解析appId
            if (httpContext.Request.Query.TryGetValue("appId", out var appIdStr) 
                && int.TryParse(appIdStr, out var appId))
            {
                invocationContext.Context.Items["AppId"] = appId;
            }
            // 其他公共参数同理解析存入Items
        }
        return await next(invocationContext);
    }
}

2. 注册过滤器到SignalR配置中

builder.Services.AddSignalR(options =>
{
    options.AddFilter<GlobalParamFilter>();
});

3. Hub任意方法内直接取已解析好的参数

var appId = (int)Context.Items["AppId"];

如果参数和用户身份强相关，更推荐在连接认证阶段把参数写入Claims，后续直接通过Context.User.Claims读取，安全性更高。

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