SignalR第一節-在5分鐘內完成通信連接和消息發送

来源:https://www.cnblogs.com/viter/archive/2019/03/14/10527566.html
-Advertisement-
Play Games

SignalR 這個項目我關註了很長時間,中間好像還看到過微軟即將放棄該項目的消息,然後我也就沒有持續關註了,目前的我項目中使用的是自己搭建的 WebSocket ...


前言

首先聲明,這又是一個小白從入門到進階系列。
SignalR 這個項目我關註了很長時間,中間好像還看到過微軟即將放棄該項目的消息,然後我也就沒有持續關註了,目前的我項目中使用的是自己搭建的 WebSocket ,連接管理和消息推送都是統一維護;前段時間編寫了 Asp.NETCore 輕鬆學系列,現在騰出了一點時間,抱著學習的心態,想把自己學習 SignalR 的過程寫出來,就當筆記吧,再做筆記的過程中再加入實際的項目需求,一步一步的深入學習 SignalR ,正所謂技多不壓身吧。有想要一起學習的同學,可以關註我,大家一起學習,一起進步。

SignalR 簡單介紹

根據官方文檔介紹,SignalR 是一個面向開發人員的庫,其本質是對 Web實時連接(WebSocket) 的抽象和封裝,使用 SIgnalR,可以避免自己編寫和管理Web實時連接,並獲得更多客戶端的相容性,截止本文發文為止,SignalR npm 包的版本是 @aspnet/signalr-1.1.2,在 Asp.NETCore 中,SignalR 不支持自動重連,如果客戶端連接斷開,必須顯示重連。話不多說,下麵就開始乾吧。

1.項目搭建

1.1 搭建 Asp.NETCore 項目基架

本 SignalR 示例基於 .NETCore-2.2 ,所以,我們還是先搭建一個簡單的 Asp.NETCore WebApplication

選擇 .NETCore-2.2 ,取消 Https 選擇,因為如果選擇 Https 還需要安裝測試證書,為了時間,就別勾選了。

項目創建完成,什麼也別做,按下 F5 運行網站,看到如下界面

好的,運行沒有問題,我們現在先停止網站,做一些簡單的編碼工作

1.2 引用 SignalR for JavaScript 客戶端 SDK

由於 .NETCore 內置了 SignalR 組件,我們無需額外引用服務組件,但是需要手動添加 SignalR JavaScript 客戶端 SDK,按下圖指示添加客戶端引用:

  • 在彈出的對話框中輸入 @aspnet/[email protected] 並選擇“選擇特定文件”選項,手動選擇兩個文件 signalr.js/signalr.min.js,註意不要選擇預設,否則安裝全部組件太浪費時間,對話框中“目標位置”就是 signalr.js/signalr.min.js 的安裝位置,預設為 @aspnet/signalr,這裡需要手動改成 /lib/signalr/xxx 下麵

耐心等待幾秒後安裝完成...

2. 編寫通訊業務邏輯

為了實現一個簡單的群發通訊過程,我們需要分別編寫伺服器和客戶端的代碼,值得慶幸的是,這些代碼非常簡單,伺服器和客戶端的代碼一共不到 100 行。

2.1 編寫服務端代碼

伺服器端的代碼如下,創建一個 類 WeChatHub 繼承自 Hub 類即可,為了方便演示,我還重寫了 Hub 的兩個方法 OnConnectedAsync(連接)/OnDisconnectedAsync(斷開)

 public class WeChatHub : Hub
    {
        public void Send(MessageBody body)
        {
            Clients.All.SendAsync("Recv", body);
        }

        public override Task OnConnectedAsync()
        {
            Console.WriteLine("哇,有人進來了:{0}", this.Context.ConnectionId);
            return base.OnConnectedAsync();
        }

        public override Task OnDisconnectedAsync(Exception exception)
        {
            Console.WriteLine("靠,有人跑路了:{0}", this.Context.ConnectionId);
            return base.OnDisconnectedAsync(exception);
        }
    }

 public class MessageBody
    {
        public int Type { get; set; }
        public string UserName { get; set; }
        public string Content { get; set; }
    }

上面這段代碼非常簡單,WeChatHub 類 只有一個方法 Send,表示消息入口,其參數接收一個實體類 MessageBody ,這種寫法非常有用,後續文章會介紹;現在,先讓我們集中精力完成一個群發通信。

2.2 配置 SignalR ,進行依賴註入
 public void ConfigureServices(IServiceCollection services)
        {
            services.AddSignalR();
            ...
        }
2.3 配置 SignalR 路由地址
 public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            app.UseSignalR(routes =>
            {
                routes.MapHub<WeChatHub>("/wechatHub");
            });
            ...
        }
  • 到這裡,伺服器基架已搭建完成
2.4 編寫客戶端代碼

為了在 Web 瀏覽器中使用 SignalR,我們編寫了一小段 js 代碼到文件 wechat.js,並將其和 signalr.js 引入到 Html 頁面中,客戶端 wechat.js 代碼如下:

"use strict";

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

connection.on("Recv", function (data) {
    var li = document.createElement("li");
    li = $(li).text(data.userName + ":" + data.content)
    $("#msgList").append(li);
});

