如何使用SignalR实现服务端向客户端发消息及解决Clients空引用报错

核心错误原因 #

你遇到的Object reference not set to an instance of an object错误指向Clients对象为空，本质是Hub实例没有被SignalR运行时正确托管，Clients属性没有被自动注入。

排查步骤 #

• 检查SendData方法所属的类是否正确继承Hub基类，且你没有手动通过new关键字实例化这个Hub类调用SendData。Clients属性只有SignalR框架创建的Hub实例才会自动赋值，手动实例化的Hub类的Clients默认是空值。
• 修正服务端方法返回值，你当前使用的async void只适用于事件场景，会导致SignalR无法跟踪方法生命周期，提前释放Hub实例引发空引用，修改为async Task即可：

// 正确的Hub内方法写法
public class CustomHub : Hub
{
    public async Task SendData(string data)
    {
        await Clients.All.SendAsync("ReceiveMessage", data);
    }
}

• 如果你需要在Hub类外部（比如控制器、后台服务）调用发送消息的逻辑，必须通过依赖注入获取IHubContext对象操作，不能手动实例化Hub：

// 控制器示例
public class MsgController : ControllerBase
{
    private readonly IHubContext<CustomHub> _hubContext;
    // 构造函数注入IHubContext，由SignalR框架自动提供实例
    public MsgController(IHubContext<CustomHub> hubContext)
    {
        _hubContext = hubContext;
    }

    public async Task SendFromOutside(string data)
    {
        await _hubContext.Clients.All.SendAsync("ReceiveMessage", data);
    }
}

• 检查程序启动配置是否正确注册SignalR服务、映射Hub路由，以.NET 6+的Top-level Statement Program.cs为例：

// 注册SignalR服务
builder.Services.AddSignalR();

// ... 其他中间件配置

// 映射Hub路由，路径要和前端withUrl参数一致
app.MapHub<CustomHub>("/somemsg");

• 补充前端缺失的连接启动逻辑，你当前只写了消息监听代码，没有启动SignalR连接，添加启动逻辑：

"use strict";

var connection = new signalR.HubConnectionBuilder().withUrl("/somemsg").build();

connection.on("ReceiveMessage", function (message) {
    var li = document.createElement("li");
    document.getElementById("responeHistory").appendChild(li);
    li.textContent = `${message}`;
});

// 新增连接启动逻辑
connection.start().catch(err => console.error(err.toString()));

• 确认前端页面存在id为responeHistory的DOM元素，避免前端执行监听回调时报错。

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