WebSocket In ASP.NET Core(一)

时间 2019-11-17 标签 websocket asp.net asp core 一

.NET-Core Series

Server in ASP.NET-Core
DI in ASP.NET-Core
Routing in ASP.NET-Core
Error Handling in ASP.NET-Core
WebSocket in ASP.NET-Core(一)
WebSocket in ASP.NET-Core(二)
To Be Continue...html

What Is WebSocket?

WebSocket 是一种在单个 TCP 链接上进行全双工通信的协议，是创建在TCP上、且独立的协议。在WebSocket API 中，浏览器和服务器只须要完成一次握手，二者之间就能够进行持久性的链接，并进行双向数据传输。前端

为了创建WebSocket 链接，浏览器经过 Http 1.1 协议的101 StatusCode 进行握手。git

如下是我本地的一个WebSocket 握手请求的例子：github

Client Request:web

GET ws://localhost:62713/ws HTTP/1.1
Host: localhost:62713
Connection: Upgrade
Pragma: no-cache
Cache-Control: no-cache
Upgrade: websocket
Origin: http://localhost:62713
Sec-WebSocket-Version: 13
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/61.0.3163.91 Safari/537.36
DNT: 1
Accept-Encoding: gzip, deflate, br
Accept-Language: en,zh-CN;q=0.8,zh;q=0.6,zh-TW;q=0.4
Sec-WebSocket-Key: aXo04R8eiNAZOIO1WJqXEQ==
Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits

Server Response:c#

HTTP/1.1 101 Switching Protocols
Connection: Upgrade
Date: Fri, 15 Sep 2017 03:10:05 GMT
Server: Kestrel
Upgrade: websocket
Sec-WebSocket-Accept: gmzB2zS5RSQhQT9LFZXZczHMjKQ=

一些关键字段的说明，浏览器

Connection 必须设置为 Upgrade，表示客户端但愿链接升级。
Upgrade 字段必须设置 Websocket，表示但愿升级到 Websocket 协议。
Sec-WebSocket-Key：是一个 Base 64 Encode 的值，服务端会用这些数据来构造出一个SHA-1 的信息摘要。以后进行 Base-64 编码，将结果做为 Sec-WebSocket-Accept 头的值，返回给客户端。

关键词：持久链接，持久化协议，全双工服务器

What Is This Article About?

这篇文章你会了解到的是 WebSocket 在.NET-Core 中的一些基础实现和实践，首先先以官方给出的WebSocket入门，而后再构建WebSocket中间件，最后会用WebSocket 来实现一个实时聊天的小Demo。websocket

Use WebSockets In ASP.NET Core

A Simple Explaination For Official Demo

首先以官方给出的WebSocket的例子入门，大体介绍一下。效果图大概就是下面这样的。app

就是我发什么信息，服务器就实时回复我什么信息。主要代码以下：首先要接受

// Configure function 
///Summary
// 这里主要是监听 WebSocket的请求，而后Invoke Echo 方法进行相关操做。好比，它接受到浏览器发来 WebSocket 的Close 命令了，那么在Echo 方法直接 await webSocket.CloseAsync(result.CloseStatus.Value... 相关操做
///Summary
app.Use(async (context, next) =>
            {
                if (context.Request.Path == "/ws")
                {
                    if (context.WebSockets.IsWebSocketRequest)
                    {
                        WebSocket webSocket = await context.WebSockets.AcceptWebSocketAsync();
                        await Echo(context, webSocket);
                    }
                    else
                    {
                        context.Response.StatusCode = 400;
                    }
                }
            });

//Echo function
 private async Task Echo(HttpContext context, WebSocket webSocket)
        {
            var buffer = new byte[1024 * 4];
            WebSocketReceiveResult result = await webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), CancellationToken.None);
            while (!result.CloseStatus.HasValue)
            {
                await webSocket.SendAsync(new ArraySegment<byte>(buffer, 0, result.Count), result.MessageType, result.EndOfMessage, CancellationToken.None);

                result = await webSocket.ReceiveAsync(new ArraySegment<byte>(buffer), CancellationToken.None);
            }
            await webSocket.CloseAsync(result.CloseStatus.Value, result.CloseStatusDescription, CancellationToken.None);
        }

前端使用 js 来发送WebSocket 请求，让咱们来看一下当我点击 Connect 时，到底发生了什么。下面用动图来演示一下。

是否是很熟悉，首先经过Http 发送101 ，转换协议，而后就进行WebSocket 通讯了。由于在前面已经介绍过了WebSocket的工做原理了。

若是把Echo 方法中 Send 方法的 buffer修改，你就能够本身设定想要的回馈，

var abuffer = Encoding.ASCII.GetBytes("Hola, This is robert from cnblogs.");
 await webSocket.SendAsync(new ArraySegment<byte>(abuffer, 0, abuffer.Length), result.MessageType, result.EndOfMessage, CancellationToken.None);
                result = await webSocket.ReceiveAsync(new ArraySegment<byte>(abuffer), CancellationToken.None);

结果就以下图所示这样：

官方的例子讲解就到这里了。能够本身动手实践一下。接下来说解如何基于上述的例子咱们来构建一个在线实时聊天系统。

Building Real-Time WebSocket Demo

效果图是下面这样的，

具体怎么实现的，下篇博文介绍。😄😄

End Of Article

若有陈述错误处，请多多指正。