理解ASP.NET Core 中的WebSocket-低调大师

理解ASP.NET Core 中的WebSocket

2021-03-04 570

在本文中，我们将详细介绍RFC 6455 WebSocket规范，并配置一个通用的.NET 5应用程序通过WebSocket连接与SignalR通信。

我们将深入底层的概念，以理解底层发生了什么。

关于WebSocket

引入WebSocket是为了实现客户端和服务器之间的双向通信。HTTP 1.0的一个痛点是每次向服务器发送请求时创建和关闭连接。但是，在HTTP 1.1中，通过使用保持连接机制引入了持久连接(RFC 2616)。这样，连接可以被多个请求重用——这将减少延迟，因为服务器知道客户端，它们不需要在每个请求的握手过程中启动。

WebSocket建立在HTTP 1.1规范之上，因为它允许持久连接。因此，当你第一次创建WebSocket连接时，它本质上是一个HTTP 1.1请求(稍后详细介绍)。这使得客户端和服务器之间能够进行实时通信。简单地说，下图描述了在发起(握手)、数据传输和关闭WS连接期间发生的事情。我们将在后面更深入地研究这些概念。

协议中包含了两部分：握手和数据传输。

握手

让我们先从握手开始。

简单地说，WebSocket连接基于单个端口上的HTTP(和作为传输的TCP)。下面是这些步骤的总结。

1. 服务器必须监听传入的TCP套接字连接。这可以是你分配的任何端口—通常是80或443。

2. 客户端通过一个HTTP GET请求发起开始握手(否则服务器将不知道与谁对话)——这是“WebSockets”中的“Web”部分。在消息报头中，客户端将请求服务器将连接升级到WebSocket。

3. 服务器发送一个握手响应，告诉客户端它将把协议从HTTP更改为WebSocket。

4. 客户端和服务器双方协商连接细节。任何一方都可以退出。

下面是一个典型的打开(客户端)握手请求的样子。

GET /ws-endpoint HTTP/1.1Host: example.com:80Upgrade: websocketConnection: UpgradeSec-WebSocket-Key: L4kHN+1Bx7zKbxsDbqgzHw==Sec-WebSocket-Version: 13

注意客户端是如何在请求中发送Connection: Upgrade和Upgrade: websocket报头的。

并且，服务器握手响应。

HTTP/1.1 101 Switching ProtocolsUpgrade: websocketConnection: UpgradeSec-WebSocket-Accept: CTPN8jCb3BUjBjBtdjwSQCytuBo=

数据传输

我们需要理解的下一个关键概念是数据传输。任何一方都可以在任何给定的时间发送消息——因为它是一个全双工通信协议。

消息由一个或多个帧组成。帧的类型可以是文本(UTF-8)、二进制和控制帧(例如0x8 (Close)、0x9 (Ping)和0xA (Pong))。

安装

让我们付诸行动，看看它是如何工作的。

首先创建一个 ASP.NET 5 WebAPI 项目。

dotnet new webapi -n WebSocketsTutorialdotnet new slndotnet sln add WebSocketsTutorial

现在添加SignalR到项目中。

dotnet add WebSocketsTutorial/ package Microsoft.AspNet.SignalR

示例代码

我们首先将WebSockets中间件添加到我们的WebAPI应用程序中。打开Startup.cs，向Configure方法添加下面的代码。

在本教程中，我喜欢保持简单。因此，我不打算讨论SignalR。它将完全基于WebSocket通信。你也可以用原始的WebSockets实现同样的功能，如果你想让事情变得更简单，你不需要使用SignalR。

app.UseWebSockets();

接下来，我们将删除默认的WeatherForecastController，并添加一个名为WebSocketsController的新控制器。注意，我们将只是使用一个控制器action，而不是拦截请求管道。

这个控制器的完整代码如下所示。

