.NET Core SignalR：实现服务器实时消息推送-51CTO.COM

在Web应用中，实时通信已经成为了一个重要的功能需求。ASP.NET Core SignalR是一个ASP.NET Core库，它简化了向连接的客户端添加实时Web功能的过程。通过SignalR，开发人员可以添加实时消息推送功能，以便服务器可以将消息实时推送给连接的客户端。

SignalR简介

SignalR是一个ASP.NET库，用于简化开发人员将实时Web功能添加到应用程序的过程。实时Web功能使服务器代码能够在内容可用时立即将内容推送到连接的客户端。

SignalR提供了用于连接管理（例如，连接和断开连接事件）、分组连接和用户身份验证的API。同时，它还提供了一个简单的、高级的API用于发送消息到所有连接的客户端或指定的客户端组。

配置SignalR

首先，你需要在项目中安装Microsoft.AspNetCore.SignalR NuGet包。

dotnet add package Microsoft.AspNetCore.SignalR1.

然后，在Startup.cs中配置SignalR：

public void ConfigureServices(IServiceCollection services)
{
    services.AddSignalR();
    // ...
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ...
    app.UseRouting();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapHub<MyHub>("/myhub");
        // ...
    });
    // ...
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.

创建Hub类

Hub是处理服务器和客户端之间通信的类。你可以通过继承Hub类来创建自定义的Hub。例如，下面是一个简单的Hub类：

using Microsoft.AspNetCore.SignalR;

public class MyHub : Hub
{
    public async Task SendMessage(string user, string message)
    {
        await Clients.All.SendAsync("ReceiveMessage", user, message);
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.

在这个例子中，MyHub类有一个SendMessage方法，该方法接收用户名和消息作为参数，并将消息广播给所有连接的客户端。Clients.All.SendAsync方法用于向所有连接的客户端发送消息。客户端通过监听名为ReceiveMessage的事件来接收这些消息。

客户端代码示例（JavaScript）

下面是一个使用JavaScript的SignalR客户端示例：

const connection = new signalR.HubConnectionBuilder()
    .withUrl("/myhub")
    .configureLogging(signalR.LogLevel.Information)
    .build();

connection.on("ReceiveMessage", function (user, message) {
    console.log(user + ": " + message);
});

connection.start().catch(function (err) {
    return console.error(err.toString());
});

function sendMessage() {
    var user = document.getElementById('userInput').value;
    var message = document.getElementById('messageInput').value;
    connection.invoke("SendMessage", user, message).catch(function (err) {
        return console.error(err.toString());
    });
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.

在这个示例中，我们首先创建了一个HubConnection对象，并指定了Hub的URL（/myhub）。然后，我们定义了一个名为ReceiveMessage的事件处理程序，该程序将在接收到服务器发送的消息时被调用。最后，我们通过调用connection.start()方法启动与服务器的连接。sendMessage函数用于向服务器发送消息。它通过调用connection.invoke方法并传入SendMessage方法和相应的参数来实现。

服务器端推送消息示例

在服务器端，你可以通过注入IHubContext<MyHub>来推送消息。例如：

public class MessageService
{
    private readonly IHubContext<MyHub> _hubContext;
    
    public MessageService(IHubContext<MyHub> hubContext)
    {
        _hubContext = hubContext;
    }
    
    public async Task SendMessage(string user, string message)
    {
        await _hubContext.Clients.All.SendAsync("ReceiveMessage", user, message);
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.

在这个示例中，MessageService类有一个SendMessage方法，该方法使用注入的IHubContext<MyHub>来向所有连接的客户端推送消息。你可以通过依赖注入将IHubContext<MyHub>注入到你的服务或控制器中，并在需要时调用SendMessage方法。这种方法允许你在服务器端主动推送消息给客户端，而无需客户端的请求。这对于实时更新、通知或广播等场景非常有用。例如，当某个用户执行了特定操作时，你可以使用这种方法将相关信息实时推送给其他用户或管理员。请注意，为了使用SignalR进行实时通信，你的服务器和客户端都需要能够处理WebSocket连接（这是SignalR默认使用的传输方式）。如果你的服务器或客户端位于防火墙或代理服务器后面，请确保已正确配置以允许WebSocket流量通过。