SignalR

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

SignalR基於這三種技術構建, 抽象於它們之上, 它讓你更好的關注業務問題而不是底層傳輸技術問題.

SignalR這個框架分伺服器端和客戶端, 伺服器端支援ASP.NET Core 和 ASP.NET; 而客戶端除了支援瀏覽器裡的javascript以外, 也支援其它型別的客戶端, 例如桌面應用.

回落機制

SignalR使用的三種底層傳輸技術分別是Web Socket, Server Sent Events 和 Long Polling.

其中Web Socket僅支援比較現代的瀏覽器, Web伺服器也不能太老.

而Server Sent Events 情況可能好一點, 但是也存在同樣的問題.

所以SignalR採用了回落機制, SignalR有能力去協商支援的傳輸型別.

Web Socket是最好的最有效的傳輸方式, 如果瀏覽器或Web伺服器不支援它的話, 就會降級使用SSE, 實在不行就用Long Polling.

一旦建立連線, SignalR就會開始傳送keep alive訊息, 來檢查連線是否還正常. 如果有問題, 就會丟擲異常.

因為SignalR是抽象於三種傳輸方式的上層, 所以無論底層採用的哪種方式, SignalR的用法都是一樣的.

SignalR預設採用這種回落機制來進行傳輸和連線.

但是也可以禁用回落機制, 只採用其中一種傳輸方式.

RPC

RPC (Remote Procedure Call). 它的優點就是可以像呼叫本地方法一樣呼叫遠端服務.

SignalR採用RPC正規化來進行客戶端與伺服器端之間的通訊.

SignalR利用底層傳輸來讓伺服器可以呼叫客戶端的方法, 反之亦然, 這些方法可以帶引數, 引數也可以是複雜物件, SignalR負責序列化和反序列化.

Hub

Hub是SignalR的一個元件, 它執行在ASP.NET Core應用裡. 所以它是伺服器端的一個類.

Hub使用RPC接受從客戶端發來的訊息, 也能把訊息傳送給客戶端. 所以它就是一個通訊用的Hub.

在ASP.NET Core裡, 自己建立的Hub類需要繼承於基類Hub.

在Hub類裡面, 我們就可以呼叫所有客戶端上的方法了. 同樣客戶端也可以呼叫Hub類裡的方法.

這種Hub+RPC的方式還是非常適合實時場景的.

之前說過方法呼叫的時候可以傳遞複雜引數, SignalR可以將引數序列化和反序列化. 這些引數被序列化的格式叫做Hub 協議, 所以Hub協議就是一種用來序列化和反序列化的格式.

Hub協議的預設協議是JSON, 還支援另外一個協議是MessagePack. MessagePack是二進位制格式的, 它比JSON更緊湊, 而且處理起來更簡單快速, 因為它是二進位制的.

此外, SignalR也可以擴充套件使用其它協議..

橫向擴充套件

隨著系統的執行, 有時您可能需要進行橫向擴充套件. 就是應用執行在多個伺服器上.

這時負載均衡器會保證每個進來的請求按照一定的邏輯分配到可能是不同的伺服器上.

在使用Web Socket的時候, 沒什麼問題, 因為一旦Web Socket的連線建立, 就像在瀏覽器和那個伺服器之間打開了隧道一樣, 伺服器是不會切換的.

但是如果使用Long Polling, 就可能有問題了, 因為使用Long Polling的情況下, 每次傳送訊息都是不同的請求, 而每次請求可能會到達不同的伺服器. 不同的伺服器可能不知道前一個伺服器通訊的內容, 這就會造成問題.

針對這個問題, 我們需要使用Sticky Sessions (粘性會話).

Sticky Sessions 貌似有很多中實現方式, 但是主要是下面要介紹的這種方式.

作為第一次請求的響應的一部分, 負載均衡器會在瀏覽器裡面設定一個Cookie, 來表示使用過這個伺服器. 在後續的請求裡, 負載均衡器讀取Cookie, 然後把請求分配給同一個伺服器. 

在ASP.NET Core 中使用SignalR

建立專案

使用空模板建立ASP.NET Core專案.

建立一個CountService:

建立一個CountHub, 繼承於Hub:

配置SignalR

在Startup裡註冊SignalR:

如果需要的話可以在AddSignalR()這個方法裡使用lambda表示式進行一些配置.

然後在管道里使用SignalR, 使用app.UseSignalR():

