0

0

c# websocket 编程入门

幻夢星雲

幻夢星雲

发布时间:2026-01-31 09:44:56

|

798人浏览过

|

来源于php中文网

原创

新手应优先使用 Microsoft.AspNetCore.SignalR 而非 System.Net.WebSockets;前者封装 WebSocket 并支持降级、连接管理、组播等,后者仅提供底层帧操作,适用于网关等特殊场景。

c# websocket 编程入门

WebSocket 服务端用 Microsoft.AspNetCore.SignalR 还是 System.Net.WebSockets

直接说结论:新手别碰 System.Net.WebSockets 原生 API。它只提供底层读写帧的能力,连握手、ping/pong、消息分片、连接状态管理都要自己写。90% 的业务场景该用 Microsoft.AspNetCore.SignalR —— 它封装了 WebSocket(也支持长轮询降级),自带连接生命周期、组播、客户端调用服务端方法等能力。

SignalR 默认优先协商 WebSocket 协议,只要浏览器和服务端都支持,实际走的就是 WebSocket;你不用管帧格式、掩码、状态码这些细节。

  • System.Net.WebSockets:适合做协议网关、代理、或需要完全控制帧内容的极少数场景
  • Microsoft.AspNetCore.SignalR:聊天室、实时通知、协同编辑等常规需求
  • 注意 SignalR 的 Hub 是无状态的,不能在 Hub 类里存实例字段来共享数据

如何创建一个最简 SignalR Hub 并让前端连上?

新建 ASP.NET Core Web API 项目后,安装 Microsoft.AspNetCore.SignalR NuGet 包,然后添加一个继承 Hub 的类:

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

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

builder.Services.AddSignalR();
// ...
app.MapHub("/chat");

前端 JS 使用官方 @microsoft/signalr 客户端库:

汽车导购门户整站源码
汽车导购门户整站源码

汽车导购门户网为齐博CMS V7版的基础改编而成的,程序为整站程序,自带3000多数据,安装好在后台恢复数据就可以直接使用哦。 安装前,请必须确认/data/ /cache/目录可写 然后在地址栏目输入安装地址 http://xxx.com/install.php 一步步的安装. blog 博客 wn 万能文章 count 流量统计 exam 考试系统 form 万能表单

下载
const connection = new signalR.HubConnectionBuilder()
    .withUrl("/chat")
    .build();

connection.on("ReceiveMessage", (user, message) => {
    console.log(`${user}: ${message}`);
});

await connection.start(); // 必须显式 start()
connection.invoke("SendMessage", "Alice", "Hello");
  • 路径必须完全匹配 MapHub 的路由(如 /chat
  • connection.start() 是 Promise,不 await 就调 invoke 会报 Cannot invoke methods on a hub before it's started
  • Hub 方法名在客户端调用时是大小写敏感的字符串,比如 SendMessage 对应 connection.invoke("SendMessage", ...)

为什么客户端收不到消息?常见连接和跨域问题

最常见的失败不是代码写错,而是环境配置没到位:

  • 开发时若前端是 http://localhost:3000后端https://localhost:5001,默认跨域会拦截 WebSocket 升级请求 —— 必须在 Program.cs 配置 CORS 支持 WebSocket:
builder.Services.AddCors(options =>
{
    options.AddPolicy("AllowAll", policy =>
    {
        policy.AllowAnyOrigin()
              .AllowAnyMethod()
              .AllowAnyHeader()
              .WithExposedHeaders("WWW-Authenticate"); // 关键:允许暴露认证头(如有)
    });
});
// ...
app.UseCors("AllowAll");
  • SignalR 要求 CORS 策略必须用 AllowAnyOrigin() 或明确列出源,AllowCredentials()AllowAnyOrigin() 不能共存
  • 如果用了 HTTPS 反向代理(如 Nginx),需确保代理透传 UpgradeConnection 头,并开启 WebSocket 支持
  • Chrome 控制台 Network 标签下,筛选 wswss,看连接是否返回 101 Switching Protocols;如果卡在 pending 或直接 404,基本是路由或跨域问题

Hub 方法参数类型限制和序列化陷阱

SignalR 默认用 System.Text.Json 序列化,不支持 DateTimeOffset 的毫秒级精度保留、不支持循环引用、不支持 Dictionary 这类弱类型结构的反序列化。

  • 参数必须是可序列化的 POCO,字段/属性要有 public getter/setter
  • 避免传 dynamicobject,前端传过来的 JSON 对象会被反序列化成 JsonElement,Hub 方法签名若写 object data 会导致运行时报 InvalidOperationException: Cannot bind parameter 'data' of type 'System.Object'
  • 需要灵活结构时,用 JsonElementJsonDocument 显式接收:
public async Task HandleEvent(JsonElement payload)
{
    var eventType = payload.GetProperty("type").GetString();
    await Clients.All.SendAsync("EventReceived", eventType);
}
  • 前端发送时保持 JSON 结构清晰,例如:connection.invoke("HandleEvent", { "type": "click", "x": 100 })

真正难的从来不是“怎么连上”,而是连接建立后怎么处理重连、离线消息、用户身份绑定、以及并发调用下 Hub 实例的生命周期边界——这些不在入门范围,但你在加第一个 Clients.Group(...).SendAsync(...) 之前,就得想清楚 Group 名怎么生成、谁负责加入/退出、有没有清理机制。

相关文章

编程速学教程(入门课程)
编程速学教程(入门课程)

编程怎么学习?编程怎么入门?编程在哪学?编程怎么学才快?不用担心,这里为大家提供了编程速学教程(入门课程),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

233

2023.07.27

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

502

2023.08.04

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

501

2023.08.04

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

234

2024.02.23

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

341

2024.07.09

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

3521

2024.08.07

nginx部署php项目教程汇总
nginx部署php项目教程汇总

本专题整合了nginx部署php项目教程汇总,阅读专题下面的文章了解更多详细内容。

35

2026.01.13

nginx配置文件详细教程
nginx配置文件详细教程

本专题整合了nginx配置文件相关教程详细汇总,阅读专题下面的文章了解更多详细内容。

57

2026.01.13

2026赚钱平台入口大全
2026赚钱平台入口大全

2026年最新赚钱平台入口汇总,涵盖任务众包、内容创作、电商运营、技能变现等多类正规渠道,助你轻松开启副业增收之路。阅读专题下面的文章了解更多详细内容。

54

2026.01.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.6万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

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

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