10. SignalR 組態設定

2019鐵人賽 signalr asp.net core

Homura

2018-10-23 19:28:56

3893 瀏覽

先來碎碎念一下，昨天gitpage一直有問題，害我git push好幾次，後來發現repo裡的文件是新的沒錯，今天一看又好了，真是的浪費我快30分鐘

今天來講講SignalR的組態設定，組態有分Server組態和用戶組態2種，就來看看怎麼設定吧！

Server組態設定

主要在Starup.cs裡面設定，可以對全部Hub設定，也能只對一個Hub設定。

全部Hub設定

services.AddSignalR(options =>
{
    options.HandshakeTimeout = TimeSpan.FromMinutes(3);
    options.KeepAliveInterval = TimeSpan.FromHours(1);
    options.EnableDetailedErrors = true;
});

單一Hub設定

services.AddSignalR().AddHubOptions<ChatHub>(options =>
{
    options.HandshakeTimeout = TimeSpan.FromMinutes(3);
    options.KeepAliveInterval = TimeSpan.FromHours(1);
    options.EnableDetailedErrors = true;
});

可設定變數

名稱	解釋
HandshakeTimeout	初次建立連線的時間，超過時間User端都沒回應會建立連線失敗，其實這命名正是WebSocket的握手，時間使用`TimeSpan`設定
KeepAliveInterval	無傳送訊息持，會ping Server以保持連線的時間，一樣使用`TimeSapn`設定
EnableDetailedErrors	是否顯示錯誤詳細狀況，預設是false，建議只有開發時打開就好

傳輸和記憶體緩衝相關設定

這邊文件寫得不太清楚，文件只說設定會傳到委派MapHub，後來實際做時發現MapHub原來有2個變數，一個就是傳入HttpConnectionDispatcherOptions的設定，設定方法一樣是Starup.cs裡面，大概像下面這樣

routes.MapHub<ChatHub>("/chatHub", options =>
{
    options.WebSockets.CloseTimeout = TimeSpan.FromMilliseconds(500);
    options.ApplicationMaxBufferSize = 0;
    options.TransportMaxBufferSize = 0;
}

選項很多請看結尾的的官方文件

用戶端組態設定

在用戶端部分有分成.NET和JS2種，.NET版文件在MSDN文件是用WPF當範例，因為他不跨平台，所以這邊先不介紹。

JS用戶端

設定方式是在建立後的HubConnection，在物件屬性中直接設定，例如像下面這段程式碼。

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

connection.serverTimeoutInMilliseconds = 500; // 設定500毫秒無回應，切斷連線

或是從一開始建立就設定好也行

var connection = new signalR.HubConnectionBuilder()
    .withUrl("/chatHub", {
        serverTimeoutInMilliseconds: 500
    })
    .build();

可以設定的選項如下

名稱	解釋
serverTimeoutInMilliseconds	連線無回應的時間限制
accessTokenFactory	驗證用的Bearer Token
skipNegotiation	跳過交涉的步驟，只支援WebSocket傳輸時