ASP.NET Core 中的 WebSocket 支持WebSockets support in ASP.NET Core

本文内容

作者：Tom Dykstra 和 Andrew Stanton-Nurse

本文介绍 ASP.NET Core 中 WebSocket 的入门方法。WebSocket (RFC 6455) 是一个协议，支持通过 TCP 连接建立持久的双向信道。它用于从快速实时通信中获益的应用，如聊天、仪表板和游戏应用。

查看或下载示例代码（如何下载）。如何运行。

SignalRSignalR

ASP.NET Core SignalR 是一个库，可用于简化向应用添加实时 Web 功能。它会尽可能地使用 WebSocket。

对于大多数应用程序，我们建议使用 SignalR，而不是原始 Websocket。SignalR 可为 Websocket 不可用的环境提供传输回退。它还可提供简单的远程过程调用应用模型。并且在大多数情况下，与使用原始 Websocket 相比，SignalR 没有显著的性能缺点。

先决条件Prerequisites

  • ASP.NET Core 1.1 或更高版本

  • 支持 ASP.NET Core 的任何操作系统：

    • Windows 7/Windows Server 2008 或更高版本
    • Linux
    • macOS

  • 如果应用在安装了 IIS 的 Windows 上运行：

    • Windows 8 / Windows Server 2012 及更高版本
    • IIS 8 / IIS 8 Express
    • 必须启用 WebSocket（请参阅 IIS/IIS Express 支持部分。）。

  • 如果应用在 HTTP.sys 上运行：

    • Windows 8 / Windows Server 2012 及更高版本
  • 有关支持的浏览器，请参阅 https://caniuse.com/#feat=websockets 。

NuGet 程序包NuGet package

安装 Microsoft.AspNetCore.WebSockets 包。

配置中间件Configure the middleware

在 Startup 类的 Configure 方法中添加 WebSocket 中间件：

  1. app.UseWebSockets();

可配置以下设置：

  • KeepAliveInterval - 向客户端发送“ping”帧的频率，以确保代理保持连接处于打开状态。默认值为 2 分钟。
  • ReceiveBufferSize - 用于接收数据的缓冲区的大小。高级用户可能需要对其进行更改，以便根据数据大小调整性能。默认值为 4 KB。

可配置以下设置：

  • KeepAliveInterval - 向客户端发送“ping”帧的频率，以确保代理保持连接处于打开状态。默认值为 2 分钟。
  • ReceiveBufferSize - 用于接收数据的缓冲区的大小。高级用户可能需要对其进行更改，以便根据数据大小调整性能。默认值为 4 KB。
  • AllowedOrigins - 用于 WebSocket 请求的允许的 Origin 标头值列表。默认情况下，允许使用所有源。有关详细信息，请参阅以下“WebSocket 源限制”。
  1. var webSocketOptions = new WebSocketOptions() 
  2. {
  3.     KeepAliveInterval = TimeSpan.FromSeconds(120),
  4.     ReceiveBufferSize = 4 * 1024
  5. };
  7. app.UseWebSockets(webSocketOptions);

接受 WebSocket 请求Accept WebSocket requests

在请求生命周期后期（例如在 Configure 方法或操作方法的后期），检查它是否是 WebSocket 请求并接受 WebSocket 请求。

以下示例来自 Configure 方法的后期：

  1. app.Use(async (context, next) =>
  2. {
  3.     if (context.Request.Path == "/ws")
  4.     {
  5.         if (context.WebSockets.IsWebSocketRequest)
  6.         {
  7.             WebSocket webSocket = await context.WebSockets.AcceptWebSocketAsync();
  8.             await Echo(context, webSocket);
  9.         }
  10.         else
  11.         {
  12.             context.Response.StatusCode = 400;
  13.         }
  14.     }
  15.     else
  16.     {
  17.         await next();
  18.     }
  20. });

WebSocket 请求可以来自任何 URL，但此示例代码只接受 /ws 的请求。

使用 WebSocket 时，“必须” 在连接期间保持中间件管道运行。如果在中间件管道结束后尝试发送或接收 WebSocket 消息，可能会遇到以下异常情况：

  1. System.Net.WebSockets.WebSocketException (0x80004005): The remote party closed the WebSocket connection without completing the close handshake. ---> System.ObjectDisposedException: Cannot write to the response body, the response has completed.
  2. Object name: 'HttpResponseStream'.

如果使用后台服务将数据写入 WebSocket，请确保保持中间件管道运行。通过使用 TaskCompletionSource<TResult> 执行此操作。传递 TaskCompletionSource 到背景服务，并在通过 WebSocket 完成时让其调用 TrySetResult。在请求期间对 Task 执行 await，如下面的示例所示：

  1. app.Use(async (context, next) => {
  2.     var socket = await context.WebSockets.AcceptWebSocketAsync();
  3.     var socketFinishedTcs = new TaskCompletionSource<object>();
  5.     BackgroundSocketProcessor.AddSocket(socket, socketFinishedTcs); 
  7.     await socketFinishedTcs.Task;
  8. });

如果从操作方法返回过快，则还可能发生 WebSocket 关闭异常。如果接受操作方法中的套接字，请等待使用套接字的代码完成运行，然后再从操作方法返回。

坚决不要使用 Task.Wait()、Task.Result 或类似阻塞调用来等待套接字完成，因为这可能导致严重的线程处理问题。请始终使用 await。

发送和接收消息Send and receive messages

AcceptWebSocketAsync 方法将 TCP 连接升级到 WebSocket 连接，并提供 WebSocket 对象。使用 WebSocket 对象发送和接收消息。

