SignalR來做實時Web聊天

来源:http://www.cnblogs.com/wangrudong003/archive/2017/06/01/6929870.html
-Advertisement-
Play Games

本章和大家分享的內容是使用Signal R框架創建個簡易的群聊功能，主要講解如何在.Net的MVC中使用這個框架，由於這個項目有官方文檔（當然全英文），後面也不打算寫分享篇了，主要目的是讓朋友們在需要使用Web實時通信的時候有更多一種解決方案，畢竟這是微軟主推的一種解決方案之一。 SignalR網上 ...


本章和大家分享的內容是使用Signal R框架創建個簡易的群聊功能，主要講解如何在.Net的MVC中使用這個框架，由於這個項目有官方文檔（當然全英文），後面也不打算寫分享篇了，主要目的是讓朋友們在需要使用Web實時通信的時候有更多一種解決方案，畢竟這是微軟主推的一種解決方案之一。

SignalR網上簡介

ASP.NET SignalR 是為 ASP.NET 開發人員提供的一個庫，可以簡化開發人員將實時 Web 功能添加到應用程式的過程。實時 Web 功能是指這樣一種功能：當所連接的客戶端變得可用時伺服器代碼可以立即向其推送內容，而不是讓伺服器等待客戶端請求新的數據。

SignalR當然也提供了非常簡單易用的高階API，使伺服器端可以單個或批量調用客戶端上的JavaScript函數，並且非常 方便地進行連接管理，例如客戶端連接到伺服器端，或斷開連接，客戶端分組，以及客戶端授權，使用SignalR都非常 容易實現。

SignalR將與客戶端進行實時通信帶給了ASP .NET 。當然這樣既好用，而且也有足夠的擴展性。以前用戶需要刷新頁面或使用Ajax輪詢才能實現的實時顯示數據，現在只要使用SignalR，就可以簡單實現了。最重要的是您無需重新建立項目，使用現有ASP .NET項目即可無縫使用SignalR。

群聊實例效果

