查看: 153|回复: 0

[.NET开发] ASP.NET MVC中SignalR的简单应用

发表于 4 天前

一、简介

asp.net SignalR 是为 ASP.NET 开发人员提供的一个库,可以简化开发人员将实时 Web 功能添加到应用程序的过程。实时 Web 功能是指这样一种功能:当所连接的客户端变得可用时服务器代码可以立即向其推送内容,而不是让服务器等待客户端请求新的数据。——百度百科

  首先ASP.NET SignalR 是一个ASP .NET 下的类库,可以在ASP .NET 的Web项目中实现实时通信。让客户端(Web页面)和服务器端可以互相通知消息及调用方法。

  SignalR自动处理连接管理,可以让服务端同时向所有连接的客户端广播消息,比如聊天室。也可以向特定的客户端发送消息。客户端和服务器之间的连接是持久的,与传统的HTTP连接不同,它是为每个通信重新建立的。

  SignalR支持“服务器推送”功能,其中服务器代码可以使用远程过程调用(RPC)调用浏览器中的客户端代码,而不是今天在网络上常见的请求响应模型。

  总之,SignalR是一个运行在.NET 平台上的 html websocket 框架,它出现的主要目的是实现服务器主动推送(Push)消息到客户端页面

  注意:WebSocket要求服务器使用Windows Server 2012或Windows 8和.NET Framework 4.5如果不符合这些要求,SignalR将尝试使用其他传输来进行连接

二、安装

打开管理NuGet程序包,搜索SignalR,安装下面这些程序包


安装完成后程序中会多出一些引用

三、编写代码

因为用的是SignalR2,所以需要新建Startup.cs类,配置集线器,编写如下

  1. using Microsoft.Owin;
  2. using Owin;
  3. [assembly: OwinStartup(typeof(SignalRStartup.Startup))]
  4. namespace SignalRStartup
  5. {
  6. public class Startup
  7. {
  8. public void Configuration(IAppBuilder app)
  9. {
  10. // 配置集线器
  11. app.MapSignalR();
  12. }
  13. }
  14. }
复制代码

接着编写服务端的hub类

  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Threading.Tasks;
  5. using System.Web;
  6. using Microsoft.AspNet.SignalR;
  7. namespace signalR
  8. {
  9. public class ServerHub : Hub
  10. {
  11. public void SendMsg(string message)
  12. {
  13. //调用所有客户端的sendMessage方法(sendMessage有2个参数)
  14. Clients.All.sendMessage(DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"), message);
  15. }
  16. }
  17. }
复制代码

创建HomoController以及其Action函数Index

  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Web;
  5. using System.Web.Mvc;
  6. namespace signalR.Controllers
  7. {
  8. public class HomeController : Controller
  9. {
  10. public ActionResult Index()
  11. {
  12. return View();
  13. }
  14. }
  15. }
复制代码

Index前段代码

  1. @{
  2. ViewBag.title = "SignaIR聊天窗口";
  3. }
  4. <div class="container">
  5. <input type="text" id="message" />
  6. <input type="button" id="sendmessage" value="biubiu" />
  7. <ul id="messageBox"></ul>
  8. </div>
  9. @section scripts
  10. {
  11. <script src="~/Scripts/jquery.signalR-2.2.2.min.js"></script>
  12. <script src="~/signalr/hubs"></script>
  13. <script>
  14. $(function () {
  15. //引用自动生成的集线器代理
  16. var chat = $.connection.serverHub;
  17. //定义服务器调用的客户端sendMessage来显示新消息
  18. chat.client.sendMessage = function (name, message)
  19. {
  20. //向页面添加消息
  21. $("#messageBox").append('<li><strong style="color:green">'+name+'</strong>:'+message+'</li>');
  22. }
  23. //设置焦点到输入框
  24. $('#message').focus();
  25. //开始连接服务器
  26. $.connection.hub.start().done(function () {
  27. $('#sendmessage').click(function () {
  28. //调用服务器端集线器的Send方法
  29. chat.server.sendMsg($('#message').val());
  30. //清空输入框信息并获取焦点
  31. $("#message").val('').focus();
  32. })
  33. })
  34. });
  35. </script>
  36. }
复制代码

运行效果,在任何一个窗口发送消息,其他所有客户端都能收到该消息。

运行程序的时候,Web页面就与SignalR的服务建立了连接,具体的建立连接的代码就是:$.connection.hub.start()。这句代码的作用就是与SignalR服务建立连接,后面的done函数表明建立连接成功后为按钮注册了一个click事件;也可以用集线器对象chat.connextion.start()

还记得这句吗?

F12看到的结果

上面的demo中的 Clients.All.sendMessage是调用所有客户端的sendMessage函数,属于群发。

下面是一个客户端分组的demo

服务端代码

  1. public void AddToRoom(string groupName, string userName)
  2. {
  3. //将连接添加到指定的组(Groups为HubBase中的接口属性)
  4. Groups.Add(Context.ConnectionId, groupName);
  5. //根据组名称获取对应客户端的组,调用该组的addUserIn方法
  6. Clients.Group(groupName, new string[0]).addUserIn(groupName, userName);
  7. }
  8. public void Send(string groupName, string detail, string userName)
  9. {
  10. //Clients.All.addSomeMessage(detail);//群发给所有
  11. //调用客户端某一个组的addSomeMessage
  12. Clients.Group(groupName, new string[0]).addSomeMessage(groupName, detail, userName);
  13. }
复制代码

客户端代码

  1. chat.client.addSomeMessage = function(groupId, detail, userName) {
  2. console.info("广播消息:" + detail);
  3. $("#contentMsg").append("<li>" + userName + ": " + detail + "</li>");
  4. };
  5. chat.client.addUserIn = function(groupId, userName) {
  6. $("#contentMsg").append("<li>" + userName + "进入"+groupId+"号聊天室!</li>");
  7. };
  8. $.connection.hub.logging = true; //启动signalr状态功能
  9. $.connection.hub.start().done(function() {
  10. //加入聊天室
  11. $("#joinRoom").click(function() {
  12. var groupId = $("#groupId").val();
  13. var userName = $("#userName").val();
  14. chat.server.addToRoom(groupId, userName);
  15. });
  16. //发送消息
  17. $("#send").click(function() {
  18. var detail = $("#message").val();
  19. var groupId = $("#groupId").val();
  20. var userName = $("#userName").val();
  21. chat.server.send(groupId, detail, userName);
  22. });
  23. });
复制代码

运行效果


从上面两张图可以看出,客户端实现了分组

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持程序员之家。



回复

使用道具 举报