.NET Core 使用 SignalR 实现实时通讯

拾忆4377

于 2024-08-17 09:00:00 发布

阅读量727

点赞数 14

文章标签： .netcore

本文链接：https://blog.csdn.net/qq_40998698/article/details/141264377

版权

在现代的应用程序中，实时通讯已经变得越来越重要。无论是聊天应用、在线游戏还是实时数据监控，实时通讯都能显著提升用户体验。在 .NET Core 中，SignalR 是实现实时通讯的强大工具。本文将介绍如何在 .NET Core 中使用 SignalR 实现实时通讯，并提供一个简单的示例。

1. 什么是 SignalR？

SignalR 是一个 ASP.NET Core 库，用于在客户端和服务器之间实现实时通讯。它简化了 WebSocket 的使用，并提供了多种传输方式，如 WebSocket、服务器发送事件（Server-Sent Events，SSE）和长轮询。SignalR 允许服务器推送消息到客户端，适用于需要即时更新的应用程序。

2. 安装 SignalR

在 .NET Core 项目中使用 SignalR，首先需要安装 SignalR 包。可以通过 NuGet 包管理器来完成这个过程。打开你的项目，执行以下命令来安装 SignalR：

dotnet add package Microsoft.AspNetCore.SignalR

3. 配置 SignalR

3.1 配置服务

在 Startup.cs 文件中，你需要配置 SignalR 服务。在 ConfigureServices 方法中添加 SignalR 服务：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    // 添加 SignalR 服务，以便在应用程序中使用 SignalR 功能
    services.AddSignalR();
}

3.2 配置中间件

在 Configure 方法中，配置 SignalR 的中间件。你需要指定 SignalR Hub 的路由：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    else
    {
        app.UseExceptionHandler("/Home/Error");
        app.UseHsts();
    }

    app.UseHttpsRedirection();
    app.UseStaticFiles();
    app.UseRouting();
    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
        // 映射 SignalR Hub 到指定的路由
        endpoints.MapHub<ChatHub>("/chathub");
    });
}

4. 创建 SignalR Hub

SignalR Hub 是一个中心点，所有的客户端都连接到这个 Hub 以进行通讯。创建一个新的类 ChatHub 继承自 Hub：

using Microsoft.AspNetCore.SignalR;
using System.Threading.Tasks;

public class ChatHub : Hub
{
    // 定义一个方法，用于接收客户端发送的消息
    public async Task SendMessage(string user, string message)
    {
        // 将消息发送到所有连接的客户端
        await Clients.All.SendAsync("ReceiveMessage", user, message);
    }
}

在这个例子中，SendMessage 方法将消息发送到所有连接的客户端，并调用 ReceiveMessage 方法，该方法将在客户端上处理消息。

5. 创建客户端

5.1 前端页面

在前端页面中，你需要添加 SignalR 客户端库。可以通过 CDN 加载 SignalR 客户端：

<script src="https://cdnjs.cloudflare.com/ajax/libs/microsoft-signalr/6.0.0/signalr.min.js"></script>

5.2 客户端脚本

创建一个 JavaScript 文件或直接在 HTML 文件中编写脚本，用于连接到 SignalR Hub 并处理消息：

<!DOCTYPE html>
<html>
<head>
    <title>SignalR Chat</title>
</head>
<body>
    <h1>SignalR Chat</h1>
    <div id="messagesList"></div>
    <input id="messageInput" type="text" placeholder="Enter message" />
    <button id="sendButton">Send</button>

    <script src="https://cdnjs.cloudflare.com/ajax/libs/microsoft-signalr/6.0.0/signalr.min.js"></script>
    <script>
        // 创建一个 SignalR 连接实例，指定 Hub 的 URL
        const connection = new signalR.HubConnectionBuilder()
            .withUrl("/chathub")
            .build();

        // 定义接收消息的处理方法
        connection.on("ReceiveMessage", (user, message) => {
            // 创建一个新的 div 元素显示消息
            const msg = document.createElement("div");
            msg.textContent = `${user}: ${message}`;
            // 将消息添加到页面的消息列表中
            document.getElementById("messagesList").appendChild(msg);
        });

        // 绑定发送按钮的点击事件
        document.getElementById("sendButton").addEventListener("click", () => {
            const user = "User"; // 发送者的用户名
            const message = document.getElementById("messageInput").value; // 输入的消息内容
            // 调用 SignalR Hub 的 SendMessage 方法，将消息发送到服务器
            connection.invoke("SendMessage", user, message).catch(err => console.error(err.toString()));
        });

        // 启动 SignalR 连接
        connection.start().catch(err => console.error(err.toString()));
    </script>
</body>
</html>