using System;using System.Net.WebSockets;using System.Text;using System.Threading;using System.Threading.Tasks;using Microsoft.AspNetCore.Mvc;using Microsoft.Extensions.Logging;namespace WebSocketsTutorial.Controllers{    [ApiController]    [Route("[controller]")]    public class WebSocketsController : ControllerBase    {        private readonly ILogger<WebSocketsController> _logger;
        public WebSocketsController(ILogger<WebSocketsController> logger)        {            _logger = logger;        }
        [HttpGet("/ws")]        public async Task Get()        {          if (HttpContext.WebSockets.IsWebSocketRequest)          {              using var webSocket = await HttpContext.WebSockets.AcceptWebSocketAsync();              _logger.Log(LogLevel.Information, "WebSocket connection established");              await Echo(webSocket);          }          else          {              HttpContext.Response.StatusCode = 400;          }        }                private async Task Echo(WebSocket webSocket)        {            var buffer = new byte[1024 * 4];            var result = await webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), CancellationToken.None);            _logger.Log(LogLevel.Information, "Message received from Client");
            while (!result.CloseStatus.HasValue)            {                var serverMsg = Encoding.UTF8.GetBytes($"Server: Hello. You said: {Encoding.UTF8.GetString(buffer)}");                await webSocket.SendAsync(new ArraySegment<byte>(serverMsg, 0, serverMsg.Length), result.MessageType, result.EndOfMessage, CancellationToken.None);                _logger.Log(LogLevel.Information, "Message sent to Client");
                result = await webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), CancellationToken.None);                _logger.Log(LogLevel.Information, "Message received from Client");                            }            await webSocket.CloseAsync(result.CloseStatus.Value, result.CloseStatusDescription, CancellationToken.None);            _logger.Log(LogLevel.Information, "WebSocket connection closed");        }    }}

这是我们所做的。

1、添加一个名为ws/的新路由。

2、检查当前请求是否通过WebSockets，否则抛出400。

3、等待，直到客户端发起请求。

4、进入一个循环，直到客户端关闭连接。

5、在循环中，我们将发送“Server: Hello. You said: <client’s message>”信息，并把它发回给客户端。

6、等待，直到客户端发送另一个请求。

注意，在初始握手之后，服务器不需要等待客户端发送请求来将消息推送到客户端。让我们运行应用程序，看看它是否工作。

dotnet run --project WebSocketsTutorial

运行应用程序后，请访问https://localhost:5001/swagger/index.html，应该看到Swagger UI。

现在我们将看到如何让客户端和服务器彼此通信。在这个演示中，我将使用Chrome的DevTools(打开新标签→检查或按F12→控制台标签)。但是，你可以选择任何客户端。

首先，我们将创建一个到服务器终结点的WebSocket连接。

let webSocket = new WebSocket('wss://localhost:5001/ws');

它所做的是，在客户端和服务器之间发起一个连接。wss://是WebSockets安全协议，因为我们的WebAPI应用程序是通过TLS服务的。

然后，可以通过调用webSocket.send()方法发送消息。你的控制台应该类似于下面的控制台。

让我们仔细看看WebSocket连接

如果转到Network选项卡，则通过WS选项卡过滤掉请求，并单击最后一个称为WS的请求。

单击Messages选项卡并检查来回传递的消息。在此期间，如果调用以下命令，将能够看到“This was sent from the Client!”。试试吧!

webSocket.send("Client: Hello");

如你所见，服务器确实需要等待客户端发送响应(即在初始握手之后)，并且客户端可以发送消息而不会被阻塞。这是全双工通信。我们已经讨论了WebSocket通信的数据传输方面。作为练习，你可以运行一个循环将消息推送到客户机，以查看它的运行情况。

除此之外，服务器和客户端还可以通过ping-pong来查看客户端是否还活着。这是WebSockets中的一个实际特性!如果你真的想看看这些数据包，你可以使用像WireShark这样的工具来了解。

它是如何握手的?好吧，如果你跳转到Headers选项卡，你将能够看到我们在这篇文章的第一部分谈到的请求-响应标题。

也可以尝试一下webSocket.close()，这样我们就可以完全覆盖open-data-close循环了。

结论

如果你对WebSocket的RFC感兴趣，请访问RFC 6455并阅读。这篇文章只是触及了WebSocket的表面，还有很多其他的东西我们可以讨论，比如安全，负载平衡，代理等等。

