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。

群聊執行個體效果

咋們先來看看測試案例的效果吧，這裡是線上效果連結：神牛聊天室(: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.jsjquery.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 = true12             });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 MoHubUser2     {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'] }) 來指定啟動並執行互動協議

以上就是使用組建代理程式的方式，按照上面的注意點來寫應該不是問題；

使用手動建立反向 Proxy來連結

不採用產生的程式碼的方式，我們只需要修改前端就行了，後台代碼不用變或設定不用變動；首先我們把上面說的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'); 來建立反向 Proxy連結，這裡的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也越來越有影響力了哈哈；如果覺得本篇還可以，或給您收穫，不妨點個推薦，謝謝！！！