這裡我已經建立了一個Hub, 叫做CountHub.

該方法的引數型別是Action<HubRouteBuilder>, 然後在這裡配置hub的路由.

使用Hub

首先建立一個Controller, 並注入IHubContext<CountHub>:

接下來我們就可以使用IHubContext<CountHub>這個物件與客戶端進行實時通訊了.

下面建立一個POST Action, 客戶端點選按鈕之後來到這個Action, 在這裡我們使用hub為所有的客戶端傳送一個訊息:

這裡, 我呼叫了所有客戶端上的someFunc這個方法, 引數是一個物件.

但是使用這種IHubContext<Hub>的注入方式, 我們無法在它那取得Caller(呼叫該方法的客戶端)這個屬性.

Context

從Hub的Context屬性, 我們可以獲得使用者的資訊.

我們在CountHub裡override父類的一個方法OnConnectedAsync():

如果有新的連線建立了, 這個方法就會被執行.

在Hub類裡, 我們可以訪問到Context屬性. 從Context屬性那, 我們可以獲得一個常用的屬性叫做ConnectionId. 這個ConnectionId就是連線到Hub的這個客戶端的唯一標識.

使用ConnectionId, 我們就可以取得這個客戶端, 並呼叫其方法, 如圖中的Clients.Client(connectionId).xxx.

Hub的Clients屬性表示客戶端, 它有若干個方法可以選擇客戶端, 剛才的Client(connectionId)就是使用connectionId找到這一個客戶端. 而AllExcept(connectionId)就是除了這個connectionId的客戶端之外的所有客戶端. 更多方法請檢視文件.

SignalR還有Group分組的概念, 而且操作簡單, 這裡用到的是Hub的Groups屬性. 向一個Group名新增第一個connectionId的時候, 分組就被建立. 移除分組內最後一個客戶端的時候, 分組就被刪除了. 使用Clients.Group("組名")可以呼叫組內客戶端的方法.

授權和驗證

SignalR會採用ASP.NET Core配置好的授權和驗證體系.

用法和Controller差不多:

想要取得User物件, 需要使用Context.User, 它的型別是ClaimsPrinciple:

客戶端

客戶端需要安裝signalr這個庫. 可以使用npm安裝 @aspnet/signalr

但是實際上只需要signalr.js一個檔案即可.

客戶端程式碼如下:

 

點選按鈕後先執行Controller的POST方法, POST返回的是Accepted(1), 所以id是1.

使用singalR物件的HubConnectionBuilder來構建connection. 使用返回的connection物件, 我們可以用它的on方法來處理伺服器端方法呼叫的響應. 響應方法的引數可以是簡單型別也可以是複雜的物件.

使用connection.start()來開啟連線, 使用catch()來捕獲異常, 使用connection.stop() 關閉連線.

先執行一下看看效果:

可以看到使用Clients.All, 所有的客戶端的方法都會被呼叫.

剛開啟頁面的時候, 我們就嘗試建立連線, 從F12可以看到一個叫做negotiate的請求被髮送了:

這個請求的body如下:

可以看到客戶端選擇了一個connectionId,  裡面還有瀏覽器支援的傳輸方式.

伺服器的響應:

響應也包含著connectionId, 以及伺服器支援的傳輸方式. 這裡三種都支援. 由於我沒有指定傳輸方式, 所以SignalR選擇了最好的方式: websocket.

而在我點選按鈕後, Web Socket連線才被初始化:

如果需要手動指定傳輸方式, 請在withUrl()方法的第二個引數指定傳輸方式: 

其它型別的客戶端

.NET 客戶端可以安裝 Microsoft.AspNetCore.SignalR.Client 這個包來支援SignalR.

具體用法請檢視官方文件, 語法和js的差不多.

MessagePack協議

需要安裝 Microsoft.AspNetCore.SignalR.Protocols.MessagePack.

然後在Startup裡面使用AddMessagePackProtocol()這個方法即可:

這樣的話, 伺服器端既支援JSON, 也支援MessagePack了.

另外.NET客戶端也需要安裝這個MessagePack包.

而js客戶端需要安裝 @aspnet/signalr-protocol-msgpack.

橫向擴充套件 Scale-out

可以採用Redis, 需要安裝 Microsoft.AspNetCore.SignalR.Redis. 這個包.

然後在Startup裡面配置:

這個沒試過, 請看官方文件.

SignalR就介紹這些....