推荐使用.NET内置System.Net.WebSockets或Microsoft.AspNetCore.WebSockets;ASP.NET Core服务端需启用AddWebSockets()和UseWebSockets(),客户端用ClientWebSocket连接,注意状态检查、异常处理与连接生命周期管理。

在 C# 中实现 WebSocket 服务端和客户端,推荐使用 .NET 内置的 System.Net.WebSockets(适用于 .NET Core 2.1+ / .NET 5+)或更高层封装如 Microsoft.AspNetCore.WebSockets(ASP.NET Core 环境)。下面分服务端与客户端两部分,给出简洁、可直接运行的核心代码和关键说明。
ASP.NET Core 中搭建 WebSocket 服务端
这是最常用、生产就绪的方式,基于中间件托管 WebSocket 连接。
- 在 Startup.cs(.NET 5+ 改为 Program.cs)中启用 WebSocket:
// .NET 6+ Program.cs 示例 var builder = WebApplication.CreateBuilder(args); builder.Services.AddWebSockets(); // 启用 WebSocket 支持var app = builder.Build(); app.UseWebSockets(); // 必须在 UseRouting() 之后、UseEndpoints() 之前
- 添加 WebSocket 处理中间件(例如映射到 /ws):
app.Map("/ws", async context =>
{
if (context.WebSockets.IsWebSocketRequest)
{
using var webSocket = await context.WebSockets.AcceptWebSocketAsync();
await EchoWebSocketAsync(webSocket); // 简单回声逻辑
}
else
{
context.Response.StatusCode = 400;
}
});
// 回声处理方法(接收并原样发回)
static async Task EchoWebSocketAsync(WebSocket webSocket)
{
var buffer = new byte[1024];
while (webSocket.State == WebSocketState.Open)
{
var result = await webSocket.ReceiveAsync(new ArraySegment(buffer), CancellationToken.None);
if (result.MessageType == WebSocketMessageType.Text)
{
var message = Encoding.UTF8.GetString(buffer, 0, result.Count);
Console.WriteLine($"收到: {message}");
await webSocket.SendAsync(
new ArraySegment(Encoding.UTF8.GetBytes($"Echo: {message}")),
WebSocketMessageType.Text, true, CancellationToken.None);
}
else if (result.MessageType == WebSocketMessageType.Close)
{
await webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, "", CancellationToken.None);
break;
}
}
}
- 注意:需手动管理连接生命周期、并发读写(避免多个
ReceiveAsync并发)、异常捕获和资源释放;建议配合WebSocketManager或 SignalR 管理多连接。
纯控制台程序实现 WebSocket 服务端(System.Net.WebSockets)
适合轻量测试或嵌入式场景,不依赖 ASP.NET Core。
mallcloud商城基于SpringBoot2.x、SpringCloud和SpringCloudAlibaba并采用前后端分离vue的企业级微服务敏捷开发系统架构。并引入组件化的思想实现高内聚低耦合,项目代码简洁注释丰富上手容易,适合学习和企业中使用。真正实现了基于RBAC、jwt和oauth2的无状态统一权限认证的解决方案,面向互联网设计同时适合B端和C端用户,支持CI/CD多环境部署,并提
- 使用 HttpListener + AcceptWebSocketAsync(仅 Windows,.NET Core 3.1+ 跨平台支持有限):
- 更推荐方案:用 Kestrel 自托管 或第三方库如 SuperSocket、WebSocketSharp(已归档但稳定)。
- 简单示例(需 NuGet 安装 WebSocketSharp):
var wssv = new WebSocketServer("127.0.0.1:8080");
wssv.AddWebSocketService("/echo");
wssv.Start();
Console.ReadLine();
wssv.Stop();
// 自定义 Handler
public class EchoHandler : WebSocketBehavior
{
protected override void OnMessage(MessageEventArgs e)
{
Send($"Echo: {e.Data}");
}
}
- ⚠️ 注意:WebSocketSharp 不支持 .NET 5+ 的默认 TLS 配置,若需 HTTPS,建议改用 Microsoft.AspNetCore.WebSockets 或 Yarp 反向代理。
C# 客户端连接 WebSocket
使用 System.Net.WebSockets.ClientWebSocket(跨平台、内置、推荐)。
using var client = new ClientWebSocket();
await client.ConnectAsync(new Uri("ws://localhost:5000/ws"), CancellationToken.None);
// 发送文本消息
var msg = Encoding.UTF8.GetBytes("Hello Server");
await client.SendAsync(
new ArraySegment(msg),
WebSocketMessageType.Text,
true,
CancellationToken.None);
// 接收响应
var recvBuf = new byte[1024];
var recvResult = await client.ReceiveAsync(
new ArraySegment(recvBuf),
CancellationToken.None);
string response = Encoding.UTF8.GetString(recvBuf, 0, recvResult.Count);
Console.WriteLine(response);
- 务必检查
client.State == WebSocketState.Open再发送; - 接收需循环调用(WebSocket 是全双工流,不是一次请求响应);
- 建议封装成带重连、心跳、异步队列的客户端类;
- 如需浏览器兼容性调试,可用 Chrome 控制台
new WebSocket("ws://...")快速验证服务端是否正常。
常见问题与建议
-
跨域问题:ASP.NET Core 默认允许跨域请求,但 WebSocket 协议本身不走 CORS 检查;实际由 HTTP 握手阶段的
Origin头决定,可在中间件中校验并拒绝非法来源; -
长连接保活:服务端定期发
Ping,客户端响应Pong;ClientWebSocket自动处理 Pong,但需设置KeepAliveInterval; -
消息分帧与大数据:WebSocket 支持分片(
result.EndOfMessage == false),接收时需缓冲拼接; - 替代方案:高并发、广播、身份认证等复杂需求,直接上 SignalR(自动降级、Hub 模型、集成本地/Redis 背板),它底层就基于 WebSocket。
基本上就这些。核心是分清场景:Web 应用选 ASP.NET Core WebSocket 中间件;桌面/后台服务可选 ClientWebSocket + 自建服务端或 SignalR;快速原型可用 WebSocketSharp(注意平台限制)。不复杂但容易忽略错误处理和连接状态管理。









