在 ASP.NET Core 中使用 SignalR

来源:http://www.cnblogs.com/oopsguy/archive/2017/10/30/7754674.html
-Advertisement-
Play Games

SignalR 是一個用於實現實時網站的 Microsoft .NET 庫。它使用多種技術來實現伺服器與客戶端間的雙向通信,伺服器可以隨時將消息推送到連接的客戶端。 ...


https://weblogs.asp.net/ricardoperes/signalr-in-asp-net-core
作者:Ricardo Peres
譯者:oopsguy.com

介紹

SignalR 是一個用於實現實時網站的 Microsoft .NET 庫。它使用多種技術來實現伺服器與客戶端間的雙向通信,伺服器可以隨時將消息推送到連接的客戶端。

它現在可在 ASP.NET Core 預發行版本中使用(譯者:根據原文的發佈時間)。我已經介紹過幾次 SignalR 了。

安裝

您將需要安裝 Microsoft.AspNetCore.SignalR.ClientMicrosoft.AspNetCore.SignalR Nuget 預發行包。此外,您將需要 NPM(Node 包管理器)。安裝 NPM 後,您需要獲取 @aspnet/signalr-client 包,之後您需要從 node_modules@aspnet\signalr-client\dist\browser 文件夾中 獲取 signalr-client-1.0.0-alpha1-final.js 文件(版本可能不同) ,並將其放置在 wwwroot 文件夾下,以便您可以從頁面引用到它。

接下來,我們需要在使用之前在 ConfigureServices 中註冊所需的服務:

services.AddSignalR();

我們將實現一個簡單的聊天客戶端,因此將在 Configure 方法中註冊一個 ChatHub:

app.UseSignalR(routes =>
{
    routes.MapHub<ChatHub>("chat");
});

註意:UseSignalR 必須在 UseMvc 之前調用!

如果你有不同的端點,可以為任意數量的 hub 執行此操作。

在您的視圖或佈局文件中,添加對 signalr-client-1.0.0-alpha1-final.js 文件的引用:

<script src="libs/signalr-client/signalr-client-1.0.0-alpha1-final.js"></script>

實現 Hub

該 hub 是一個繼承了 Hub 的類。您可在其中添加 JavaScript 可能調用到的方法。我們將實現一個 chat hub::

public class ChatHub : Hub
{
    public async Task Send(string message)
    {
        await this.Clients.All.InvokeAsync("Send", message);
    }
}

如你所見,我們有一個方法(Send),在這個例子中,它採用單個參數(message)。您不需要在廣播調用(InvokeAsync)上傳遞相同的參數,可以發送任何您想要的。

回到客戶端部分,在引用 SignalR JavaScript 文件後添加此代碼:

   <script>
     
        var transportType = signalR.TransportType.WebSockets;
        //can also be ServerSentEvents or LongPolling
        var logger = new signalR.ConsoleLogger(signalR.LogLevel.Information);
        var chatHub = new signalR.HttpConnection(`http://${document.location.host}/chat`, { transport: transportType, logger: logger });
        var chatConnection = new signalR.HubConnection(chatHub, logger);
     
        chatConnection.onClosed = e => {
            console.log('connection closed');
       };
    
       chatConnection.on('Send', (message) => {
           console.log('received message');
       });
    
       chatConnection.start().catch(err => {
           console.log('connection error');
       });
    
       function send(message) {
           chatConnection.invoke('Send', message);
       }
    
</script>

請註意:

  1. 創建指向當前 URL 的連接添加了 chat 尾碼,這與在 MapHub 中註冊的一致
  2. 它使用特定的傳輸進行初始化(本例中是 WebSockets),但這不是必需的,也就是說,您可以讓 SignalR 自己採用合適的方式。對於某些操作系統(如 Windows 7),您可能無法使用 WebSockets,因此您必須選擇 LongPollingServerSentEvents
  3. 需要通過調用 start 來初始化連接
  4. 有一個 Send 方法的 handler,它與 ChatHubSend 方法有相同的單個參數(message)

所以,每當有人訪問此頁面並調用 JavaScript send函數時,它將調用 ChatHub 類上的 Send 方法。 該類基本上會向所有連接的客戶端(Clients.All)廣播此消息。 也可以將消息發送到特定的組:

await this.Clients.Group("groupName").InvokeAsync("Send", message);

或特定客戶端:

await this.Clients.Client("id").InvokeAsync("Send", message);

如果使用身份驗證,您可以添加一個由連接 ID 和 ClaimPrincipal 標識的用戶,如下所示:

public override Task OnConnectedAsync()
{
    this.Groups.AddAsync(this.Context.ConnectionId, "groupName");

    return base.OnConnectedAsync();
}

是的,OnConnectedAsync 在新用戶連接時將被調用。當有人斷開連接時,OnDisconnectedAsync 將被調用:

