SignalR簡介及用法介紹
- 零下一度原創
- 2017-06-24 10:45:184062瀏覽
本章和大家分享的內容是使用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.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 = 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标签来引用一下自动生成代理的路径： ，注意啦这里的路径/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也越來越有影響力了哈哈；如果覺得本篇還可以，或給您收穫，不妨點個推薦，謝謝！ ！ ！
以上是SignalR簡介及用法介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章！