快捷導(dǎo)航

ASP.NET Core SignalR中的流式傳輸深入講解

更新時(shí)間：2018年11月05日 11:33:05 作者：LamondLu

這篇文章主要給大家介紹了關(guān)于ASP.NET Core SignalR中流式傳輸?shù)南嚓P(guān)資料，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

前言

什么是流式傳輸？

流式傳輸是這一種以穩(wěn)定持續(xù)流的形式傳輸數(shù)據(jù)的技術(shù)。

流式傳輸?shù)氖褂脠?chǎng)景

有些場(chǎng)景中，服務(wù)器返回的數(shù)據(jù)量較大，等待時(shí)間較長(zhǎng)，客戶端不得不等待服務(wù)器返回所有數(shù)據(jù)后，再進(jìn)行相應(yīng)的操作。這時(shí)候使用流式傳輸，可以將服務(wù)器數(shù)據(jù)碎片化，當(dāng)每個(gè)數(shù)據(jù)碎片讀取完成之后，就只傳輸完成的部分，而不需要等待所有數(shù)據(jù)都讀取完成。

SignalR

SignalR是一個(gè).NET Core/.NET Framework的開(kāi)源實(shí)時(shí)框架. SignalR的可使用Web Socket, Server Sent Events 和 Long Polling作為底層傳輸方式.

SignalR基于這三種技術(shù)構(gòu)建, 抽象于它們之上, 它讓你更好的關(guān)注業(yè)務(wù)問(wèn)題而不是底層傳輸技術(shù)問(wèn)題.

SignalR這個(gè)框架分服務(wù)器端和客戶端, 服務(wù)器端支持ASP.NET Core 和 ASP.NET; 而客戶端除了支持瀏覽器里的javascript以外, 也支持其它類(lèi)型的客戶端, 例如桌面應(yīng)用.

如何在ASP.NET Core SignalR中啟用流式傳輸

在ASP.NET Core SignalR中當(dāng)一個(gè)Hub方法的返回值是ChannelReader或者Task<ChannelReader>, 這個(gè)Hub方法自動(dòng)就會(huì)變成一個(gè)流式傳輸Hub方法。

下面我們來(lái)做了一個(gè)簡(jiǎn)單的例子

創(chuàng)建一個(gè)ASP.NET Core Web應(yīng)用

首先我們使用Visual Studio 2017創(chuàng)建一個(gè)ASP.NET Core Web應(yīng)用程序。

選擇創(chuàng)建ASP.NET Core 2.1的Web Application

創(chuàng)建Hub

下面我們添加一個(gè)StreamHub類(lèi)，代碼如下

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是一個(gè)流式傳輸方法, 它定義了一個(gè)延遲參數(shù)delay, 定義了推送數(shù)據(jù)碎片的間隔時(shí)間
WriteItems是一個(gè)私有方法，它返回了一個(gè)Task對(duì)象
WriteItems方法的最后一行writer.TryComplete()表明了流式傳輸完成

配置SignalR

首先我們?cè)赟tartup類(lèi)的ConfigureService方法中添加SignalR服務(wù)

services.AddSignalR();

然后我們還需要為SignalR流添加路由，我們需要在Startup類(lèi)的Configure方法中添加如下代碼：

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

添加SignalR客戶端腳本庫(kù)

這一步中我們需要在客戶端中添加SignalR JS庫(kù)。

這里我們需要借助npm來(lái)下載SignalR JS庫(kù)。

npm install @aspnet/signalr

安裝完成后，我們手動(dòng)將signalr.js從<projectfolder>\node_modules@aspnet\signalr\dist\browser目錄中拷貝到wwwroot\lib\signalr目錄下

編寫(xiě)頁(yè)面

拷貝以下代碼到Index.cshtml

@page
@model IndexModel
@{
 ViewData["Title"] = "Home page";
}

<div class="container">
 <div class="row">&nbsp;</div>
 <div class="row">
 <div class="col-6">&nbsp;</div>
 <div class="col-6">
  <input type="button" id="streamButton" value="Start Streaming" />
 </div>
 </div>
 <div class="row">
 <div class="col-12">
  <hr />
 </div>
 </div>
 <div class="row">
 <div class="col-6">&nbsp;</div>
 <div class="col-6">
  <ul id="messagesList"></ul>
 </div>
 </div>
</div>
<script src="~/lib/signalr/signalr.js"></script>
<script src="~/js/signalrstream.js"></script>

JavaScript中啟用流式傳輸

在wwwroot\js目錄中創(chuàng)建一個(gè)新文件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());
 }
}))();

代碼解釋

與傳統(tǒng)SignalR不同，這里我們使用了不同的語(yǔ)法創(chuàng)建一個(gè)SignalR連接

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

對(duì)于一般的SignalR連接，我們會(huì)使用connection.on方法來(lái)添加監(jiān)聽(tīng)器，但是在使用流式傳輸?shù)臅r(shí)候，我們需要改用connection.stream方法, 這個(gè)方法有2個(gè)參數(shù)

Hub方法名稱(chēng), 本例中是DelayCounter
Hub方法的參數(shù), 本例中是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方法的返回對(duì)象中有一個(gè)subscribe方法，這個(gè)方法中可以注冊(cè)3個(gè)事件

next - 獲得到一個(gè)數(shù)據(jù)碎片時(shí)執(zhí)行
complete - 流式傳輸完成時(shí)執(zhí)行
error - 流式傳輸異常時(shí)執(zhí)行

最終效果

總結(jié)

流式傳輸不是一個(gè)新概念，但是對(duì)ASP.NET Core SignalR來(lái)說(shuō)，這是一個(gè)非常棒的特性。流式傳輸保證的用戶體驗(yàn)的流暢，也降低了服務(wù)器壓力。

大部分程序員都知道SignalR不能傳輸過(guò)大的數(shù)據(jù)，但是使用流式傳輸之后，客戶端不需要一次性等待服務(wù)器端返回所有數(shù)據(jù)，所以如果你的項(xiàng)目單次請(qǐng)求的數(shù)據(jù)量很大，可以考慮使用SignalR的流式傳輸改善用戶體驗(yàn)，減輕服務(wù)器壓力。

本篇源代碼地址 https://github.com/lamondlu/StreamingInSignalR （本地下載）

好了，以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，如果有疑問(wèn)大家可以留言交流，謝謝大家對(duì)腳本之家的支持。

您可能感興趣的文章: