当前位置：首页 > news >正文

在 .NET Core 中创建 Web Socket API

news 2025/7/22 16:05:58

要在 ASP.NET Core 中创建 WebSocket API，您可以按照以下步骤操作：

设置新的 ASP.NET Core 项目

打开 Visual Studio 或您喜欢的 IDE。
创建一个新的 ASP.NET Core Web 应用程序项目。
选择API模板，因为这将成为您的 WebSocket API 的基础。

在启动时添加 WebSocket 支持

打开Startup.cs（或Program.cs在 .NET 6 或更高版本中）。
在Configure方法中，通过调用添加 WebSocket 支持 UseWebSockets()。
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseExceptionHandler("/Home/Error");
app.UseHsts();
}

// Enable WebSocket support
var webSocketOptions = new WebSocketOptions
{
KeepAliveInterval = TimeSpan.FromSeconds(120),
ReceiveBufferSize = 4096
};
app.UseWebSockets(webSocketOptions);

app.UseRouting();

app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
});
}

创建 WebSocket 处理程序

创建将处理 WebSocket 连接的新服务或类。
public class WebSocketHandler
{
private readonly WebSocket _webSocket;

public WebSocketHandler(WebSocket webSocket)
{
_webSocket = webSocket;
}

public async Task HandleWebSocketAsync(CancellationToken cancellationToken)
{
var buffer = new byte[1024 * 4];
WebSocketReceiveResult result;
do
{
result = await _webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), cancellationToken);
if (result.MessageType == WebSocketMessageType.Text)
{
var message = Encoding.UTF8.GetString(buffer, 0, result.Count);
// Process message or forward it
}
else if (result.MessageType == WebSocketMessageType.Close)
{
await _webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, "Closing", cancellationToken);
}
} while (!cancellationToken.IsCancellationRequested);
}
}

创建 WebSocket 控制器

在您的Controllers文件夹中，创建一个监听 WebSocket 连接的新控制器。
[ApiController]
[Route("api/[controller]")]
public class WebSocketController : ControllerBase
{
private readonly WebSocketHandler _webSocketHandler;

public WebSocketController(WebSocketHandler webSocketHandler)
{
_webSocketHandler = webSocketHandler;
}

[HttpGet("connect")]
public async Task<IActionResult> Connect(CancellationToken cancellationToken)
{
if (!HttpContext.WebSockets.IsWebSocketRequest)
{
return BadRequest("WebSocket request expected");
}

var webSocket = await HttpContext.WebSockets.AcceptWebSocketAsync();
await _webSocketHandler.HandleWebSocketAsync(cancellationToken);

return Ok();
}
}

配置依赖注入

在Startup.cs（或Program.cs在 .NET 6 中）将其注册 WebSocketHandler为服务。
public void ConfigureServices(IServiceCollection services)
{
services.AddSingleton<WebSocketHandler>();
services.AddControllers();
}

处理 WebSocket 消息

在您的中WebSocketHandler，您可以添加逻辑来处理 WebSocket 消息。这包括读取、发送和处理不同类型的消息。
例如，在HandleWebSocketAsync方法中：

if (result.MessageType == WebSocketMessageType.Text)
{
var message = Encoding.UTF8.GetString(buffer, 0, result.Count);
// Send a response back to the client
var response = Encoding.UTF8.GetBytes($"You said: {message}");
await _webSocket.SendAsync(new ArraySegment<byte>(response), WebSocketMessageType.Text, true, cancellationToken);
}