C#asp.net core后端WebSocket 服务怎么启用,接口怎么写,需要一个非常详细案例
时间: 2024-02-03 15:12:44 浏览: 33
好的,我来给你提供一个详细的ASP.NET Core中使用WebSocket的案例。
**1. 创建 ASP.NET Core 项目**
首先需要创建一个ASP.NET Core 项目,可以选择空项目或Web应用程序模板。
**2. 添加 WebSocket 支持**
在ASP.NET Core中,使用WebSocket需要添加Microsoft.AspNetCore.WebSockets包。可以通过NuGet包管理器或手动添加对项目的引用来添加此包。
**3. 添加 WebSocket 控制器**
在 ASP.NET Core 中,WebSocket 控制器是处理 WebSocket 请求的类。可以创建一个控制器类并继承自 Microsoft.AspNetCore.Mvc.Controller 类,然后添加 WebSocket 相关的方法。
```csharp
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Http;
using System.Net.WebSockets;
using System.Threading.Tasks;
namespace WebSocketExample.Controllers
{
[Route("api/[controller]")]
public class WebSocketController : Controller
{
[HttpGet("{id}")]
public async Task Get(string id)
{
if (HttpContext.WebSockets.IsWebSocketRequest)
{
WebSocket webSocket = await HttpContext.WebSockets.AcceptWebSocketAsync();
await Echo(webSocket);
}
else
{
HttpContext.Response.StatusCode = 400;
}
}
private async Task Echo(WebSocket webSocket)
{
var buffer = new byte[1024 * 4];
WebSocketReceiveResult result = await webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), System.Threading.CancellationToken.None);
while (!result.CloseStatus.HasValue)
{
await webSocket.SendAsync(new ArraySegment<byte>(buffer, 0, result.Count), result.MessageType, result.EndOfMessage, System.Threading.CancellationToken.None);
result = await webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), System.Threading.CancellationToken.None);
}
await webSocket.CloseAsync(result.CloseStatus.Value, result.CloseStatusDescription, System.Threading.CancellationToken.None);
}
}
}
```
在上面的代码中,我们创建了一个名为 WebSocketController 的控制器,并添加了一个 Get 方法来处理 WebSocket 请求。
在 Get 方法中,我们首先检查当前请求是否是 WebSocket 请求,如果是,则接受 WebSocket 连接,并调用 Echo 方法来处理 WebSocket 消息。如果不是,则返回状态码 400。
在 Echo 方法中,我们接收 WebSocket 传来的消息,然后立即将其回发给客户端。该方法会一直循环,直到收到一个 CloseStatus 告知连接需要关闭,然后关闭连接。
**4. 配置应用程序启动**
现在我们需要配置应用程序以启用 WebSocket 支持。在 Startup.cs 文件中,添加以下代码来启用 WebSocket 支持:
```csharp
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseWebSockets();
app.UseMvc();
}
```
**5. 测试 WebSocket**
现在,我们可以使用任何 WebSocket 客户端来测试上面的代码。例如,我们可以使用 JavaScript 来创建一个 WebSocket 客户端。
```javascript
var socket = new WebSocket("ws://localhost:5000/api/websocket/1");
socket.onmessage = function (evt) {
console.log(evt.data);
};
socket.onopen = function (evt) {
console.log("WebSocket opened.");
socket.send("Hello from client.");
};
```
在上面的 JavaScript 代码中,我们创建了一个 WebSocket 连接,并在连接打开时发送一条消息。当收到消息时,我们将其输出到控制台。
**6. 运行应用程序**
现在我们可以运行应用程序,并使用 WebSocket 客户端连接到我们的 WebSocket 服务。运行应用程序后,控制台应该显示类似以下内容:
```
WebSocket opened.
Hello from client.
```
接着,WebSocket 服务将回发相同的消息,并在控制台输出以下内容:
```
Hello from client.
```
这就是使用ASP.NET Core创建WebSocket服务的详细步骤和示例代码。