东莞市盛裕绒艺玩具有限公司

东莞市盛裕绒艺玩具有限公司

德赢登陆

13595242667
联系方式
全国服务热线: 13595242667

咨询热线:15188201485
联系人:徐墨晗
地址:东风路19号

ASP.NET Core SignalR中的流式传输

来源:德赢登陆   发布时间:2019-06-23   点击量:486

什么是流式传输?

流式传输是这一种以稳定持续流的形式传输数据的技术。

流式传输的使用场景

有些场景中,服务器返回的数据量较大,等待时间较长,客户端不得不等待服务器返回所有数据后,再进行相应的操作。这时候使用流式传输,可以将服务器数据碎片化,当每个数据碎片读取完成之后,就只传输完成的部分,而不需要等待所有数据都读取完成。

如何在ASP.NET Core SignalR中启用流式传输

在ASP.NET Core SignalR中当一个Hub方法的返回值是ChannelReader或者Task<ChannelReader>, 这个Hub方法自动就会变成一个流式传输Hub方法。

下面我们来做了一个简单的例子

创建一个ASP.NET Core Web应用

首先我们使用Visual Studio 2017创建一个ASP.NET Core Web应用程序。

选择创建ASP.NET Core 2.1的Web Application

创建Hub

下面我们添加一个StreamHub类,代码如下

public class StreamHub : Hub{ public ChannelReader<int> DelayCounter(int delay) { var channel = Channel.CreateUnbounded<int>(); _ = WriteItems(channel.Writer, 20, delay); return channel.Reader; } private async Task WriteItems(ChannelWriter<int> writer, int count, int delay) { for (var i = 0; i < count; i++) { await writer.WriteAsync(i); await Task.Delay(delay); } writer.TryComplete(); }}DelayCounter是一个流式传输方法, 它定义了一个延迟参数delay, 定义了推送数据碎片的间隔时间WriteItems是一个私有方法,它返回了一个Task对象WriteItems方法的最后一行writer.TryComplete()表明了流式传输完成

配置SignalR

首先我们在Startup类的ConfigureService方法中添加SignalR服务

services.AddSignalR();

然后我们还需要为SignalR流添加路由,我们需要在Startup类的Configure方法中添加如下代码:

app.UseSignalR(routes =>{ routes.MapHub<StreamHub>("/streamHub");});

添加SignalR客户端脚本库

这一步中我们需要在客户端中添加SignalR JS库。

这里我们需要借助npm来下载SignalR JS库。

npm install @aspnet/signalr

安装完成后,我们手动将signalr.js从<projectfolder>ode_modules@aspnetsignalrdistrowser目录中拷贝到wwwrootlibsignalr目录下

编写页面

拷贝以下代码到Index.cshtml

@page@model IndexModel@{ ViewData["Title"] = "Home page";}<div > <div >&nbsp;</div> <div > <div >&nbsp;</div> <div > <input type="button" id="streamButton" value="Start Streaming" /> </div> </div> <div > <div > <hr /> </div> </div> <div > <div >&nbsp;</div> <div > <ul id="messagesList"></ul> </div> </div></div><script src="~/lib/signalr/signalr.js"></script><script src="~/js/signalrstream.js"></script>

JavaScript中启用流式传输

wwwrootjs目录中创建一个新文件signalrstream.js ,代码如下

var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { return new (P || (P = Promise))(function (resolve, reject) { function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); } step((generator = generator.apply(thisArg, _arguments || [])).next()); });};var connection = new signalR.HubConnectionBuilder() .withUrl("/streamHub") .build();document.getElementById("streamButton").addEventListener("click", (event) => __awaiter(this, void 0, void 0, function* () { try { connection.stream("DelayCounter", 500) .subscribe({ next: (item) => { var li = document.createElement("li"); li.textContent = item; document.getElementById("messagesList").appendChild(li); }, complete: () => { var li = document.createElement("li"); li.textContent = "Stream completed"; document.getElementById("messagesList").appendChild(li); }, error: (err) => { var li = document.createElement("li"); li.textContent = err; document.getElementById("messagesList").appendChild(li); }, }); } catch (e) { console.error(e.toString()); } event.preventDefault();}));(() => __awaiter(this, void 0, void 0, function* () { try { yield connection.start(); } catch (e) { console.error(e.toString()); }}))();

代码解释

与传统SignalR不同,这里我们使用了不同的语法创建一个SignalR连接

var connection = new signalR.HubConnectionBuilder() .withUrl("/streamHub") .build();

对于一般的SignalR连接,我们会使用connection.on方法来添加监听器,但是在使用流式传输的时候,我们需要改用connection.stream方法, 这个方法有2个参数

Hub方法名称, 本例中是DelayCounterHub方法的参数, 本例中是500

connection.stream("DelayCounter", 500) .subscribe({ next: (item) => { var li = document.createElement("li"); li.textContent = item; document.getElementById("messagesList").appendChild(li); }, complete: () => { var li = document.createElement("li"); li.textContent = "Stream completed"; document.getElementById("messagesList").appendChild(li); }, error: (err) => { var li = document.createElement("li"); li.textContent = err; document.getElementById("messagesList").appendChild(li); },});

connection.stream方法的返回对象中有一个subscribe方法,这个方法中可以注册3个事件

next - 获得到一个数据碎片时执行complete - 流式传输完成时执行error - 流式传输异常时执行

最终效果

总结

流式传输不是一个新概念,但是对ASP.NET Core SignalR来说,这是一个非常棒的特性。流式传输保证的用户体验的流畅,也降低了服务器压力。

大部分程序员都知道SignalR不能传输过大的数据,但是使用流式传输之后,客户端不需要一次性等待服务器端返回所有数据,所以如果你的项目单次请求的数据量很大,可以考虑使用SignalR的流式传输改善用户体验,减轻服务器压力。

本篇源代码地址 https://github.com/lamondlu/StreamingInSignalR

相关产品

COPYRIGHTS©2017 德赢登陆 ALL RIGHTS RESERVED 备案号:486