新聞中心
本篇文章主要講解ASP.NET SignalR的概述和用法。有一定的參考價值,有需要的朋友可以參考一下,話不多說,一起往下看吧。
岳陽網(wǎng)站制作公司哪家好,找創(chuàng)新互聯(lián)公司!從網(wǎng)頁設計、網(wǎng)站建設、微信開發(fā)、APP開發(fā)、成都響應式網(wǎng)站建設公司等網(wǎng)站項目制作,到程序開發(fā),運營維護。創(chuàng)新互聯(lián)公司于2013年成立到現(xiàn)在10年的時間,我們擁有了豐富的建站經(jīng)驗和運維經(jīng)驗,來保證我們的工作的順利進行。專注于網(wǎng)站建設就選創(chuàng)新互聯(lián)公司。
SignalR網(wǎng)上簡介
ASP.NET SignalR 是為 ASP.NET 開發(fā)人員提供的一個庫,可以簡化開發(fā)人員將實時 Web 功能添加到應用程序的過程。實時 Web 功能是指這樣一種功能:當所連接的客戶端變得可用時服務器代碼可以立即向其推送內(nèi)容,而不是讓服務器等待客戶端請求新的數(shù)據(jù)。
SignalR當然也提供了非常簡單易用的高階API,使服務器端可以單個或批量調(diào)用客戶端上的JavaScript函數(shù),并且非常 方便地進行連接管理,例如客戶端連接到服務器端,或斷開連接,客戶端分組,以及客戶端授權,使用SignalR都非常 容易實現(xiàn)。
SignalR將與客戶端進行實時通信帶給了ASP .NET 。當然這樣既好用,而且也有足夠的擴展性。以前用戶需要刷新頁面或使用Ajax輪詢才能實現(xiàn)的實時顯示數(shù)據(jù),現(xiàn)在只要使用SignalR,就可以簡單實現(xiàn)了。最重要的是您無需重新建立項目,使用現(xiàn)有ASP .NET項目即可無縫使用SignalR。
群聊實例效果
咋們先來看看測試用例的效果吧,這里是線上效果鏈接:神牛聊天室(:1001/home/shenniuchat),效果圖:
界面及其簡單,樣式這里就不考慮了,主要是展示其用法,這里涉及到的功能有:
1. 統(tǒng)計在線人數(shù)量
2. 顯示在線人數(shù)的昵稱和連接方式(本測試用例支持webSockets和longPolling(長連接))
3. 群聊信息
MVC中如何使用SignalR
首先,我們平常做法創(chuàng)建MVC的Web項目,然后通過Nuget控制臺命令: Install-package Microsoft.AspNet.SignalR 加入SignalR的依賴,自動添加的包如下:
并且自動往MVC項目中的Script文件夾中增加相關的js文件:
jquery.signalR-2.2.2.min.js jquery.signalR-2.2.2.js
然后,我們需要在項目一級目錄創(chuàng)建一個文件名稱為Startup.cs的類,里面主要內(nèi)容補全不下:
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) 構造函數(shù)傳遞的是一個類型,而這個類型對應的就是我們創(chuàng)建的Startup類,這個通過這個構造函數(shù)類標記起始位置;
2. namespace Stage.Api.Extend 是我項目的命名空間,這個可以隨便定義;
3. public void Configuration(IAppBuilder app) 函數(shù)是固定必須的,這里程序會首先進入這個方法執(zhí)行里面的邏輯代碼;
4. app.MapSignalR 是擴展的IAppBuilder接口方法,他有多種表現(xiàn)形式,這里我選擇的是 public static IAppBuilder MapSignalR(this IAppBuilder builder, string path, HubConfiguration configuration); ,這里看有點類似于咋們MVC的路由,這里主要注意的是這個Path參數(shù),在前端頁面的時候需要用到這個路徑;
到這里后臺需要的配置其實已經(jīng)就完成了,下面是具體需要操作的業(yè)務邏輯處理類,新建一個類(這里我取名為ChatHub)并繼承Hub(這是SignalR框架提供),然后里面的邏輯代碼如下:
1 public class ChatHub : Hub 2 { 3 // 4 public int Num = 10001; 5 public static List_Users = new List (); 6 7 /// 8 /// 添加聊天人 9 /// 10 /// 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 ///25 /// 發(fā)送信息26 /// 27 /// 28 /// 29 public void SendAll(MoHubUser user, string message)30 {31 Clients.All.addNewMessageToPage(user, message);32 }33 34 ///35 /// 某個聊天人退出是,通知所有在線人重新加載聊天人數(shù)36 /// 37 /// 38 ///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,發(fā)送信息到客戶端,某個連接失效后通知各個有效的聊天人重新加載信息;這里值得關注的是通過重新 public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled) 方法來實現(xiàn)捕獲并移除失效連接(這里是聊天人的信息);整篇測試用例通過Context.ConnectionId來保證連接的唯一性,只要有新的鏈接請求,那么服務端就會分配一個唯一串給這個鏈接,當客戶端關閉頁面或關閉鏈接這個是有就能在OnDisconnected方法中捕獲到這個失效的鏈接的ConnectionId,這樣就達到了移除失效聊天人的要求了;為了代碼的方便性,這里創(chuàng)建了一個聊天人信息類:
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 53@ViewBag.Title 在線人數(shù):0人
545565 66 67 @**@566157
58 59 60626463
客戶端這里寫法大致有兩種選擇,一種直接使用生成的代理來操作,一種不用自動生成的代理采用手動創(chuàng)建代理的方式;為了內(nèi)容的簡潔性,這里只簡單講解下自動生成的代理方式,而更多的是分享手動創(chuàng)建代理鏈接的方式;
使用生成的代理獲取鏈接
首先,我們需要通過Script標簽來引用一下自動生成代理的路徑: ,注意啦這里的路徑/chat對應的就是咋們在前面Startup.cs文件中配置 app.MapSignalR("/chat" 路徑,而后面/hubs固定的寫法(至少目前我還沒更多的試驗過),只有先應用了這個~/chat/hubs,才能在后面使用生成的代理,先上段代碼:
1 var chat = $.connection.chatHub; 2 chat.client.newUser = function (user) { 3 $("#users").append('
咋們逐步來解析下代碼注意點:
1. var chat = $.connection.chatHub; 這里的chatHub對應的就是咋們創(chuàng)建的并繼承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是后端調(diào)用客戶端,那相對的chat.server就是客戶端請求服務端,和上面一樣通過chat.server.xxx來指定請求的服務端方法,注意這個時候服務端方法指的是繼承類Hub的子類的公共方法(本篇對應的是:chat.server.sendAll(my, content)對應ChatHub.cs文件中的 public void SendAll(MoHubUser user, string message) 函數(shù))
4. connection.hub.start({ transport: ['webSockets', 'longPolling'] }) 來指定運行的交互協(xié)議
以上就是使用生成代理的方式,按照上面的注意點來寫應該不是問題;
使用手動創(chuàng)建反向代理來鏈接
不采用生成的代碼的方式,我們只需要修改前端就行了,后臺代碼不用變或設置不用變動;首先我們把上面說的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('
同樣列出如下注意點:
1. var connection = $.hubConnection("/chat/hubs"); 創(chuàng)建鏈接,這里的path同樣對應后端的 app.MapSignalR("/chat" ,路徑保持一致
2. var chat = connection.createHubProxy('chatHub'); 來創(chuàng)建反向代理鏈接,這里的name:chatHub對應的是后端的ChatHub類名稱
3. 通過on("xxx",function(){})函數(shù)來綁定服務端通知客戶端的事件,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)
看完上述內(nèi)容,你們對ASP.NET SignalR及其用法大概了解了嗎?如果想了解更多相關文章內(nèi)容,歡迎關注創(chuàng)新互聯(lián)行業(yè)資訊頻道,感謝各位的閱讀!
網(wǎng)站題目:ASP.NETSignalR的簡介和用法介紹
分享鏈接:http://www.dlmjj.cn/article/jhhdeo.html