展开菜单
首页 精品内容 本月促销 装机必备 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软件 更多
      讯飞智作 网页版
      讯飞智作 网页版

      讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

      火山引擎 网页版
      火山引擎 网页版

      火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

      Aperty macOS版
      Aperty macOS版

      Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

      立刻MV 网页版
      立刻MV 网页版

      立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

      蛙蛙写作 网页版
      蛙蛙写作 网页版

      蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

      超级简历WonderCV 网页版
      超级简历WonderCV 网页版

      超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

      音述AI 网页版
      音述AI 网页版

      音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

      AionClaw macOS版
      AionClaw macOS版

      AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

      Loomy macOS版
      Loomy macOS版

      Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

      AirBuddy 3 macOS版
      AirBuddy 3 macOS版

      AirBuddy 3 是面向 macOS 的蓝牙外设增强工具,可集中查看 AirPods、Beats 与苹果设备电量,提供快速连接、播放控制、电量提醒、桌面小组件和多台 Mac 外设接力等功能。

      AirServer macOS版
      AirServer macOS版

      AirServer macOS版可把 Mac 转换为无线投屏接收端,通过 AirPlay 或 Google Cast 接收手机、平板和电脑画面,并支持多设备同时连接、高清镜像及会话录制,适合家庭娱乐、课堂教学、会议演示和应用展示。

      AnyDesk macOS版
      AnyDesk macOS版

      AnyDesk macOS版是一款适用于远程办公、设备维护和客户支持的远程桌面工具,可连接并操作异地计算机,支持文件传输、无人值守访问、会话权限控制及跨平台协作。

      WINDOWS 更多
      讯飞智作 网页版
      讯飞智作 网页版

      讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

      火山引擎 网页版
      火山引擎 网页版

      火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

      PixTV 网页版
      PixTV 网页版

      PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。

      讯飞绘文 网页版
      讯飞绘文 网页版

      讯飞绘文网页版是科大讯飞推出的AI图文创作与内容运营工具,覆盖热点选题、文章生成、稿件校对、智能配图、排版发布和数据复盘等环节,适合自媒体创作者及内容团队在线使用。

      Maya(Autodesk Maya) Windows版
      Maya(Autodesk Maya) Windows版

      Autodesk Maya 是面向影视、电视、动画和游戏行业的专业三维制作软件,集多边形与 NURBS 建模、角色绑定、关键帧和动作捕捉动画、Bifrost 特效模拟、材质开发及 Arnold 渲染于一体,

      Aperty Windows版
      Aperty Windows版

      Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

      立刻MV 网页版
      立刻MV 网页版

      立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

      蛙蛙写作 网页版
      蛙蛙写作 网页版

      蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

      超级简历WonderCV 网页版
      超级简历WonderCV 网页版

      超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

      音述AI 网页版
      音述AI 网页版

      音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

      AionClaw Windows版
      AionClaw Windows版

      AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

      Loomy Windows版
      Loomy Windows版

      Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。