咋們先來看看測試用例的效果吧，這裡是線上效果鏈接：神牛聊天室(http://lovexins.com:1001/home/shenniuchat)，效果圖：

界面及其簡單，樣式這裡就不考慮了，主要是展示其用法，這裡涉及到的功能有：

1. 統計線上人數量

2. 顯示線上人數的昵稱和連接方式（本測試用例支持webSockets和longPolling(長連接)）

3. 群聊信息

MVC中如何使用SignalR

首先，我們平常做法創建MVC的Web項目，然後通過Nuget控制台命令： Install-package Microsoft.AspNet.SignalR 加入SignalR的依賴，自動添加的包如下：

  <package id="Microsoft.AspNet.SignalR" version="2.2.2" targetFramework="net45" />
  <package id="Microsoft.AspNet.SignalR.Core" version="2.2.2" targetFramework="net45" />
  <package id="Microsoft.AspNet.SignalR.JS" version="2.2.2" targetFramework="net45" />
  <package id="Microsoft.AspNet.SignalR.SystemWeb" version="2.2.2" targetFramework="net45" />

並且自動往MVC項目中的Script文件夾中增加相關的js文件：

jquery.signalR-2.2.2.min.js
jquery.signalR-2.2.2.js

然後，我們需要在項目一級目錄創建一個文件名稱為Startup.cs的類，裡面主要內容補全不下：

 1 [assembly: OwinStartup(typeof(Stage.Api.Extend.Startup))]
 2 namespace Stage.Api.Extend
 3 {
 4     public class Startup
 5     {
 6         public void Configuration(IAppBuilder app)
 7         {
 8             app.MapSignalR("/chat", new Microsoft.AspNet.SignalR.HubConfiguration
 9             {
10                 EnableDetailedErrors = true,
11                 EnableJavaScriptProxies = true
12             });
13         }
14     }
15 }

首先我們從上往下分析註意點：

1.  OwinStartup(Type) 構造函數傳遞的是一個類型，而這個類型對應的就是我們創建的Startup類，這個通過這個構造函數類標記起始位置；

2.  namespace Stage.Api.Extend 是我項目的命名空間，這個可以隨便定義；

3.  public void Configuration(IAppBuilder app) 函數是固定必須的，這裡程式會首先進入這個方法執行裡面的邏輯代碼；

4.  app.MapSignalR 是擴展的IAppBuilder介面方法，他有多種表現形式，這裡我選擇的是 public static IAppBuilder MapSignalR(this IAppBuilder builder, string path, HubConfiguration configuration); ，這裡看有點類似於咋們MVC的路由，這裡主要註意的是這個Path參數，在前端頁面的時候需要用到這個路徑；

到這裡後臺需要的配置其實已經就完成了，下麵是具體需要操作的業務邏輯處理類，新建一個類(這裡我取名為ChatHub)並繼承Hub(這是SignalR框架提供)，然後裡面的邏輯代碼如下：

 1 public class ChatHub : Hub
 2     {
 3         //
 4         public int Num = 10001;
 5         public static List<MoHubUser> _Users = new List<MoHubUser>();
 6 
 7         /// <summary>
 8         /// 添加聊天人
 9         /// </summary>
10         /// <param name="user"></param>
11         public void AddUser(MoHubUser user)
12         {
13 
14             user.Id = Context.ConnectionId;
15             if (!_Users.Any(b => b.Id == user.Id))
16             {
17                 _Users.Add(user);
18             }
19 
20             //Clients.All.newUser(user);
21             Clients.All.userList(_Users);
22         }
23 
24         /// <summary>
25         /// 發送信息
26         /// </summary>
27         /// <param name="user"></param>
28         /// <param name="message"></param>
29         public void SendAll(MoHubUser user, string message)
30         {
31             Clients.All.addNewMessageToPage(user, message);
32         }
33 
34         /// <summary>
35         /// 某個聊天人退出是，通知所有線上人重新載入聊天人數
36         /// </summary>
37         /// <param name="stopCalled"></param>
38         /// <returns></returns>
39         public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled)
40         {
41             var user = _Users.SingleOrDefault(x => x.Id == Context.ConnectionId);
42             if (user != null)
43             {
44                 _Users.Remove(user);
45                 Clients.All.userList(_Users);
46             }
47             return base.OnDisconnected(stopCalled);
48         }
49     }

上面的3個方法分別做了：添加聊天人到List，發送信息到客戶端，某個連接失效後通知各個有效的聊天人重新載入信息；這裡值得關註的是通過重新 public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled) 方法來實現捕獲並移除失效連接（這裡是聊天人的信息）;整篇測試用例通過Context.ConnectionId來保證連接的唯一性，只要有新的鏈接請求，那麼服務端就會分配一個唯一串給這個鏈接，當客戶端關閉頁面或關閉鏈接這個是有就能在OnDisconnected方法中捕獲到這個失效的鏈接的ConnectionId，這樣就達到了移除失效聊天人的要求了；為了代碼的方便性，這裡創建了一個聊天人信息類：

1  public class MoHubUser
2     {
3 
4         public string Id { get; set; }
5         public string NickName { get; set; }
6         public string TransportMethod { get; set; }
7     }

到這裡後臺的聊天室代碼就完成了就是這麼簡單；我們再來看試圖中如何來寫代碼，這裡我先給出我的html佈局代碼：

 1 @{
 2     ViewBag.Title = "神牛聊天室 - SignalR";
 3 }
 4 <style type="text/css">
 5     .div_left {
 6         width: 70%;
 7         float: left;
 8     }
 9 
