展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > .NET8使用SignalR实现实时通信的完整指南

.NET8使用SignalR实现实时通信的完整指南

在.NET8中,SignalR实现实时通信需配置服务端和CORS,创建Hub类处理用户登录、群组管理和消息发送,支持浏览器及WinForms客户端。通信技术按WebSocket优先、Server-SentEvents备选的顺序自动选择,适合构建高效低延迟的实时应用。

本文目录

    SignalR 是实时通信领域的老牌选手了,它能在服务器和客户端之间搭建起双向通信的桥梁。这篇文章会带你在 .NET 8 里把 SignalR 跑起来,从服务端配置、CORS 设置,到前端浏览器调用、WinForms 客户端实现,全流程走一遍。顺便还会深入聊聊 SignalR 选择通信技术的那套逻辑——WebSocket → Server-Sent Events (SSE) 的优先级顺序,到底是怎么一回事。

    一、服务端实现

    1. 安装 SignalR 包

    先把核心包请进项目:

    dotnet add package Microsoft.AspNetCore.SignalR

    2. 配置 SignalR 与 CORS

    跨域问题在 SignalR 里很常见,尤其是前后端分离的场景。所以 Program.cs 里必须把 CORS 安排明白:

    var builder = WebApplication.CreateBuilder(args);
    
    // 添加 SignalR 服务
    builder.Services.AddSignalR();
    
    // 配置 CORS
    builder.Services.AddCors(options =>
    {
        options.AddPolicy("AllowAll", policy =>
        {
            policy.WithOrigins("https://localhost:7100") // 允许的前端地址
                  .AllowAnyHeader()
                  .AllowAnyMethod()
                  .AllowCredentials(); // 允许携带认证信息(SignalR 必需)
        });
    });
    
    var app = builder.Build();
    
    // 使用 CORS
    app.UseCors("AllowAll");
    
    // 映射 SignalR Hub
    app.MapHub("/chatHub");
    
    app.Run();

    注意 AllowCredentials() 这一行——SignalR 默认要求带上认证信息,少了它连接会报错。

    3. 创建 Hub 类

    创建一个继承自 Hub 的类,用来处理客户端连接、消息收发这些核心逻辑。下面这个 ChatHub 实现了用户登录、群组管理、以及多种消息发送方式:

    using Microsoft.AspNetCore.SignalR;
    using System.Collections.Concurrent;
    
    namespace SignalRDemo;
    
    public class ChatHub : Hub
    {
        // 存储用户与连接ID的映射
        private static readonly ConcurrentDictionary _userConnections = new();
        // 存储群组与连接ID的映射
        private static readonly ConcurrentDictionary> _groupConnections = new();
    
        /// 
        /// 客户端连接时触发
        /// 
        public override async Task OnConnectedAsync()
        {
            Console.WriteLine($"客户端 {Context.ConnectionId} 已连接");
            await base.OnConnectedAsync();
        }
    
        /// 
        /// 客户端断开连接时触发
        /// 
        public override async Task OnDisconnectedAsync(Exception? exception)
        {
            Console.WriteLine($"客户端 {Context.ConnectionId} 已断开连接");
    
            // 从用户映射中移除
            var user = _userConnections.FirstOrDefault(kv => kv.Value == Context.ConnectionId).Key;
            if (!string.IsNullOrEmpty(user))
            {
                _userConnections.TryRemove(user, out _);
            }
    
            // 从所有群组中移除
            foreach (var group in _groupConnections.Keys)
            {
                _groupConnections[group].Remove(Context.ConnectionId);
            }
    
            await base.OnDisconnectedAsync(exception);
        }
    
        /// 
        /// 用户登录(绑定用户名和连接ID)
        /// 
        public async Task Login(string username)
        {
            _userConnections[username] = Context.ConnectionId;
            await Clients.Caller.SendAsync("LoginSuccess", $"你已登录为 {username}");
        }
    
        /// 
        /// 加入群组
        /// 
        public async Task JoinGroup(string groupName)
        {
            if (!_groupConnections.ContainsKey(groupName))
            {
                _groupConnections[groupName] = new HashSet();
            }
            _groupConnections[groupName].Add(Context.ConnectionId);
            await Clients.Caller.SendAsync("JoinGroupSuccess", $"你已加入群组 {groupName}");
        }
    
        /// 
        /// 发送消息给所有人
        /// 
        public async Task SendMessageToAll(string user, string message)
        {
            await Clients.All.SendAsync("ReceiveMessage", user, message);
        }
    
        /// 
        /// 发送消息给单个人
        /// 
        public async Task SendMessageToUser(string targetUser, string user, string message)
        {
            if (_userConnections.TryGetValue(targetUser, out var connectionId))
            {
                await Clients.Client(connectionId).SendAsync("ReceiveMessage", user, message);
            }
            else
            {
                await Clients.Caller.SendAsync("Error", $"用户 {targetUser} 不在线");
            }
        }
    
        /// 
        /// 发送消息给多个人
        /// 
        public async Task SendMessageToUsers(IReadOnlyList targetUsers, string user, string message)
        {
            var connectionIds = new List();
            foreach (var targetUser in targetUsers)
            {
                if (_userConnections.TryGetValue(targetUser, out var connectionId))
                {
                    connectionIds.Add(connectionId);
                }
            }
    
            if (connectionIds.Any())
            {
                await Clients.Clients(connectionIds).SendAsync("ReceiveMessage", user, message);
            }
            else
            {
                await Clients.Caller.SendAsync("Error", "没有目标用户在线");
            }
        }
    
        /// 
        /// 发送消息给群组
        /// 
        public async Task SendMessageToGroup(string groupName, string user, string message)
        {
            if (_groupConnections.TryGetValue(groupName, out var connections))
            {
                if (connections.Any())
                {
                    await Clients.Clients(connections).SendAsync("ReceiveMessage", user, message);
                }
                else
                {
                    await Clients.Caller.SendAsync("Error", $"群组 {groupName} 没有成员");
                }
            }
            else
            {
                await Clients.Caller.SendAsync("Error", $"群组 {groupName} 不存在");
            }
        }
    }

    这里用 ConcurrentDictionary 来维护用户和连接ID的映射,以及群组和成员列表的映射。实际生产环境可能需要数据库或者 Redis 来持久化,但 demo 阶段这样够用。

    二、前端调用(浏览器)

    1. 安装 SignalR 客户端

    在前端项目里装客户端库:

    npm install @microsoft/signalr

    2. 前端代码示例

    下面是一个简单的 HTML 页面,通过 Ja vaScript 连接 SignalR 并实现登录、发送消息等功能:

    
    
    
        
        SignalR Chat
    
    
        
        
        

      注意这里的 withUrl 地址要和后端映射的 /chatHub 一致,并且端口别写错。

      三、WinForms 客户端调用

      1. 安装 SignalR 客户端包

      在 WinForms 项目里通过 NuGet 安装:

      dotnet add package Microsoft.AspNetCore.SignalR.Client

      2. WinForms 客户端代码

      在窗体上拖几个控件——用户名输入框、消息输入框、登录按钮、发送给所有人按钮,再加一个 ListBox 用来显示消息。代码逻辑如下:

      using Microsoft.AspNetCore.SignalR.Client;
      using System;
      using System.Windows.Forms;
      
      namespace SignalRWinFormsClient;
      
      public partial class Form1 : Form
      {
          private HubConnection _connection;
          private string _username;
      
          public Form1()
          {
              InitializeComponent();
          }
      
          private async void Form1_Load(object sender, EventArgs e)
          {
              // 连接 SignalR
              _connection = new HubConnectionBuilder()
                  .WithUrl("https://localhost:7138/chatHub")
                  .Build();
      
              // 接收消息
              _connection.On("ReceiveMessage", (user, message) =>
              {
                  Invoke(new Action(() =>
                  {
                      listBoxMessages.Items.Add($"{user}: {message}");
                  }));
              });
      
              try
              {
                  await _connection.StartAsync();
                  listBoxMessages.Items.Add("已连接到 SignalR 服务端");
              }
              catch (Exception ex)
              {
                  listBoxMessages.Items.Add($"连接失败:{ex.Message}");
              }
          }
      
          private async void btnLogin_Click(object sender, EventArgs e)
          {
              _username = txtUsername.Text;
              try
              {
                  await _connection.InvokeAsync("Login", _username);
                  listBoxMessages.Items.Add($"你已登录为 {_username}");
              }
              catch (Exception ex)
              {
                  listBoxMessages.Items.Add($"登录失败:{ex.Message}");
              }
          }
      
          private async void btnSendToAll_Click(object sender, EventArgs e)
          {
              var message = txtMessage.Text;
              try
              {
                  await _connection.InvokeAsync("SendMessageToAll", _username, message);
                  txtMessage.Clear();
              }
              catch (Exception ex)
              {
                  listBoxMessages.Items.Add($"发送失败:{ex.Message}");
              }
          }
      }

      WinForms 里要注意 UI 线程的调用——Invoke 把更新操作切回主线程,否则会抛异常。

      四、SignalR 通信技术顺序

      SignalR 在建立连接时,会根据浏览器和服务器的支持情况自动选择最佳通信技术。这个选择顺序很有意思,也是很多开发者容易忽略的细节。它的优先级是:

      1. WebSocket

      • 优先级最高,是 SignalR 的首选通信方式。
      • 全双工通信,性能最好,延迟最低。
      • 适用于大多数现代浏览器(Chrome、Firefox、Edge、Safari 等)。
      • 使用标准的 WebSocket 协议(ws:// 或 wss://)。

      2. Server-Sent Events (SSE)

      • 如果 WebSocket 不可用(比如浏览器不支持,或者被防火墙拦截),SignalR 就会退而求其次尝试 SSE。
      • 单向通信——服务器可以实时向客户端推送数据,但客户端没法通过这个通道往服务器推数据。
      • 基于 HTTP 协议,使用 EventSource API。
      • 适合那些只需要实时更新、不需要双向交互的场景,比如股票行情、新闻推送。

      3. 长轮询 (Long Polling)

      • 如果 SSE 也走不通,SignalR 会拿长轮询当最后的底牌。
      • 客户端发一个请求到服务器,服务器把连接一直挂着,直到有数据要发或者超时。超时后客户端立刻发起下一个请求。
      • 性能最差,但兼容性最好——所有浏览器都能用,包括那些老古董。

      通信技术选择流程

      客户端启动时,会先发一个 HTTP 请求到 /chatHub/negotiate 端点,拿回服务器支持的技术列表。然后客户端按照 WebSocket → SSE → 长轮询 的顺序尝试。一旦某个技术成功建立连接,后续通信就全部基于它。这个过程对开发者是完全透明的,但了解它有助于排查连接问题——比如为什么明明支持 WebSocket 却用了长轮询?多半是 CORS 或者中间件配置没到位。

      技术对比

      技术双向通信性能兼容性
      WebSocket是高现代浏览器
      SSE否(服务器到客户端)中大多数现代浏览器
      长轮询是低所有浏览器

      五、注意事项

      • CORS 配置:服务端必须正确配置 CORS,允许客户端来源并启用 AllowCredentials,否则前端连接会报跨域错误。
      • 连接管理:用好 OnConnectedAsync 和 OnDisconnectedAsync,可以记录在线状态、清理资源。
      • 用户映射:维护用户与 ConnectionId 的映射关系,是实现单播和组播的基础。
      • 群组管理:可以使用 SignalR 内置的 Groups 类,也可以像上面那样自己维护字典,灵活度更高。
      • 错误处理:客户端和服务端都要处理连接中断和异常,比如重连机制。
      • 扩展性:如果项目规模上去了,单机 SignalR 撑不住,可以考虑用 Redis 做后端背板,实现多服务器间的消息广播。

      通过这篇文章,你应该能快速在 .NET 8 里把 SignalR 跑起来,并且支持浏览器和 WinForms 两种客户端。实时通信的坑不少,但把核心链路打通了,后面的扩展就水到渠成了。

      本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
      作者最新文章
      编程开发
      相关文章 更多
      精品专题 更多
      装机必备

      正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

      Windows

      正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

      PDF教程

      正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

      macOS软件

      正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

      IOS软件

      正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

      AI

      正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

      Mac软件 更多
      IntelliJ IDEA macOS版
      IntelliJ IDEA macOS版

      IntelliJ IDEA 是 JetBrains 推出的专业集成开发环境,重点服务于 Java、Kotlin 与 JVM 项目开发。软件集成代码补全、静态检查、重构、调试、测试、版本控制及构建工具,并可借助插件扩展语言和框架支持。

      PyCharm macOS版
      PyCharm macOS版

      JetBrains PyCharm 是面向 Python 开发者的集成开发环境,提供智能补全、代码检查、重构、调试、测试、版本控制及虚拟环境管理功能。Mac 版兼容 Intel 与 Apple 芯片,核心功能可免费使用。

      WebStorm macOS版
      WebStorm macOS版

      JetBrains WebStorm 是面向 JavaScript、TypeScript 和现代 Web 技术的专业集成开发环境,可智能理解项目结构,提供代码补全、重构、错误检查、运行调试、测试及 Git 工具。

      After Effects macOS版
      After Effects macOS版

      Adobe After Effects 是面向动态图形、影视特效与视频合成的专业创作软件。它提供关键帧动画、遮罩抠像、运动跟踪、三维空间、文字动画和表达式等工具,并可与 Premiere Pro、Photoshop、Illustrator

      Audition macOS版
      Audition macOS版

      Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站,提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具,并可与 Adobe Premiere 协同完成视频声音制作。

      Bridge macOS版
      Bridge macOS版

      Adobe Bridge 是面向摄影师、设计师及内容团队的免费数字资产管理工具,可集中预览照片、视频和 Adobe 项目文件,并利用评级、标签、关键词、元数据、筛选与收藏集完成分类检索。它还支持批量重命名、格式导出、相机导入及 Camera

      Illustrator macOS版
      Illustrator macOS版

      Adobe Illustrator 是 Adobe 推出的专业矢量图形设计软件,适合在 Mac 上制作标志、图标、插画、包装、信息图及印刷版面。它以路径和锚点构建可无损缩放的图形,并提供钢笔、形状、文字、图像描摹、渐变、画板及生成式功能。

      InDesign macOS版
      InDesign macOS版

      Adobe InDesign 是面向印刷品与数字出版物的专业版面设计软件,可在 Mac 上制作书籍、杂志、宣传册、海报、报告及交互式文档。它提供精细的文字样式、网格、母版、长文档管理和印前输出能力。

      Lightroom Classic macOS版
      Lightroom Classic macOS版

      Adobe Lightroom Classic 是面向桌面摄影工作流的照片管理与后期处理软件,可将原始照片保存在本地硬盘,通过目录、关键词、评分和收藏夹高效整理图库,并提供 RAW 冲印、蒙版、镜头校正、批量同步及多格式导出等功能。

      Media Encoder macOS版
      Media Encoder macOS版

      Adobe Media Encoder 是 Adobe 推出的专业音视频编码与转码工具,可通过队列、预设和监视文件夹批量完成格式转换、代理文件创建及多平台成片输出,并与 Premiere Pro、After Effects 等软件紧密协作。

      Photoshop macOS版
      Photoshop macOS版

      Adobe Photoshop 是面向摄影师、设计师和内容创作者的专业图像处理软件,提供图层、蒙版、选区、修复、调色、文字排版、智能对象及生成式编辑等能力。Mac 版支持 Intel 与 Apple Silicon 处理器。

      Premiere Pro macOS版
      Premiere Pro macOS版

      Adobe Premiere Pro 是面向专业视频制作的非线性剪辑软件,提供多轨时间线、调色、音频处理、字幕、代理工作流和多格式输出能力,并可与 After Effects、Audition、Photoshop 及 Frame.io 协同

      WINDOWS 更多
      IntelliJ IDEA Windows版
      IntelliJ IDEA Windows版

      JetBrains IntelliJ IDEA 是以 Java、Kotlin 和 JVM 项目为核心的专业集成开发环境,提供智能补全、代码检查、安全重构、调试、测试、版本控制及构建工具集成。统一发行版的核心功能可免费用于商业和非商业项目,

      PhpStorm Windows版
      PhpStorm Windows版

      PhpStorm 是 JetBrains 面向 PHP 与现代 Web 开发打造的专业集成开发环境,提供代码补全、静态检查、重构、调试、测试、数据库、版本控制及前端语言支持。Windows 用户可直接下载安装程序,

      PyCharm Windows版
      PyCharm Windows版

      PyCharm 是 JetBrains 推出的 Python 集成开发环境,提供智能代码补全、错误检查、重构、调试、测试、Git、终端及 Jupyter Notebook 支持。统一版安装后可体验 30 天 Pro 功能,

      WebStorm Windows版
      WebStorm Windows版

      WebStorm 是 JetBrains 面向 JavaScript、TypeScript 和现代 Web 技术打造的集成开发环境。它提供项目级代码分析、智能补全、安全重构、导航搜索,并集成调试、测试、终端、Git 与常用前端工具,

      Photoshop Windows版
      Photoshop Windows版

      Adobe Photoshop 是面向摄影师、设计师和内容创作者的专业图像处理工具,可在 Windows 上完成照片修饰、选区抠图、图层合成、文字排版、绘画及生成式编辑。软件采用订阅授权,由 Creative Cloud 管理安装、更新与许

      InDesign Windows版
      InDesign Windows版

      Adobe InDesign 是面向印刷与数字出版的专业页面排版工具,可制作书籍、杂志、宣传册、海报、交互式 PDF 和电子书。它提供精细的文字样式、多页面管理、印前检查及多格式输出能力,并能与 Photoshop、Illustrator

      Illustrator Windows版
      Illustrator Windows版

      Adobe Illustrator 是用于绘制矢量图形、插画、图标、徽标和版式的专业设计工具。它以路径和锚点为核心,作品放大后仍能保持清晰,并提供画板、文字、渐变、图像描摹及精确变换等功能,适合品牌视觉、印刷物料、数字界面和商业插画创作。

      Bridge Windows版
      Bridge Windows版

      Adobe Bridge 是 Adobe 推出的创意资产管理工具,可集中预览、分类和查找照片、视频、PDF及多种设计文件,并支持元数据、关键词、评级、批量重命名和格式导出。它可与 Photoshop、Illustrator 等应用衔接,

      Lightroom Classic Windows版
      Lightroom Classic Windows版

      Adobe Lightroom Classic 是面向 Windows 桌面摄影工作流的照片管理与无损编辑工具,可通过目录集中整理大型图库,并完成 RAW 显影、局部蒙版、批量调整、打印和多格式导出。它强调本地文件管理与精细控制,

      Acrobat Pro Windows版
      Acrobat Pro Windows版

      Adobe Acrobat Pro 是面向专业 PDF 工作的综合解决方案,可在 Windows 中创建、编辑、转换、比较、整理和保护文档,并支持表单、电子签名、扫描件文字识别及敏感信息永久遮盖。订阅还包含网页、移动服务和云端协作能力,

      After Effects Windows版
      After Effects Windows版

      Adobe After Effects 是面向动态图形、动画与影视视觉特效制作的专业工具,可完成关键帧动画、图层合成、遮罩跟踪、抠像、文字动画和二维三维元素整合。Windows 版通过 Adobe Creative Cloud 安装及更新,

      Media Encoder Windows版
      Media Encoder Windows版

      Adobe Media Encoder 是 Adobe 面向视频与音频制作流程提供的专业编码和转码工具,可批量处理媒体文件、创建代理、套用输出预设并监控文件夹自动执行任务。它与 Premiere、After Effects、Audition