本文分享自微信公众号 - 码农译站（gh_c0d62fbb4bda）。
如有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一起分享。

微信关注我们

原文链接：https://my.oschina.net/u/3375879/blog/4976632

转载内容版权归作者及来源网站所有！

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

云原生专场免费报名中！听技术大咖在线分享实践案例

云原生在近几年的发展越来越火热，这一为云上最佳实践而生的设计理念，有了越来越多的实践案例：对资源的极致利用，对系统的精细把控，对效能的有力提升，对云边端的一体追求……这一个又一个云原生案例的背后，是无声的巨大变革。 2021年3月13日14:00--17:30，「云+社区技术沙龙」云原生专场正式拉开帷幕，聚焦当下云原生落地案例，为大家展现云原生一线实践：云原生微服务架构下的全链路追踪、高性能云原生数据湖的打造、Serverless 带来的软件研发效能变革、边缘计算场景下云边端一体化。展望未来，云原生又会将我们带向何方？云+社区特邀腾讯云原生首席架构师-张峻、腾讯云最具价值专家（TVP）& 中国信通院云计算部副主任-陈屹力、腾讯云最具价值专家（TVP）& VMware首席架构师-张海宁三位大咖出席圆桌对话，从技术人的视角，为大家深度剖析云原生的过去、当下和未来。添加小助手微信回复「沙龙」，提前加入沙龙交流群

2021-03-10

700

你好，我是最近写累了的 yes。面霸系列第二篇来了，满满当当 31 题。上一篇面霸我看阅读完成率就 34.53%，不知道这篇能有多少，因为这篇比那篇还长。所以我先把一些话放到开头来说，哈哈，别急就一小段。同样所有的答案都是我的原创，能延伸的我都延伸了，估计有不少错别字，这篇和上篇合成 pdf 的时候我再校对一下。如果发现有错误或者错别字的请联系我，感激不尽。好了，gogogo！ 21.Exception 和 Error 的区别知道吗？ Exception 是程序正常运行过程中可以预料到的意外情况，应该被开发者捕获并且进行相应的处理。 Error 是指在正常情况下不太可能出现的情况，绝大部分的 Error 都会导致程序处于不正常、不可恢复的状态，也就是挂了。所以不便也不需被开发者捕获，因为这个情况下你捕获了也无济于事。 Exception和Error都是继承了Throwable类，在Java代码中只有继承了Throwable类的实例才可以被throw或者被catch。随便我再提一提异常处理的注意点，之前写过文章总结过：尽量不要捕获类似Exception这样通用的异常，而...

2021-03-08

565

资源下载

更多资源

优质分享App

近一个月的开发和优化，本站点的第一个app全新上线。该app采用极致压缩，本体才4.36MB。系统里面做了大量数据访问、缓存优化。方便用户在手机上查看文章。后续会推出HarmonyOS的适配版本。

Mario

马里奥是站在游戏界顶峰的超人气多面角色。马里奥靠吃蘑菇成长，特征是大鼻子、头戴帽子、身穿背带裤，还留着胡子。与他的双胞胎兄弟路易基一起，长年担任任天堂的招牌角色。

Spring

Spring框架（Spring Framework）是由Rod Johnson于2002年提出的开源Java企业级应用框架，旨在通过使用JavaBean替代传统EJB实现方式降低企业级编程开发的复杂性。该框架基于简单性、可测试性和松耦合性设计理念，提供核心容器、应用上下文、数据访问集成等模块，支持整合Hibernate、Struts等第三方框架，其适用范围不仅限于服务器端开发，绝大多数Java应用均可从中受益。

Sublime Text

Sublime Text具有漂亮的用户界面和强大的功能，例如代码缩略图，Python的插件，代码段等。还可自定义键绑定，菜单和工具栏。Sublime Text 的主要功能包括：拼写检查，书签，完整的 Python API ， Goto 功能，即时项目切换，多选择，多窗口等等。Sublime Text 是一个跨平台的编辑器，同时支持Windows、Linux、Mac OS X等操作系统。