推荐使用.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 环境)。下面分服务端与客户端两部分,给出简洁、可直接运行的核心代码和关键说明。
这是最常用、生产就绪的方式,基于中间件托管 WebSocket 连接。
// .NET 6+ Program.cs 示例 var builder = WebApplication.CreateBuilder(args); builder.Services.AddWebSockets(); // 启用 WebSocket 支持var app = builder.Build(); app.UseWebSockets(); // 必须在 UseRouting() 之后、UseEndpoints() 之前
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 管理多连接。适合轻量测试或嵌入式场景,不依赖 ASP.NET Core。
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}");
}
}
使用 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 再发送;new WebSocket("ws://...") 快速验证服务端是否正常。Origin 头决定,可在中间件中校验并拒绝非法来源;Ping,客户端响应 Pong;ClientWebSocket 自动处理 Pong,但需设置 KeepAliveInterval;result.EndOfMessage == false),接收时需缓冲拼接;基本上就这些。核心是分清场景:Web 应用选 ASP
.NET Core WebSocket 中间件;桌面/后台服务可选 ClientWebSocket + 自建服务端或 SignalR;快速原型可用 WebSocketSharp(注意平台限制)。不复杂但容易忽略错误处理和连接状态管理。