public override Task OnDisconnectedAsync(Exception exception)
{
    return base.OnDisconnectedAsync(exception);
}

如果在斷開連接時發生一些異常,則 exception 參數將為非空值。
只有當前用戶進行身份驗證時 Context 屬性才會提供 ConnectionIdUser 兩個屬性。ConnectionId 始終被設置為同一個用戶,不會改變。
另一個例子,假設你想通過定時器 hub 將定時器 tick 發送到所有連接的客戶端。 您可以在 Configure 方法中執行此操作:

TimerCallback callback = (x) => {
    var hub = serviceProvider.GetService<IHubContext<TimerHub>>();
    hub.Clients.All.InvokeAsync("Notify", DateTime.Now);
};

var timer = new Timer(callback);
timer.Change(TimeSpan.FromSeconds(0), TimeSpan.FromSeconds(10));

我們啟動了一個 Timer,從那裡我們得到了一個定時器 hub 的引用,並使用當前時間戳調用其 Notify 方法。TimerHub 類只是這樣:

public class TimerHub : Hub
{
}

請註意,此類沒有公共方法,因為它不是由 JavaScript 調用,它僅用於從外部廣播消息(Timer 回調)。

將消息發送到 Hub

最後,還可以將消息從外部發送到 hub。當使用控制器時,您需要註入一個 IHubContext 實例,您可以從中發送消息到 hub,然後將其適當地廣播:

private readonly IHubContext<ChatHub> _context;

[HttpGet("Send/{message}")]
public IActionResult Send(string message)
{
    //for everyone
    this._context.Clients.All.InvokeAsync("Send", message);
    //for a single group
    this._context.Clients.Group("groupName").InvokeAsync("Send", message);
    //for a single client
    this._context.Clients.Client("id").InvokeAsync("Send", message);

    return this.Ok();
}

請註意,這與訪問 ChatHub 類不同,您無法簡單實現,需要通過 chat hub 的連接才行。

結論

SignalR 尚未發佈,仍可能會發生一些變化。在以後的文章中,我將更詳細地介紹 SignalR,包括其可擴展性機制和一些更高級的使用場景。敬請期待!


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 有時設計RDLC報表時,我們會少不了在報表呈現圖片。今天花上些少時間來實現它們:你可以在設計RDLC報表時,找到Report Data下的Image,按Mouse右鍵,出現Add Image...,如下: 選擇圖片: 接下來,我們就可以把添加的圖片,作為一個報表對象添加至報表。 在添加圖片時,有好幾 ...
  • 線程: 每個Windows進程都有用於進入程式的進入點(entry point)的主線程(Main Thread),例如.Net framework執行程式(控制台、Windows WPF等應用程式)使用Main()方法作為程式的進入點,調用該方法時會自動建立主線程。 線程是Windows進程中的獨 ...
  • 問題描述 主要解決DataTable數據轉化為JSON,從Controller傳遞數據給View的問題。 1 內容區 1 內容區 提供如下方法,僅供參考 2 版權區 2 版權區 感謝您的閱讀,若有不足之處,歡迎指教,共同學習、共同進步。 博主網址:http://www.cnblogs.com/wan ...
  • 聲明 文檔轉載自:http://www.cnblogs.com/liulun/archive/2013/02/26/2909985.html 在說LINQ之前必須先說說幾個重要的C#語言特性 一:與LINQ有關的語言特性 1.隱式類型 (1)源起 在隱式類型出現之前, 我們在聲明一個變數的時候, 總 ...
  • 之前就寫到。最近正在使用webapi。這裡介紹一個實用的東西swageer ui現在開發都是前後端分開。我們這裡是給前端提供api。有時候對於一個api的描述,並不想專門寫一份文檔。很浪費時間。swagger ui就是一個能整合到項目中讓api的註釋能夠生成到一個網頁上。能簡單測試和給前端看。開懟吧 ...
  • NuGet 是.NET程式員熟知的工具,它可以直接安裝開源社區中的各個公用組件,可以說是非常方便。不過,有些時候,公司內部的公用的基礎類庫,各個項目都有引用,但又不能發佈到公共的NuGet伺服器上,所以我們需要自己架設一個私有服務,通過NuGet 來的各個項目中用到的公共組件進行管理。就非常的方便。 ...
  • 在Sharepoint 2016上配置FBA(forms based authentication)的過程和Sharepoint 2013一樣。 第一步:創建Membership資料庫。 為了存放所有的用戶名和密碼,首選需要創建資料庫。Asp.Net自帶一款工具用以創建Membership資料庫,M ...
  • 演示產品的代碼,開源去近乎官網下載近乎免費源碼版。下載地址:http://www.jinhusns.com/Uploads/Release/bak/jinhu_V5.2.0.0_ym.zip ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...