10     .div_right {
11         width: 28%;
12         float: left;
13     }
14 
15     .ul {
16         list-style: none;
17         border: 1px solid #ccc;
18         height: 500px;
19         overflow-y: scroll;
20         color: black;
21     }
22 
23         .ul li {
24             padding-top: 5px;
25             padding-right: 25px;
26         }
27 
28     .ul_user {
29         list-style: none;
30     }
31 
32         .ul_user li {
33             padding-top: 5px;
34         }
35 
36     .send {
37         position: relative;
38         background: #eae7e7;
39         border-radius: 5px; /* 圓角 */
40         padding-top: 4px;
41         padding-left: 5px;
42         margin-top: 13px;
43     }
44 
45         .send .arrow {
46             position: absolute;
47             top: -16px;
48             font-size: 0;
49             border: solid 8px;
50             border-color: #fff #fff #eae7e7 #fff;
51         }
52 </style>
53 <h3>@ViewBag.Title 線上人數：<span id="sapnUserTotal">0</span>人</h3>
54 <div class="container text-left">
55     <div class="div_left">
56         <ul class="ul" id="discussion"></ul>
57         <textarea rows="5" class="form-control" id="message" maxlength="500" placeholder="開始聊天. . ." style="max-width: 100%"></textarea><br />
58         <input type="button" id="sendmessage" value="發 送" class="btn btn-default" />
59         <input type="hidden" id="displayname" />
60     </div>
61     <div class="div_right">
62         <ul id="users" class="ul_user"></ul>
63     </div>
64 </div>
65 
66 <script src="~/Scripts/jquery.signalR-2.2.2.min.js"></script>
67 @*<script src="~/chat/hubs"></script>*@

客戶端這裡寫法大致有兩種選擇，一種直接使用生成的代理來操作，一種不用自動生成的代理採用手動創建代理的方式；為了內容的簡潔性，這裡只簡單講解下自動生成的代理方式，而更多的是分享手動創建代理鏈接的方式；

使用生成的代理獲取鏈接

