0

0

SignalR入门教程:为你的ASP.NET Core应用添加实时Web功能

畫卷琴夢

畫卷琴夢

发布时间:2025-12-08 21:23:57

|

358人浏览过

|

来源于php中文网

原创

SignalR是ASP.NET Core用于实现实时通信的库,支持WebSocket等传输方式,通过定义Hub类实现消息广播。首先安装Microsoft.AspNetCore.SignalR包,然后创建ChatHub类处理消息发送,接着在Program.cs中注册服务并映射/chathub路由。前端引入signalr.min.js后,用HubConnectionBuilder连接Hub,通过connection.on接收消息,invoke调用服务端方法。部署时需确保服务器支持WebSocket,负载均衡场景使用Redis背板同步多实例消息,并处理连接生命周期与异常重试。

signalr入门教程:为你的asp.net core应用添加实时web功能

想让你的ASP.NET Core应用支持实时通信?比如聊天室、实时通知或数据看板?SignalR 是微软为 .NET 开发者提供的强大工具,能轻松实现服务器主动向客户端推送消息。它封装了 WebSocket、长轮询等底层技术,让你无需关心兼容性问题。

什么是 SignalR?

SignalR 是 ASP.NET Core 的一个库,用于简化实时 Web 功能的开发。它允许服务器在数据更新时立即推送给客户端,而不是等待客户端请求。客户端可以是浏览器(通过 JavaScript)、移动应用或其他服务。

核心特点包括:

  • 自动选择最佳传输方式:优先使用 WebSocket,降级到长轮询等
  • API 简洁:只需定义 Hub 类,即可处理客户端连接和消息收发
  • 跨平台支持:适用于浏览器、.NET 客户端、移动端等

创建一个简单的实时聊天功能

下面带你一步步在 ASP.NET Core 项目中集成 SignalR,实现一个基础聊天室。

步骤 1:安装 NuGet 包

在你的 ASP.NET Core 项目中,通过 NuGet 安装 SignalR 服务端包:

dotnet add package Microsoft.AspNetCore.SignalR
步骤 2:定义 Hub 类

Hub 是 SignalR 的核心组件,负责处理客户端连接和消息交换。创建一个继承自 Hub 的类:

using Microsoft.AspNetCore.SignalR;

public class ChatHub : Hub
{
    public async Task SendMessage(string user, string message)
    {
        await Clients.All.SendAsync("ReceiveMessage", user, message);
    }
}

这个方法会将消息广播给所有连接的客户端,调用客户端上的 ReceiveMessage 函数。

Solvely
Solvely

AI学习伴侣,数学解体,作业助手,家教辅导

下载
步骤 3:配置 Startup 或 Program 文件

Program.cs 中注册 SignalR 服务并映射 Hub 路由:

var builder = WebApplication.CreateBuilder(args);

// 添加 SignalR 服务
builder.Services.AddSignalR();

var app = builder.Build();

app.UseRouting();

// 映射 ChatHub 到 /chathub
app.MapHub("/chathub");

app.Run();

前端连接 SignalR Hub

使用 JavaScript 客户端连接到 Hub。引入 SignalR 客户端库(可通过 CDN):

然后编写连接代码:

const connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub")
    .build();

// 接收消息
connection.on("ReceiveMessage", function (user, message) {
    const msg = document.createElement("div");
    msg.textContent = `${user}: ${message}`;
    document.getElementById("messages").appendChild(msg);
});

// 启动连接
connection.start().catch(err => console.error(err));

// 发送消息
function sendMessage() {
    const user = document.getElementById("user").value;
    const message = document.getElementById("message").value;
    connection.invoke("SendMessage", user, message).catch(err => console.error(err));
}

搭配简单 HTML 表单,你就能看到实时聊天效果。

部署与注意事项

SignalR 在开发环境运行良好,但上线时需要注意:

  • 使用支持 WebSocket 的服务器:IIS 需启用 WebSocket,Kestrel 原生支持
  • 负载均衡时启用 Sticky Sessions 或使用 Redis 背板(Backplane) 实现多实例间消息同步
  • 处理连接生命周期:重写 OnConnectedAsyncOnDisconnectedAsync 方法可跟踪用户上下线

基本上就这些。SignalR 让实时功能变得像写普通 API 一样简单。只要定义 Hub 和消息方法,前后端就能高效通信。不复杂,但容易忽略连接管理和异常处理,建议在生产环境中加入日志和重试机制。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

552

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

374

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

731

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

477

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

394

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

656

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

551

2023.09.20

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

2

2026.01.14

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 3.6万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2.2万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号