之前显示的接受 WebSocket 请求的代码将 WebSocket 对象传递给 Echo 方法。代码接收消息并立即发回相同的消息。循环发送和接收消息，直到客户端关闭连接：

  1. private async Task Echo(HttpContext context, WebSocket webSocket)
  2. {
  3.     var buffer = new byte[1024 * 4];
  4.     WebSocketReceiveResult result = await webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), CancellationToken.None);
  5.     while (!result.CloseStatus.HasValue)
  6.     {
  7.         await webSocket.SendAsync(new ArraySegment<byte>(buffer, 0, result.Count), result.MessageType, result.EndOfMessage, CancellationToken.None);
  9.         result = await webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), CancellationToken.None);
  10.     }
  11.     await webSocket.CloseAsync(result.CloseStatus.Value, result.CloseStatusDescription, CancellationToken.None);
  12. }

如果在开始循环之前接受 WebSocket 连接，中间件管道会结束。关闭套接字后，管道展开。即接受 WebSocket 时，请求停止在管道中推进。循环结束且套接字关闭时，请求继续回到管道。

处理客户端连接断开Handle client disconnects

当客户端由于失去连接而断开连接时不会自动向服务器发送通知。服务器只有在客户端发送通知时才会收到断开连接消息，而此操作无法在失去 Internet 连接的情况下进行。如果想要在发生此情况时采取某个操作，在特定时间范围内未收到来自客户端的任何消息后设置超时。

如果客户端并非总是发送消息且不希望仅由于连接进入空闲状态就设置超时，则让客户端使用一个计时器并每隔 X 秒发送一条 ping 消息。在服务器上，如果某条消息在上一条消息发出后的 2*X 秒内尚未到达，则终止连接并报告客户端已断开连接。等待两次预测的时间间隔，以便为可能延迟 ping 消息的网络延迟提供额外的时间。

WebSocket 源限制WebSocket origin restriction

CORS 提供的保护不适用于 WebSocket。浏览器不会 ：

  • 执行 CORS 预检请求。
  • 在发出 WebSocket 请求时，遵守 Access-Control 标头中指定的限制。

但是，浏览器在发出 WebSocket 请求时会发送 Origin 标头。应将应用程序配置为验证这些标头，以确保只允许来自预期来源的 WebSocket。

如果在“https://server.com ”上托管服务器并在“https://client.com”上托管客户端，请将“https://client.com”添加到 AllowedOrigins 列表以验证 WebSocket。

  1. var webSocketOptions = new WebSocketOptions()
  2. {
  3.     KeepAliveInterval = TimeSpan.FromSeconds(120),
  4.     ReceiveBufferSize = 4 * 1024
  5. };
  6. webSocketOptions.AllowedOrigins.Add("https://client.com");
  7. webSocketOptions.AllowedOrigins.Add("https://www.client.com");
  9. app.UseWebSockets(webSocketOptions);

备注

与 Referer 标头一样，Origin 标头由客户端控制，并可以伪造。 请勿将这些标头用作身份验证机制。

IIS/IIS Express 支持IIS/IIS Express support

安装了 IIS/IIS Express 8 或更高版本的 Windows Server 2012 或更高版本以及 Windows 8 或更高版本支持 WebSocket 协议。

备注

使用 IIS Express 时始终启用 WebSocket。

在 IIS 上启用 WebsocketEnabling WebSockets on IIS

在 Windows Server 2012 或更高版本上启用对 WebSocket 协议的支持：

备注

使用 IIS Express 时无需执行这些步骤

  • 通过“管理” 菜单或“服务器管理器” 中的链接使用“添加角色和功能” 向导。
  • 选择“基于角色或基于功能的安装” 。选择“下一步” 。
  • 选择适当的服务器（默认情况下选择本地服务器）。选择“下一步” 。
  • 在“角色”树中展开“Web 服务器 (IIS)”、然后依次展开“Web 服务器”和“应用程序开发” 。
  • 选择“WebSocket 协议” 。选择“下一步” 。
  • 如果无需其他功能，请选择“下一步” 。
  • 选择“安装” 。
  • 安装完成后，选择“关闭”以退出向导 。
    在 Windows 8 或更高版本上启用对 WebSocket 协议的支持：

备注

使用 IIS Express 时无需执行这些步骤

  • 导航到“控制面板” > “程序” > “程序和功能” > “启用或禁用 Windows 功能”（位于屏幕左侧） 。
  • 打开以下节点：“Internet Information Services” > “万维网服务” > “应用程序开发功能” 。
  • 选择“WebSocket 协议” 功能。选择“确定” 。

在 Node.js 上使用 socket.io 时禁用 WebSocketDisable WebSocket when using socket.io on Node.js

如果在 Node.js 的 socket.io 中使用 WebSocket 支持，请使用 web.config 或 applicationHost.config 中的 webSocket 元素禁用默认的 IIS WebSocket 模块 。如果不执行此步骤，IIS WebSocket 模块将尝试处理 WebSocket 通信而不是 Node.js 和应用。

  1. <system.webServer>
  2.   <webSocket enabled="false" />
  3. </system.webServer>

示例应用Sample app

本文附带的示例应用是一个 echo 应用。它有一个可建立 WebSocket 连接的网页，且服务器将其收到的消息重新发回到客户端。从命令提示符运行该应用（它未设置为在安装了 IIS Express 的 Visual Studio 中运行）并导航到 http://localhost:5000 。该网页的左上方显示连接状态：

网页的初始状态

选择“连接”，向显示的 URL 发送 WebSocket 请求 。输入测试消息并选择“发送” 。完成后，请选择“关闭套接字” 。“通信日志” 部分会报告每一个发生的“打开”、“发送”和“关闭”操作。

网页的初始状态