connection.start()
    .then(function () {
        console.log("SignalR 已連接");
    }).catch(function(err) {
        console.log(err);
    });

$(document).ready(function () {
    $("#btnSend").on("click", () => {
        var userName = $("#userName").val();
        var content = $("#content").val();
        console.log(userName + ":" + content);
        connection.invoke("send", { "Type": 0, "UserName": userName, "Content": content });
    });
});

這段代碼需要稍微解釋一下。首先,創建了一個 SignalR 的 connection 對象,緊接著,馬上使用 connection 綁定了一個事件,該事件的名稱和伺服器 Send 方法中第一個參數的值相呼應,通過這種綁定,客戶端就可以接收到伺服器推送過來的消息,反之,通過 connection.invoke("send",xxx),也可以將消息發送到伺服器端的 Send 方法中

3. 測試消息推送

為了直觀的演示通訊的過程,我簡單寫了一點 Html 樣式代碼(並非我所擅長),首先我們來看看 SignalR 的連接過程,定位到項目根目錄,使用 dotnet run 啟動服務,看到如下畫面:

3.1 啟動服務

3.2 查看 SignalR 連接過程

輸入網站: http://localhost:5000/ 訪問網站,看到如下畫面紅框處,表示連接成功

看看伺服器的輸出內容

3.3 開始發送消息

為了演示消息過程,我們分別打開兩個瀏覽器視窗,模擬兩個人在群聊,同時,把他們的消息列印到網頁上,最終效果圖如下

非常完美,現在所有通過 http://localhost:5000 地址訪問該站點的人,都可以同時收到其它人發送的消息了。

結束語

開篇已結束,關於 SignalR 的原理性內容,在開篇文章中不會涉及,快速上手才有興趣深入,這和談戀愛好像有點不同,逃~;下一篇將在本文的基礎上,加入一些實際應用上的內容,最終,完成一個可以商業應用的例子,本系列的所有代碼都會托管到 GitHub,歡迎大家下載和 Star,感謝您的點贊!

演示代碼下載

https://github.com/lianggx/Examples/tree/master/SignalR/Ron.SignalRLesson1


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

-Advertisement-
Play Games
更多相關文章
  • 0.前言 前段時間在做javafx的應用程式,遇到一些坑。以本文記錄之。(如有更好的解決辦法歡迎評論,本人小白,輕噴) 1.問題 按照官方的中文文檔,成功的運行了單一界面的表單登錄。於是想自己試試多界面跳轉,給按鈕添加事件響應。可是怎麼操作都報錯,百度了許久沒有解決辦法。後來Google後找到了一個 ...
  • 題意 "鏈接" Sol 生成函數題都好神仙啊qwq 我們考慮枚舉一個長度$len$。有一個結論是如果我們按$N len$的餘數分類,若同一組內的全為$0$或全為$1$(?不算),那麼存在一個長度為$len$的border。 有了這個結論後我們考慮這樣一種做法:把序列看成兩個串$a, b$,若$a_i ...
  • 前言 Python 的代碼風格由 PEP 8 描述。這個文檔描述了 Python 編程風格的方方面面。在遵守這個文檔的條件下,不同程式員編寫的 Python 代碼可以保持最大程度的相似風格。這樣就易於閱讀,易於在程式員之間交流。 我們大家在學習Python的時候,好像很多人都不理解為什麼在方法(me ...
  • 一. 字元編碼 python是一門 動態 解釋性 強類型定義 語言 ASCII碼:最多標識255個 GB2312-->GBK1.0-->GB18030 Unicode :2位元組 -->UTF-8 (表示英文 用一個位元組;表示中文 用3個位元組) python2中使用ASCII碼,不支持中文,若想表示中 ...
  • 前言: 人工智慧時代,python編程語言站在風口起飛,2018年7月的世界編程語言排行榜躍居於編程語言前三,2018年的IEEE頂級編程語言交互排行榜中Python屠榜,徹底火了python,也相繼讓更多的人投入到了編程大軍中。 那麼問題來了,沒有任何編程基礎,英語又不好,如何學習python編程 ...
  • 本文轉載自https://blog.csdn.net/xiaogeldx/article/details/87315081 鋪墊 數據表示方式 電腦使用二進位作為自己的機器語言也就是數據的表示方式,因為電腦最小的計算單元是根據開關狀態高低電平來確定的,它只有開和關,高和低的概念,換成數學就是0和 ...
  • 分頁簡介 分頁功能在網頁中是非常常見的一個功能,其作用也就是將數據分割成多個頁面來進行顯示。 使用場景: 當取到的數據量達到一定的時候,就需要使用分頁來進行數據分割。 當我們不使用分頁功能的時候,會面臨許多的問題: 客戶端的問題: 如果數據量太多,都顯示在同一個頁面的話,會因為頁面太長嚴重影響到用戶 ...
  • 第1節. 關鍵字 馳騁工作流引擎 流程快速開發平臺 workflow ccflow jflow .net開源工作流 第2節. 從表數據導入設置 在從表的使用中我一般都會用到從資料庫引入一些數據到表單中,這時候就需要有一個功能能夠查詢出指定的數據展現給客戶去選擇一條或多條引入到從表中。 1.1.2打開 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...