本章和你們分享的內容是使用Signal R框架建立個簡易的羣聊功能，主要講解如何在.Net的MVC中使用這個框架，因爲這個項目有官方文檔（固然全英文），後面也不打算寫分享篇了，主要目的是讓朋友們在須要使用Web實時通訊的時候有更多一種解決方案，畢竟這是微軟主推的一種解決方案之一。css
SignalR網上簡介
ASP.NET SignalR 是爲 ASP.NET 開發人員提供的一個庫，能夠簡化開發人員將實時 Web 功能添加到應用程序的過程。實時 Web 功能是指這樣一種功能：當所鏈接的客戶端變得可用時服務器代碼能夠當即向其推送內容，而不是讓服務器等待客戶端請求新的數據。html
SignalR固然也提供了很是簡單易用的高階API，使服務器端能夠單個或批量調用客戶端上的JavaScript函數，而且很是 方便地進行鏈接管理，例如客戶端鏈接到服務器端，或斷開鏈接，客戶端分組，以及客戶端受權，使用SignalR都很是 容易實現。前端
SignalR將與客戶端進行實時通訊帶給了ASP .NET 。固然這樣既好用，並且也有足夠的擴展性。之前用戶須要刷新頁面或使用Ajax輪詢才能實現的實時顯示數據，如今只要使用SignalR，就能夠簡單實現了。最重要的是您無需從新創建項目，使用現有ASP .NET項目便可無縫使用SignalR。jquery
羣聊實例效果
咋們先來看看測試用例的效果吧，這裏是線上效果連接：神牛聊天室(http://lovexins.com:1001/home/shenniuchat)，效果圖：git
界面及其簡單，樣式這裏就不考慮了，主要是展現其用法，這裏涉及到的功能有：github
1. 統計在線人數量web
2. 顯示在線人數的暱稱和鏈接方式（本測試用例支持webSockets和longPolling(長鏈接)）ajax
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也愈來愈有影響力了哈哈；若是以爲本篇還能夠，或給您收穫，不妨點個推薦，謝謝！！！