ASP.NET多层应用中SignalR跨项目Hub配置与调用咨询

我之前在做多层架构的ASP.NET项目时，也遇到过SignalR Hub不在Web项目的情况，折腾了一阵才理顺，给你一步步说清楚怎么弄：

首先得把依赖和路由配置好，这是核心前提：

• Hub所在的类库项目，安装NuGet包 Microsoft.AspNet.SignalR.Core
• 你的Web表示层项目，安装 Microsoft.AspNet.SignalR 和 Microsoft.AspNet.SignalR.JS
• Web项目里引用Hub所在的类库项目，确保SignalR能找到Hub类

然后在Web项目的Startup.cs（如果是老版本用Global.asax）里配置SignalR路由：

using Microsoft.Owin;
using Owin;

[assembly: OwinStartup(typeof(YourWebNamespace.Startup))]
namespace YourWebNamespace
{
    public class Startup
    {
        public void Configuration(IAppBuilder app)
        {
            // 自动发现所有引用项目中的Hub类
            app.MapSignalR();
        }
    }
}

注意：Hub类必须是public的，并且继承自Microsoft.AspNet.SignalR.Hub，如果想自定义Hub的前端调用名称，可以给Hub类加[HubName("chatHub")]属性，这样前端统一用这个名称更方便。

因为Hub不在当前Web项目，不能直接用微软示例里的$.connection.chatHub，得手动创建连接和代理：
先在页面引入SignalR的JS文件：

<!-- 先引入jQuery，SignalR依赖它 -->
<script src="~/Scripts/jquery-3.6.0.min.js"></script>
<script src="~/Scripts/jquery.signalR-2.4.2.min.js"></script>
<!-- 这个是SignalR自动生成的代理脚本，Web项目启动后会自动生成 -->
<script src="~/signalr/hubs"></script>

然后写连接逻辑：

// 创建基础连接
var connection = $.hubConnection();
// 创建Hub代理，这里的名称要和Hub类的HubName属性一致（或者类名，区分大小写）
var chatHubProxy = connection.createHubProxy('chatHub');

// 监听Hub推送过来的消息方法，和Hub里定义的客户端方法名称一致
chatHubProxy.on('receiveMessage', function(user, message) {
    // 这里处理收到的消息，比如渲染到页面聊天框
    $('#chatMessages').append(`<div>${user}: ${message}</div>`);
});

// 启动连接
connection.start()
    .done(function() {
        console.log('SignalR连接成功！');
        // 连接成功后可以调用Hub的服务器方法
        chatHubProxy.invoke('SendMessage', '当前登录用户', 'Hello 大家好！');
    })
    .fail(function(error) {
        console.error('SignalR连接失败：', error);
    });

业务层不能直接实例化Hub（Hub的生命周期由SignalR管理，每次请求会新建实例），得通过GlobalHost获取Hub上下文来调用：
首先业务层项目也要安装Microsoft.AspNet.SignalR.Core包，然后引用Hub所在的类库：

using Microsoft.AspNet.SignalR;
using YourHubProjectNamespace; // 替换成你的Hub项目命名空间

public class ChatBusinessService
{
    // 给所有在线用户发消息
    public void BroadcastMessage(string sender, string content)
    {
        // 获取Hub的上下文
        var hubContext = GlobalHost.ConnectionManager.GetHubContext<ChatHub>();
        // 调用客户端的receiveMessage方法
        hubContext.Clients.All.receiveMessage(sender, content);
    }

    // 给指定用户发消息，需要维护用户ID和连接ID的映射
    public void SendMessageToSpecificUser(string targetUserId, string sender, string content)
    {
        var hubContext = GlobalHost.ConnectionManager.GetHubContext<ChatHub>();
        // 这里假设你有一个全局的映射表，存储用户ID和对应的连接ID
        var targetConnectionId = UserConnectionMapping.GetConnectionId(targetUserId);
        if (!string.IsNullOrEmpty(targetConnectionId))
        {
            hubContext.Clients.Client(targetConnectionId).receiveMessage(sender, content);
        }
    }
}

关于用户和连接ID的映射，可以在Hub的生命周期方法里维护：

[HubName("chatHub")]
public class ChatHub : Hub
{
    public override Task OnConnected()
    {
        // 获取当前登录用户的ID（假设用ASP.NET身份验证）
        var userId = Context.User.Identity.Name;
        // 把用户ID和当前连接ID加入映射表
        UserConnectionMapping.Add(userId, Context.ConnectionId);
        return base.OnConnected();
    }

    public override Task OnDisconnected(bool stopCalled)
    {
        var userId = Context.User.Identity.Name;
        UserConnectionMapping.Remove(userId, Context.ConnectionId);
        return base.OnDisconnected(stopCalled);
    }
}

这里的UserConnectionMapping可以是一个静态类，用ConcurrentDictionary来存储（保证线程安全）：

public static class UserConnectionMapping
{
    private static readonly ConcurrentDictionary<string, HashSet<string>> _connections = new ConcurrentDictionary<string, HashSet<string>>();

    public static void Add(string userId, string connectionId)
    {
        _connections.AddOrUpdate(userId, 
            new HashSet<string> { connectionId }, 
            (key, existing) => { existing.Add(connectionId); return existing; });
    }

    public static void Remove(string userId, string connectionId)
    {
        if (_connections.TryGetValue(userId, out var connections))
        {
            connections.Remove(connectionId);
            if (connections.Count == 0)
            {
                _connections.TryRemove(userId, out _);
            }
        }
    }

    public static string GetConnectionId(string userId)
    {
        _connections.TryGetValue(userId, out var connections);
        return connections?.FirstOrDefault();
    }
}

• 确保Web项目已经正确引用Hub类库，否则SignalR启动时找不到Hub，会导致前端连接失败
• 前端的Hub代理名称要和Hub类的HubName属性完全一致（或者类名，注意大小写）
• 业务层调用Hub时，必须确保Web项目已经启动，GlobalHost已经初始化，否则会抛出空引用异常
• 如果是部署到IIS，要确保IIS的应用程序池模式是集成模式，经典模式可能会有路由问题

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