ASP.NET Core SignalR中的流式傳輸深入講解
前言
什么是流式傳輸?
流式傳輸是這一種以穩(wěn)定持續(xù)流的形式傳輸數(shù)據(jù)的技術(shù)。
流式傳輸?shù)氖褂脠鼍?/strong>
有些場景中,服務(wù)器返回的數(shù)據(jù)量較大,等待時間較長,客戶端不得不等待服務(wù)器返回所有數(shù)據(jù)后,再進行相應(yīng)的操作。這時候使用流式傳輸,可以將服務(wù)器數(shù)據(jù)碎片化,當(dāng)每個數(shù)據(jù)碎片讀取完成之后,就只傳輸完成的部分,而不需要等待所有數(shù)據(jù)都讀取完成。
SignalR
SignalR是一個.NET Core/.NET Framework的開源實時框架. SignalR的可使用Web Socket, Server Sent Events 和 Long Polling作為底層傳輸方式.
SignalR基于這三種技術(shù)構(gòu)建, 抽象于它們之上, 它讓你更好的關(guān)注業(yè)務(wù)問題而不是底層傳輸技術(shù)問題.
SignalR這個框架分服務(wù)器端和客戶端, 服務(wù)器端支持ASP.NET Core 和 ASP.NET; 而客戶端除了支持瀏覽器里的javascript以外, 也支持其它類型的客戶端, 例如桌面應(yīng)用.
如何在ASP.NET Core SignalR中啟用流式傳輸
在ASP.NET Core SignalR中當(dāng)一個Hub方法的返回值是ChannelReader或者Task<ChannelReader>, 這個Hub方法自動就會變成一個流式傳輸Hub方法。
下面我們來做了一個簡單的例子
創(chuàng)建一個ASP.NET Core Web應(yīng)用
首先我們使用Visual Studio 2017創(chuàng)建一個ASP.NET Core Web應(yīng)用程序。
選擇創(chuàng)建ASP.NET Core 2.1的Web Application
創(chuàng)建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是一個流式傳輸方法, 它定義了一個延遲參數(shù)delay, 定義了推送數(shù)據(jù)碎片的間隔時間
- WriteItems是一個私有方法,它返回了一個Task對象
- WriteItems方法的最后一行writer.TryComplete()表明了流式傳輸完成
配置SignalR
首先我們在Startup類的ConfigureService方法中添加SignalR服務(wù)
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>\node_modules@aspnet\signalr\dist\browser目錄中拷貝到wwwroot\lib\signalr目錄下
編寫頁面
拷貝以下代碼到Index.cshtml
@page @model IndexModel @{ ViewData["Title"] = "Home page"; } <div class="container"> <div class="row"> </div> <div class="row"> <div class="col-6"> </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"> </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)建一個新文件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不同,這里我們使用了不同的語法創(chuàng)建一個SignalR連接
var connection = new signalR.HubConnectionBuilder() .withUrl("/streamHub") .build();
對于一般的SignalR連接,我們會使用connection.on方法來添加監(jiān)聽器,但是在使用流式傳輸?shù)臅r候,我們需要改用connection.stream方法, 這個方法有2個參數(shù)
- Hub方法名稱, 本例中是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方法的返回對象中有一個subscribe方法,這個方法中可以注冊3個事件
- next - 獲得到一個數(shù)據(jù)碎片時執(zhí)行
- complete - 流式傳輸完成時執(zhí)行
- error - 流式傳輸異常時執(zhí)行
最終效果
總結(jié)
流式傳輸不是一個新概念,但是對ASP.NET Core SignalR來說,這是一個非常棒的特性。流式傳輸保證的用戶體驗的流暢,也降低了服務(wù)器壓力。
大部分程序員都知道SignalR不能傳輸過大的數(shù)據(jù),但是使用流式傳輸之后,客戶端不需要一次性等待服務(wù)器端返回所有數(shù)據(jù),所以如果你的項目單次請求的數(shù)據(jù)量很大,可以考慮使用SignalR的流式傳輸改善用戶體驗,減輕服務(wù)器壓力。
本篇源代碼地址 https://github.com/lamondlu/StreamingInSignalR (本地下載)
好了,以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。
相關(guān)文章
利用Timer在ASP.NET中實現(xiàn)計劃任務(wù)的方法
利用Timer在ASP.NET中實現(xiàn)計劃任務(wù)的方法...2007-04-04.net控件dropdownlist動態(tài)綁定數(shù)據(jù)具體過程分解
一、在頁面初始化時候?qū)⒓辖壎ǖ紻ropDownList;二、在頁面初始化的時候向DropDownList添加數(shù)據(jù);三、將DataReader讀取的數(shù)據(jù)動態(tài)綁定到DropDownList等等2013-05-05ASP.NET MVC3 實現(xiàn)全站重定向的簡單方法
這篇文章主要介紹了ASP.NET MVC3 實現(xiàn)全站重定向的簡單方法,有需要的朋友可以參考一下2014-01-01在ASP.Net?Core應(yīng)用程序中使用Bootstrap4
這篇文章介紹了在ASP.Net?Core應(yīng)用程序中使用Bootstrap4的方法,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-01-01asp.net 數(shù)據(jù)庫連接類代碼(SQL)
asp.net數(shù)據(jù)庫連接類(SQL) 代碼,需要的朋友可以參考下。2010-03-03ASP.NET技巧:同時對多個文件進行大量寫操作對性能優(yōu)化
ASP.NET技巧:同時對多個文件進行大量寫操作對性能優(yōu)化...2006-09-09