欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

ASP.NET MVC中SignalR的简单应用

程序员文章站 2022-06-23 11:13:21
一、简介 asp.net signalr 是为 asp.net 开发人员提供的一个库,可以简化开发人员将实时 web 功能添加到应用程序的过程。实时 web 功能是指这样...

一、简介

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,安装下面这些程序包

ASP.NET MVC中SignalR的简单应用

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

ASP.NET MVC中SignalR的简单应用

ASP.NET MVC中SignalR的简单应用

三、编写代码

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

using microsoft.owin;
using owin;
[assembly: owinstartup(typeof(signalrstartup.startup))]
namespace signalrstartup
{
  public class startup
  {
    public void configuration(iappbuilder app)
    {
      // 配置集线器 
      app.mapsignalr();
    }
  }
}

接着编写服务端的hub类

using system;
using system.collections.generic;
using system.linq;
using system.threading.tasks;
using system.web;
using microsoft.aspnet.signalr;
namespace signalr
{
  public class serverhub : hub
  {
    public void sendmsg(string message)
    {
      //调用所有客户端的sendmessage方法(sendmessage有2个参数) 
      clients.all.sendmessage(datetime.now.tostring("yyyy-mm-dd hh:mm:ss"), message);
    }
  }
}

创建homocontroller以及其action函数index

using system;
using system.collections.generic;
using system.linq;
using system.web;
using system.web.mvc;

namespace signalr.controllers
{
  public class homecontroller : controller
  {
    public actionresult index()
    {
      return view();
    }
  }
}

index前段代码

@{ 
  viewbag.title = "signair聊天窗口"; 
} 
<div class="container"> 
  <input type="text" id="message" /> 
  <input type="button" id="sendmessage" value="biubiu" /> 
  <ul id="messagebox"></ul> 
</div> 
@section scripts 
{ 
  <script src="~/scripts/jquery.signalr-2.2.2.min.js"></script> 
  <script src="~/signalr/hubs"></script> 
  <script> 
    $(function () { 
      //引用自动生成的集线器代理 
      var chat = $.connection.serverhub; 
      //定义服务器调用的客户端sendmessage来显示新消息 
      chat.client.sendmessage = function (name, message) 
      { 
        //向页面添加消息 
        $("#messagebox").append('<li><strong style="color:green">'+name+'</strong>:'+message+'</li>'); 
      } 
      //设置焦点到输入框 
      $('#message').focus(); 
      //开始连接服务器 
      $.connection.hub.start().done(function () { 
        $('#sendmessage').click(function () { 
          //调用服务器端集线器的send方法 
          chat.server.sendmsg($('#message').val()); 
          //清空输入框信息并获取焦点 
          $("#message").val('').focus(); 
        }) 
      }) 
    }); 
  </script> 
} 

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

ASP.NET MVC中SignalR的简单应用

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

还记得这句吗?
<script src="~/signalr/hubs"></script>
f12看到的结果

ASP.NET MVC中SignalR的简单应用

上面的demo中的 clients.all.sendmessage是调用所有客户端的sendmessage函数,属于群发。

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

服务端代码

 public void addtoroom(string groupname, string username)
    {
      //将连接添加到指定的组(groups为hubbase中的接口属性)
      groups.add(context.connectionid, groupname);
      //根据组名称获取对应客户端的组,调用该组的adduserin方法
      clients.group(groupname, new string[0]).adduserin(groupname, username);
    }
    public void send(string groupname, string detail, string username)
    {
      //clients.all.addsomemessage(detail);//群发给所有
      //调用客户端某一个组的addsomemessage
      clients.group(groupname, new string[0]).addsomemessage(groupname, detail, username);
    }

客户端代码

 chat.client.addsomemessage = function(groupid, detail, username) {
        console.info("广播消息:" + detail);
        $("#contentmsg").append("<li>" + username + ": " + detail + "</li>");
      };

     chat.client.adduserin = function(groupid, username) {
        $("#contentmsg").append("<li>" + username + "进入"+groupid+"号聊天室!</li>");
      };
      $.connection.hub.logging = true; //启动signalr状态功能
      $.connection.hub.start().done(function() {
        //加入聊天室 
        $("#joinroom").click(function() {
          var groupid = $("#groupid").val();
          var username = $("#username").val();
          chat.server.addtoroom(groupid, username);
        });
        //发送消息
        $("#send").click(function() {
          var detail = $("#message").val();
          var groupid = $("#groupid").val();
          var username = $("#username").val();
          chat.server.send(groupid, detail, username);
        });
      });

运行效果

ASP.NET MVC中SignalR的简单应用

ASP.NET MVC中SignalR的简单应用

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

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