Asp.net SignalR快速入門
今天的專題就是讓大家可以快速的上手Asp.net SignalR。廢話不多說了,下面正式進入今天專題的內(nèi)容。
二、Asp.net SignalR 是個什么東東
Asp.net SignalR是微軟為實現(xiàn)實時通信的一個類庫。一般情況下,SignalR會使用JavaScript的長輪詢(long polling)的方式來實現(xiàn)客戶端和服務(wù)器通信,隨著Html5中WebSockets出現(xiàn),SignalR也支持WebSockets通信。另外SignalR開發(fā)的程序不僅僅限制于宿主在IIS中,也可以宿主在任何應(yīng)用程序,包括控制臺,客戶端程序和Windows服務(wù)等,另外還支持Mono,這意味著它可以實現(xiàn)跨平臺部署在Linux環(huán)境下。
SignalR內(nèi)部有兩類對象:
Http持久連接(Persisten Connection)對象:用來解決長時間連接的功能。還可以由客戶端主動向服務(wù)器要求數(shù)據(jù),而服務(wù)器端不需要實現(xiàn)太多細節(jié),只需要處理PersistentConnection 內(nèi)所提供的五個事件:OnConnected, OnReconnected, OnReceived, OnError 和 OnDisconnect 即可。
Hub(集線器)對象:用來解決實時(realtime)信息交換的功能,服務(wù)端可以利用URL來注冊一個或多個Hub,只要連接到這個Hub,就能與所有的客戶端共享發(fā)送到服務(wù)器上的信息,同時服務(wù)端可以調(diào)用客戶端的腳本。
SignalR將整個信息的交換封裝起來,客戶端和服務(wù)器都是使用JSON來溝通的,在服務(wù)端聲明的所有Hub信息,都會生成JavaScript輸出到客戶端,.NET則依賴Proxy來生成代理對象,而Proxy的內(nèi)部則是將JSON轉(zhuǎn)換成對象。
客戶端和服務(wù)端的具體交互情況如下圖所示:
從上面的介紹可以看出,SignalR既然是為實時而生的,這樣就決定了其使用場所。具體適用情景有如下幾點:
1、聊天室,如在線客服系統(tǒng),IM系統(tǒng)等
2、股票價格實時更新
3、消息的推送服務(wù)
4、游戲中人物位置的實時推送
目前,我所在公司在開發(fā)的就是在線客服系統(tǒng)。
三、使用Asp.net SignalR在Web端實現(xiàn)廣播消息
通過第二部分的介紹,相信大家對Asp.net SignalR有了一個初步的了解,接下來通過兩個例子來讓大家加深對SignalR運行機制的理解。第一個例子就是在Web端如何使用SignalR來實現(xiàn)廣播消息。
使用Visual Studio 2013,創(chuàng)建一個MVC工程
通過Nuget安裝SignalR包。右鍵引用-》選擇管理Nuget程序包-》在出現(xiàn)的窗口中輸入SignalR來找到SignalR包進行安裝。
安裝SignalR成功后,SignalR庫的腳本將被添加進Scripts文件夾下。具體如下圖所示:
4. 向項目中添加一個SignalR集線器(v2)并命名為ServerHub。
5. 將下面代碼填充到剛剛創(chuàng)建的ServerHub類中。
using Microsoft.AspNet.SignalR; using Microsoft.AspNet.SignalR.Hubs; using System; namespace SignalRQuickStart {public class ServerHub : Hub { private static readonly char[] Constant = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z' }; /// <summary> /// 供客戶端調(diào)用的服務(wù)器端代碼 /// </summary> /// <param name="message"></param> public void Send(string message) { var name = GenerateRandomName(4); // 調(diào)用所有客戶端的sendMessage方法 Clients.All.sendMessage(name, message); } /// <summary> /// 產(chǎn)生隨機用戶名函數(shù) /// </summary> /// <param name="length">用戶名長度</param> /// <returns></returns> public static string GenerateRandomName(int length) { var newRandom = new System.Text.StringBuilder(62); var rd = new Random(); for (var i = 0; i < length; i++) { newRandom.Append(Constant[rd.Next(62)]); } return newRandom.ToString(); } } }
6. 創(chuàng)建一個Startup類,如果開始創(chuàng)建MVC項目的時候沒有更改身份驗證的話,這個類會默認添加的,如果已有就不需要重復(fù)添加了。按照如下代碼更新Startup類。
7. 在Home控制器中創(chuàng)建一個Home Action方法
public class HomeController : Controller { public ActionResult Index() { return View(); } public ActionResult About() { ViewBag.Message = "Your application description page."; return View(); } public ActionResult Contact() { ViewBag.Message = "Your contact page."; return View(); } public ActionResult Chat() { return View(); } }
8. 在Views文件中Home文件夾中創(chuàng)建一個Chat視圖,視圖代碼如下所示:
@{ ViewBag.Title = "聊天窗口"; } <h2>Chat</h2> <div class="container"> <input type="text" id="message" /> <input type="button" id="sendmessage" value="Send" /> <input type="hidden" id="displayname" /> <ul id="discussion"></ul> </div> @section scripts { <!--引用SignalR庫. --> <script src="~/Scripts/jquery.signalR-2.2.0.min.js"></script> <!--引用自動生成的SignalR 集線器(Hub)腳本.在運行的時候在瀏覽器的Source下可看到 --> <script src="~/signalr/hubs"></script> <script> $(function () { // 引用自動生成的集線器代理 var chat = $.connection.serverHub; // 定義服務(wù)器端調(diào)用的客戶端sendMessage來顯示新消息 chat.client.sendMessage = function (name, message) { // 向頁面添加消息 $('#discussion').append('<li><strong>' + htmlEncode(name) + '</strong>: ' + htmlEncode(message) + '</li>'); }; // 設(shè)置焦點到輸入框 $('#message').focus(); // 開始連接服務(wù)器 $.connection.hub.start().done(function () { $('#sendmessage').click(function () { // 調(diào)用服務(wù)器端集線器的Send方法 chat.server.send($('#message').val()); // 清空輸入框信息并獲取焦點 $('#message').val('').focus(); }); }); }); // 為顯示的消息進行Html編碼 function htmlEncode(value) { var encodedValue = $('<div />').text(value).html(); return encodedValue; } </script> }
9. 修改App_Start文件夾內(nèi)的RoutConfig類,將Action方法默認設(shè)置為Chat.
public class RouteConfig { public static void RegisterRoutes(RouteCollection routes) { routes.IgnoreRoute("{resource}.axd/{*pathInfo}"); routes.MapRoute( name: "Default", url: "{controller}/{action}/{id}", defaults: new { controller = "Home", action = "Chat", id = UrlParameter.Optional } ); } }
到此,我們的例子就實現(xiàn)完成了,接下來我們先來看看運行效果,之后再來解釋到底SignalR是如何來完成廣播消息的。運行的運行結(jié)果如下。
從運行結(jié)果,你可以發(fā)現(xiàn),在任何一個窗口輸入信息并發(fā)送,所有客戶端將收到該消息。這樣的效果在實際應(yīng)用中很多,如QQ,一登錄QQ的時候都會推送騰訊廣告消息。
看完了運行結(jié)果,接下來我們來分析下代碼,進而來剖析下SignalR到底是如何工作的。
按照B/S模式來看,運行程序的時候,Web頁面就與SignalR的服務(wù)建立了連接,具體的建立連接的代碼就是:$.connection.hub.start()。這句代碼的作用就是與SignalR服務(wù)建立連接,后面的done函數(shù)表明建立連接成功后為發(fā)送按鈕注冊了一個click事件,當(dāng)客戶端輸入內(nèi)容點擊發(fā)送按鈕后,該Click事件將會觸發(fā),觸發(fā)執(zhí)行的操作為: chat.server.send($('#message').val())。這句代碼表示調(diào)用服務(wù)端的send函數(shù),而服務(wù)端的Send韓式又是調(diào)用所有客戶端的sendMessage函數(shù),而客戶端中sendMessage函數(shù)就是將信息添加到對應(yīng)的消息列表中。這樣就實現(xiàn)了廣播消息的功能了。
看到這里,有人是否會有疑問,前面的實現(xiàn)都只用到了集線器對象,而沒有用到持久連接對象。其實并不是如此,$.connection這句代碼就是使用持久連接對象,當(dāng)然你也可以在重新OnConnected方法來查看監(jiān)控客戶端的連接情況,更新的代碼如下所示:
public class ServerHub : Hub { private static readonly char[] Constant = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z' }; /// <summary> /// 供客戶端調(diào)用的服務(wù)器端代碼 /// </summary> /// <param name="message"></param> public void Send(string message) { var name = GenerateRandomName(4); // 調(diào)用所有客戶端的sendMessage方法 Clients.All.sendMessage(name, message); } /// <summary> /// 客戶端連接的時候調(diào)用 /// </summary> /// <returns></returns> public override Task OnConnected() { Trace.WriteLine("客戶端連接成功"); return base.OnConnected(); } /// <summary> /// 產(chǎn)生隨機用戶名函數(shù) /// </summary> /// <param name="length">用戶名長度</param> /// <returns></returns> public static string GenerateRandomName(int length) { var newRandom = new System.Text.StringBuilder(62); var rd = new Random(); for (var i = 0; i < length; i++) { newRandom.Append(Constant[rd.Next(62)]); } return newRandom.ToString(); } }
這樣在運行頁面的時候,將在輸出窗口看到“客戶端連接成功”字樣。運行效果如下圖所示:
在第二部分介紹的時候說道,在服務(wù)端聲明的所有Hub信息,都會生成JavaScript輸出到客戶端,為了驗證這一點,可以在Chrome中F12來查看源碼就明白了,具體如下圖所示:
看到上圖,你也就明白了為什么Chat.cshtml頁面需要引入"signalr/hubs"腳本庫了吧。
<!--引用SignalR庫. --> <script src="~/Scripts/jquery.signalR-2.2.0.min.js"></script> <!--引用自動生成的SignalR 集線器(Hub)腳本.在運行的時候在瀏覽器的Source下可看到 --> <script src="~/signalr/hubs"></script>
四、在桌面程序中如何使用Asp.net SignalR
上面部分介紹了SignalR在Asp.net MVC 中的實現(xiàn),這部分將通過一個例子來看看SignalR在WPF或WinForm是如何使用的。其實這部分實現(xiàn)和Asp.net MVC中非常相似,主要不同在于,Asp.net MVC中的SignalR服務(wù)器寄宿在IIS中,而在WPF中應(yīng)用,我們把SignalR寄宿在WPF客戶端中。
下面讓我們看看SignalR服務(wù)端的實現(xiàn)。
/// <summary> /// 啟動SignalR服務(wù),將SignalR服務(wù)寄宿在WPF程序中 /// </summary> private void StartServer() { try { SignalR = WebApp.Start(ServerUri); // 啟動SignalR服務(wù) } catch (TargetInvocationException) { WriteToConsole("一個服務(wù)已經(jīng)運行在:" + ServerUri); // Dispatcher回調(diào)來設(shè)置UI控件狀態(tài) this.Dispatcher.Invoke(() => ButtonStart.IsEnabled = true); return; } this.Dispatcher.Invoke(() => ButtonStop.IsEnabled = true); WriteToConsole("服務(wù)已經(jīng)成功啟動,地址為:" + ServerUri); } public class ChatHub : Hub { public void Send(string name, string message) { Clients.All.addMessage(name, message); } public override Task OnConnected() { // Application.Current.Dispatcher.Invoke(() => ((MainWindow)Application.Current.MainWindow).WriteToConsole("客戶端連接,連接ID是: " + Context.ConnectionId)); return base.OnConnected(); } public override Task OnDisconnected(bool stopCalled) { Application.Current.Dispatcher.Invoke(() => ((MainWindow)Application.Current.MainWindow).WriteToConsole("客戶端斷開連接,連接ID是: " + Context.ConnectionId)); return base.OnDisconnected(true); } } public class Startup { public void Configuration(IAppBuilder app) { // 有關(guān)如何配置應(yīng)用程序的詳細信息,請訪問 http://go.microsoft.com/fwlink/?LinkID=316888 // 允許CORS跨域 //app.UseCors(CorsOptions.AllowAll); app.MapSignalR(); } }
通過上面的代碼,我們SignalR服務(wù)端的實現(xiàn)就完成了,其實現(xiàn)邏輯與Asp.net MVC的代碼類似。
接下來,讓我們看看,WPF客戶端是如何連接和與服務(wù)器進行通信的。具體客戶端的實現(xiàn)如下:
public IHubProxy HubProxy { get; set; } const string ServerUri = "http://localhost:8888/signalr"; public HubConnection Connection { get; set; } public MainWindow() { InitializeComponent(); // 窗口啟動時開始連接服務(wù) ConnectAsync(); } /// <summary> /// 發(fā)送消息 /// </summary> /// <param name="sender"></param> /// <param name="e"></param> private void ButtonSend_Click(object sender, RoutedEventArgs e) { // 通過代理來調(diào)用服務(wù)端的Send方法 // 服務(wù)端Send方法再調(diào)用客戶端的AddMessage方法將消息輸出到消息框中 HubProxy.Invoke("Send", GenerateRandomName(4), TextBoxMessage.Text.Trim()); TextBoxMessage.Text = String.Empty; TextBoxMessage.Focus(); } private async void ConnectAsync() { Connection = new HubConnection(ServerUri); Connection.Closed += Connection_Closed; // 創(chuàng)建一個集線器代理對象 HubProxy = Connection.CreateHubProxy("ChatHub"); // 供服務(wù)端調(diào)用,將消息輸出到消息列表框中 HubProxy.On<string, string>("AddMessage", (name, message) => this.Dispatcher.Invoke(() => RichTextBoxConsole.AppendText(String.Format("{0}: {1}\r", name, message)) )); try { await Connection.Start(); } catch (HttpRequestException) { // 連接失敗 return; } // 顯示聊天控件 ChatPanel.Visibility = Visibility.Visible; ButtonSend.IsEnabled = true; TextBoxMessage.Focus(); RichTextBoxConsole.AppendText("連上服務(wù):" + ServerUri + "\r"); }
上面的代碼也就是WPF客戶端實現(xiàn)的核心代碼,主要邏輯為,客戶端啟動的時候就調(diào)用Connection.Start方法與服務(wù)器進行連接。然后通過HubProxy代理類來調(diào)用集線器中Send方法,而集線器中的Send方法又通過調(diào)用客戶端的addMessage方法將消息輸出到客戶端的消息框中進行顯示,從而完成消息的推送過程。接下來,讓我們看看其運行效果:
從上面的運行效果看出,其效果和Asp.net MVC上的效果是一樣的。
五、總結(jié)
到這里,本專題的所有內(nèi)容就結(jié)束了,這篇SignalR快速入門也是本人在學(xué)習(xí)SignalR過程中的一些心得體會,希望可以幫助一些剛接觸SignalR的朋友快速入門。本篇主要實現(xiàn)了SignalR的廣播消息的功能,可以實現(xiàn)手機端消息推送的功能,接下來一篇將介紹如何使用SignalR實現(xiàn)一對一的聊天。
- Asp.net使用SignalR實現(xiàn)酷炫端對端聊天功能
- Asp.NET MVC中使用SignalR實現(xiàn)推送功能
- 詳解在ASP.NET Core下使用SignalR技術(shù)
- Asp.net使用SignalR實現(xiàn)聊天室的功能
- Vue結(jié)合SignalR實現(xiàn)前后端實時消息同步
- Asp.net SignalR支持的平臺有哪些
- Asp.net使用SignalR實現(xiàn)發(fā)送圖片
- Asp.net使用SignalR實現(xiàn)消息提醒
- ASP.NET用SignalR建立瀏覽器和服務(wù)器的持久連接詳解
- ASP.NET Core SignalR中的流式傳輸深入講解
相關(guān)文章
asp.net源程序編譯為dll文件并調(diào)用的實現(xiàn)過程
這篇文章主要介紹了asp.net源程序編譯為dll文件并調(diào)用的實現(xiàn)過程,非常有實用價值,需要的朋友可以參考下2014-07-07基于asp.net下使用jquery實現(xiàn)ajax的解決方法
本文以最簡單的方法為新手示范如何使用jquery實現(xiàn)ajax技術(shù)(所以本文是專為新手所寫,老鳥勿噴,大神此處省略一萬字)。至于什么是jquery什么是ajax,自己谷歌去2013-05-05.NET?Core控制臺應(yīng)用ConsoleApp讀取appsettings.json配置文件
這篇文章介紹了.NET?Core控制臺應(yīng)用ConsoleApp讀取appsettings.json配置文件的方法,文中通過示例代碼介紹的非常詳細。對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2022-07-07asp.net下模態(tài)對話框關(guān)閉之后繼續(xù)執(zhí)行服務(wù)器端代碼的問題
asp.net下模態(tài)對話框關(guān)閉之后繼續(xù)執(zhí)行服務(wù)器端代碼的問題...2007-04-04asp.net模板引擎Razor調(diào)用外部方法用法實例
這篇文章主要介紹了asp.net模板引擎Razor調(diào)用外部方法用法,實例分析了Razor調(diào)用外部方法的相關(guān)使用技巧,需要的朋友可以參考下2015-06-06手把手教你AspNetCore WebApi數(shù)據(jù)驗證的實現(xiàn)
這篇文章主要介紹了手把手教你AspNetCore WebApi數(shù)據(jù)驗證的實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-10-10asp.net開發(fā)與web標(biāo)準(zhǔn)的沖突問題的一些常見解決方法
Visual Studio .net從2003到現(xiàn)在的2008,一路走來慢慢強大……從以前的vs2003能自動改亂你的html代碼到現(xiàn)在在vs2008中都能直接對html代碼進行w3c標(biāo)準(zhǔn)驗證并提示了,非常不易。2009-02-02[Asp.Net Core]用Blazor Server Side實現(xiàn)圖片驗證碼
這篇文章主要介紹了如何用Blazor Server Side實現(xiàn)圖片驗證碼,文中講解非常詳細,代碼幫助大家更好理解和學(xué)習(xí),感興趣的朋友可以了解下2020-07-07