首先，我們需要通過Script標簽來引用一下自動生成代理的路徑： <script src="~/chat/hubs"></script> ，註意啦這裡的路徑/chat對應的就是咋們在前面Startup.cs文件中配置 app.MapSignalR("/chat" 路徑，而後面/hubs固定的寫法(至少目前我還沒更多的試驗過)，只有先應用了這個~/chat/hubs，才能在後面使用生成的代理，先上段代碼：

 1  var chat = $.connection.chatHub;
 2         chat.client.newUser = function (user) {
 3             $("#users").append(' <li><strong>' + user.NickName + '[' + user.TransportMethod + ']</strong></li>');
 4         };
 5 
 6         chat.client.userList = function (users) {
 7             console.log(users);
 8             $("#sapnUserTotal").html(users.length);
 9             $.each(users, function (i, item) {
10                 $("#users").append(' <li>[' + item.TransportMethod + '] <strong>' + item.NickName + '</strong>(' + item.Id + ')</li>');
11             });
12         };
13         chat.client.addNewMessageToPage = function (user, message) {
14             console.log(user);
15             $("#discussion").append(' <li ><span><strong>' + user.NickName + '[' + user.TransportMethod + ']</strong>：</span><div class="send">' + message + '<div class="arrow"></div></div></li>');
16         };
17    //connection.hub.start({ transport: ['webSockets', 'longPolling'] }).done(function () {
18         //    my.TransportMethod = connection.hub.transport.name;
19         //    chat.server.addUser(my);
20 
21         //    $('#sendmessage').click(function () {
22         //        //console.log(chat);
23         //        var content = $.trim($('#message').val());
24         //        if (content.length <= 0) { $('#message').val('').focus(); return; }
25         //        chat.server.sendAll(my, content);
26         //        $('#message').val('').focus();
27         //    });
28         //}).fail(function () {
29         //    alert("鏈接聊天室失敗，請重新刷新頁面。");
30         //});

咋們逐步來解析下代碼註意點：

1.  var chat = $.connection.chatHub; 這裡的chatHub對應的就是咋們創建的並繼承Hub的ChatHub類，由於js變數開頭都是小寫，所以這裡是chatHub，這句活就表示鏈接到咋們後端了ChatHub類了，然後就可以使用裡面的方法啦（這種有點類似於早期的webform中某種ajax請求的寫法）

2. 通過chat.client.xxx來接收服務端通知的消息，而這個xxx對應的方法名稱和咋們後端的Clients.All.xxx，本章實例對應的是：chat.client.userList = function (users){}對應Clients.All.userList(_Users);這樣後端就能直接通知客戶端的對應方法了；註意這裡我後端Clients.All用的是通知全部客戶端的意思，如果您需要通知指定的鏈接需要用到的是： T Client(string connectionId); 方法

3. chat.client是後端調用客戶端，那相對的chat.server就是客戶端請求服務端，和上面一樣通過chat.server.xxx來指定請求的服務端方法，註意這個時候服務端方法指的是繼承類Hub的子類的公共方法（本篇對應的是：chat.server.sendAll(my, content)對應ChatHub.cs文件中的 public void SendAll(MoHubUser user, string message) 函數）

4.  connection.hub.start({ transport: ['webSockets', 'longPolling'] }) 來指定運行的交互協議

以上就是使用生成代理的方式，按照上面的註意點來寫應該不是問題；

使用手動創建反向代理來鏈接

不採用生成的代碼的方式，我們只需要修改前端就行了，後臺代碼不用變或設置不用變動；首先我們把上面說的Script引用自動代理的代碼去掉，因為這個時候不需要了，我們還是先上代碼：

 1 var my = { NickName: "神牛001", TransportMethod: "" };
 2         var connection = $.hubConnection("/chat/hubs");
 3         var chat = connection.createHubProxy('chatHub');
 4 
 5         chat.on("userList", function (users) {
 6             console.log(users);
 7             $("#sapnUserTotal").html(users.length);
 8             $("#users").html("");
 9             $.each(users, function (i, item) {
10                 $("#users").append(' <li>[' + item.TransportMethod + '] <strong>' + item.NickName + '</strong>(' + item.Id + ')</li>');
11             });
12         });
13 
14         chat.on("addNewMessageToPage", function (user, message) {
15             console.log(user);
16             $("#discussion").append(' <li ><span><strong>' + user.NickName + '[' + user.TransportMethod + ']</strong>：</span><div class="send">' + message + '<div class="arrow"></div></div></li>');
17 
18             var div = document.getElementById('discussion');
19             //div.scrollTop = div.scrollHeight;
20             div.scrollTop = 999999;
21         });
22 
23         var nickName = prompt("請輸入一個昵稱：", my.NickName);
24         my.NickName = nickName.length > 0 ? nickName : my.NickName;
25         $('#displayname').val(nickName);
26         $('#message').focus();
27      
28 
29         connection.start({ transport: ['webSockets', 'longPolling'] }).done(function () {
30 
31             my.TransportMethod = connection.transport.name;
32             //console.log(my.TransportMethod);
33             chat.invoke("addUser", my);
34 
35             $('#sendmessage').click(function () {
36                 var content = $.trim($('#message').val());
37                 if (content.length <= 0) { $('#message').val('').focus(); return; }
38 
39                 chat.invoke("sendAll", my, content);
40                 $('#message').val('').focus();
41             });
42         });

同樣列出如下註意點：

1.  var connection = $.hubConnection("/chat/hubs"); 創建鏈接，這裡的path同樣對應後端的 app.MapSignalR("/chat" ，路徑保持一致

2.  var chat = connection.createHubProxy('chatHub'); 來創建反向代理鏈接，這裡的name：chatHub對應的是後端的ChatHub類名稱

3. 通過on("xxx",function(){})函數來綁定服務端通知客戶端的事件，xxx對應Clients.All.xxx中的xxx

4.  connection.start({ transport: ['webSockets', 'longPolling'] }) 來設置允許的鏈接方式，並開始鏈接

5. connection.transport.name來獲取鏈接的方式名稱，預設start不設置的話有這麼幾種：webSockets，foreverFrame，serverSentEvents，longPolling

6. chat.invoke("xxx", param1, param2)通過invoke來映射繼承類Hub的類的公共方法，這裡實例對應的是： chat.invoke("sendAll", my, content) 對應 public void SendAll(MoHubUser user, string message) 

寫在最後

到此如果滿足以上註意點，那麼基本SignalR就能鏈接使用成功了，註意點比較多不過都是總結的經驗，希望多朋友們有幫助；在寫本文的時候剛好有朋友在看我git開源的LovePicture.Web項目，據說他們也將開始嘗試在公司中使用Netcore來構建應用，我為此感到榮幸也高興，榮幸能夠把我項目當做範例，高興是NetCore也越來越有影響力了哈哈；如果覺得本篇還可以，或給您收穫，不妨點個推薦，謝謝！！！


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

-Advertisement-
Play Games
更多相關文章
  • C# 集合類
    ARRAYLIST 集合類 Remove方法從Arraylist中移除一個元素，Arraylist重新排序，Remove（value）、RemoveAt（index） Add（value）在Arraylist尾部加入值 Insert（para1,para2）第一個參數為要加入的位置 (加入para2 ...
  • csharp:SMO run sql script
    https://www.codeproject.com/Tips/873677/SQL-Server-Database-Backup-and-Restore-in-Csharp https://www.codeproject.com/Articles/162684/SMO-Tutorial-of-n ...
  • JqueryEasyUI $.Parser
    Parser（解析器） 對象的屬性和方法： 使用： $.parser.auto = false; $.parser.plugins = ["", "", "layout"]; $.parser.onComplete = function () { ... ...
  • Less學習筆記
    視頻教程地址：http://www.imooc.com/learn/102 一、什麼是Less css的Less好比是js的Jquery，可以讓人們更方遍快捷的使用css，使css代碼更簡潔，可以減少重覆的代碼，減少開發人員的工作量。 Less CSS是一種動態樣式語言，屬於CSS預處理語言的一種， ...
  • IdentityServer4 指定角色授權（Authorize(Roles="admin"))
    1. 業務場景 IdentityServer4 授權配置 中的 ，設置的是具體的 API 站點名字，也就是使用方設置的 ，示例代碼： 上面兩個 配置要一致，問題來了，因為授權中心的 配置是整個 API 服務，如果我們存在多個 配置，比如一個前臺和後臺，然後都需要訪問 ，就會出現一些問題。 比如， 服 ...
  • winform 信息管理系統
    完成效果： 解釋： 主視窗是MDI視窗，視窗中有子視窗，子視窗中控制項有 樹形圖treeview、panel控制項、listview控制項(這是一個視窗中的listview)、butten控制項。 功能： 單擊樹形圖中的”員工管理“ panel中會顯示listview數據 其他功能暫時沒寫。。。。。。 主窗 ...
  • ASP.NET Core 指定環境發佈（hosting environment）
    ASP.NET Core 應用程式發佈命令： 發佈示例命令（生成在 目錄下）： 上面命令並沒有指定 發佈，什麼意思呢？比如 ASP.NET Core 應用程式中的 配置，測試環境和生產環境配置並不相同（比如資料庫連接字元串），如果用上面的發佈命令，我們還需要手動拷貝下不同環境的 文件，以後要更改了， ...
  • .net開源許可權管理系統
    源碼支持QQ 1039318332 源碼地址:http://git.oschina.net/sunzewei/EIP 一、更新記錄1、更新日期：2017-02-24 00:00:002、更新內容： 版本升級:V2.0 1、支持多資料庫,可在實體類指定具體操作資料庫,可實現系統分庫操作 2、重新整理架 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 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 ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類