溫馨提示×
您好，登錄后才能下訂單哦！
點(diǎn)擊 登錄注冊(cè) 即表示同意《億速云用戶服務(wù)條款》
您好，登錄后才能下訂單哦！
本篇文章主要講解ASP.NET SignalR的概述和用法。有一定的參考價(jià)值，有需要的朋友可以參考一下，話不多說(shuō)，一起往下看吧。
ASP.NET SignalR 是為 ASP.NET 開發(fā)人員提供的一個(gè)庫(kù)，可以簡(jiǎn)化開發(fā)人員將實(shí)時(shí) Web 功能添加到應(yīng)用程序的過(guò)程。實(shí)時(shí) Web 功能是指這樣一種功能：當(dāng)所連接的客戶端變得可用時(shí)服務(wù)器代碼可以立即向其推送內(nèi)容，而不是讓服務(wù)器等待客戶端請(qǐng)求新的數(shù)據(jù)。
SignalR當(dāng)然也提供了非常簡(jiǎn)單易用的高階API，使服務(wù)器端可以單個(gè)或批量調(diào)用客戶端上的JavaScript函數(shù)，并且非常 方便地進(jìn)行連接管理，例如客戶端連接到服務(wù)器端，或斷開連接，客戶端分組，以及客戶端授權(quán)，使用SignalR都非常 容易實(shí)現(xiàn)。
SignalR將與客戶端進(jìn)行實(shí)時(shí)通信帶給了ASP .NET 。當(dāng)然這樣既好用，而且也有足夠的擴(kuò)展性。以前用戶需要刷新頁(yè)面或使用Ajax輪詢才能實(shí)現(xiàn)的實(shí)時(shí)顯示數(shù)據(jù)，現(xiàn)在只要使用SignalR，就可以簡(jiǎn)單實(shí)現(xiàn)了。最重要的是您無(wú)需重新建立項(xiàng)目，使用現(xiàn)有ASP .NET項(xiàng)目即可無(wú)縫使用SignalR。
咋們先來(lái)看看測(cè)試用例的效果吧，這里是線上效果鏈接：神牛聊天室(:1001/home/shenniuchat)，效果圖：
界面及其簡(jiǎn)單，樣式這里就不考慮了，主要是展示其用法，這里涉及到的功能有：
1. 統(tǒng)計(jì)在線人數(shù)量
2. 顯示在線人數(shù)的昵稱和連接方式（本測(cè)試用例支持webSockets和longPolling(長(zhǎng)連接)）
3. 群聊信息
首先，我們平常做法創(chuàng)建MVC的Web項(xiàng)目，然后通過(guò)Nuget控制臺(tái)命令： Install-package Microsoft.AspNet.SignalR 加入SignalR的依賴，自動(dòng)添加的包如下：
<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" />
并且自動(dòng)往MVC項(xiàng)目中的Script文件夾中增加相關(guān)的js文件：
jquery.signalR-2.2.2.min.js jquery.signalR-2.2.2.js
然后，我們需要在項(xiàng)目一級(jí)目錄創(chuàng)建一個(gè)文件名稱為Startup.cs的類，里面主要內(nèi)容補(bǔ)全不下：
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 }首先我們從上往下分析注意點(diǎn)：
1. OwinStartup(Type) 構(gòu)造函數(shù)傳遞的是一個(gè)類型，而這個(gè)類型對(duì)應(yīng)的就是我們創(chuàng)建的Startup類，這個(gè)通過(guò)這個(gè)構(gòu)造函數(shù)類標(biāo)記起始位置；
2. namespace Stage.Api.Extend 是我項(xiàng)目的命名空間，這個(gè)可以隨便定義；
3. public void Configuration(IAppBuilder app) 函數(shù)是固定必須的，這里程序會(huì)首先進(jìn)入這個(gè)方法執(zhí)行里面的邏輯代碼；
4. app.MapSignalR 是擴(kuò)展的IAppBuilder接口方法，他有多種表現(xiàn)形式，這里我選擇的是 public static IAppBuilder MapSignalR(this IAppBuilder builder, string path, HubConfiguration configuration); ，這里看有點(diǎn)類似于咋們MVC的路由，這里主要注意的是這個(gè)Path參數(shù)，在前端頁(yè)面的時(shí)候需要用到這個(gè)路徑；
到這里后臺(tái)需要的配置其實(shí)已經(jīng)就完成了，下面是具體需要操作的業(yè)務(wù)邏輯處理類，新建一個(gè)類(這里我取名為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 /// 發(fā)送信息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 /// 某個(gè)聊天人退出是，通知所有在線人重新加載聊天人數(shù)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個(gè)方法分別做了：添加聊天人到List，發(fā)送信息到客戶端，某個(gè)連接失效后通知各個(gè)有效的聊天人重新加載信息；這里值得關(guān)注的是通過(guò)重新 public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled) 方法來(lái)實(shí)現(xiàn)捕獲并移除失效連接（這里是聊天人的信息）;整篇測(cè)試用例通過(guò)Context.ConnectionId來(lái)保證連接的唯一性，只要有新的鏈接請(qǐng)求，那么服務(wù)端就會(huì)分配一個(gè)唯一串給這個(gè)鏈接，當(dāng)客戶端關(guān)閉頁(yè)面或關(guān)閉鏈接這個(gè)是有就能在OnDisconnected方法中捕獲到這個(gè)失效的鏈接的ConnectionId，這樣就達(dá)到了移除失效聊天人的要求了；為了代碼的方便性，這里創(chuàng)建了一個(gè)聊天人信息類：
1 public class MoHubUser2 {3 4 public string Id { get; set; }5 public string NickName { get; set; }6 public string TransportMethod { get; set; }7 }到這里后臺(tái)的聊天室代碼就完成了就是這么簡(jiǎn)單；我們?cè)賮?lái)看試圖中如何來(lái)寫代碼，這里我先給出我的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 <h4>@ViewBag.Title 在線人數(shù)：<span id="sapnUserTotal">0</span>人</h4>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="發(fā) 送" 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>*@客戶端這里寫法大致有兩種選擇，一種直接使用生成的代理來(lái)操作，一種不用自動(dòng)生成的代理采用手動(dòng)創(chuàng)建代理的方式；為了內(nèi)容的簡(jiǎn)潔性，這里只簡(jiǎn)單講解下自動(dòng)生成的代理方式，而更多的是分享手動(dòng)創(chuàng)建代理鏈接的方式；
首先，我們需要通過(guò)Script標(biāo)簽來(lái)引用一下自動(dòng)生成代理的路徑： <script src="~/chat/hubs"></script> ，注意啦這里的路徑/chat對(duì)應(yīng)的就是咋們?cè)谇懊鍿tartup.cs文件中配置 app.MapSignalR("/chat" 路徑，而后面/hubs固定的寫法(至少目前我還沒(méi)更多的試驗(yàn)過(guò))，只有先應(yīng)用了這個(gè)~/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("鏈接聊天室失敗，請(qǐng)重新刷新頁(yè)面。");30 //});咋們逐步來(lái)解析下代碼注意點(diǎn)：
1. var chat = $.connection.chatHub; 這里的chatHub對(duì)應(yīng)的就是咋們創(chuàng)建的并繼承Hub的ChatHub類，由于js變量開頭都是小寫，所以這里是chatHub，這句活就表示鏈接到咋們后端了ChatHub類了，然后就可以使用里面的方法啦（這種有點(diǎn)類似于早期的webform中某種ajax請(qǐng)求的寫法）
2. 通過(guò)chat.client.xxx來(lái)接收服務(wù)端通知的消息，而這個(gè)xxx對(duì)應(yīng)的方法名稱和咋們后端的Clients.All.xxx，本章實(shí)例對(duì)應(yīng)的是：chat.client.userList = function (users){}對(duì)應(yīng)Clients.All.userList(_Users);這樣后端就能直接通知客戶端的對(duì)應(yīng)方法了；注意這里我后端Clients.All用的是通知全部客戶端的意思，如果您需要通知指定的鏈接需要用到的是： T Client(string connectionId); 方法
3. chat.client是后端調(diào)用客戶端，那相對(duì)的chat.server就是客戶端請(qǐng)求服務(wù)端，和上面一樣通過(guò)chat.server.xxx來(lái)指定請(qǐng)求的服務(wù)端方法，注意這個(gè)時(shí)候服務(wù)端方法指的是繼承類Hub的子類的公共方法（本篇對(duì)應(yīng)的是：chat.server.sendAll(my, content)對(duì)應(yīng)ChatHub.cs文件中的 public void SendAll(MoHubUser user, string message) 函數(shù)）
4. connection.hub.start({ transport: ['webSockets', 'longPolling'] }) 來(lái)指定運(yùn)行的交互協(xié)議
以上就是使用生成代理的方式，按照上面的注意點(diǎn)來(lái)寫應(yīng)該不是問(wèn)題；
不采用生成的代碼的方式，我們只需要修改前端就行了，后臺(tái)代碼不用變或設(shè)置不用變動(dòng)；首先我們把上面說(shuō)的Script引用自動(dòng)代理的代碼去掉，因?yàn)檫@個(gè)時(shí)候不需要了，我們還是先上代碼：
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("請(qǐng)輸入一個(gè)昵稱：", 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 });同樣列出如下注意點(diǎn)：
1. var connection = $.hubConnection("/chat/hubs"); 創(chuàng)建鏈接，這里的path同樣對(duì)應(yīng)后端的 app.MapSignalR("/chat" ，路徑保持一致
2. var chat = connection.createHubProxy('chatHub'); 來(lái)創(chuàng)建反向代理鏈接，這里的name：chatHub對(duì)應(yīng)的是后端的ChatHub類名稱
3. 通過(guò)on("xxx",function(){})函數(shù)來(lái)綁定服務(wù)端通知客戶端的事件，xxx對(duì)應(yīng)Clients.All.xxx中的xxx
4. connection.start({ transport: ['webSockets', 'longPolling'] }) 來(lái)設(shè)置允許的鏈接方式，并開始鏈接
5. connection.transport.name來(lái)獲取鏈接的方式名稱，默認(rèn)start不設(shè)置的話有這么幾種：webSockets，foreverFrame，serverSentEvents，longPolling
6. chat.invoke("xxx", param1, param2)通過(guò)invoke來(lái)映射繼承類Hub的類的公共方法，這里實(shí)例對(duì)應(yīng)的是： chat.invoke("sendAll", my, content) 對(duì)應(yīng) public void SendAll(MoHubUser user, string message)
看完上述內(nèi)容，你們對(duì)ASP.NET SignalR及其用法大概了解了嗎？如果想了解更多相關(guān)文章內(nèi)容，歡迎關(guān)注億速云行業(yè)資訊頻道，感謝各位的閱讀！
免責(zé)聲明：本站發(fā)布的內(nèi)容（圖片、視頻和文字）以原創(chuàng)、轉(zhuǎn)載和分享為主，文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱：is@yisu.com進(jìn)行舉報(bào)，并提供相關(guān)證據(jù)，一經(jīng)查實(shí)，將立刻刪除涉嫌侵權(quán)內(nèi)容。
億速云公眾號(hào)
手機(jī)網(wǎng)站二維碼