代码编织梦想

背景:Web端需要能实时接收到消息推送,当客户有新消息来时,在客户端的右下角进行弹框提醒。

什么是signalR?

Asp.net SignalR是微软为实现实时通信的一个类库。一般情况下,signalR会使用JavaScript的长轮询(long polling)的方式来实现客户端和服务器通信,随着Html5中WebSockets出现,SignalR也支持WebSockets通信。另外SignalR开发的程序不仅仅限制于宿主在IIS中,也可以宿主在任何应用程序,包括控制台,客户端程序和Windows服务等,另外还支持Mono,这意味着它可以实现跨平台部署在Linux环境下。

signalR内部有两类对象:

Http持久连接(Persisten Connection)对象:用来解决长时间连接的功能。还可以由客户端主动向服务器要求数据,而服务器端不需要实现太多细节,只需要处理PersistentConnection 内所提供的五个事件:OnConnected, OnReconnected, OnReceived, OnError 和 OnDisconnect 即可。
Hub(集线器)对象:用来解决实时(realtime)信息交换的功能,服务端可以利用URL来注册一个或多个Hub,只要连接到这个Hub,就能与所有的客户端共享发送到服务器上的信息,同时服务端可以调用客户端的脚本。SignalR将整个信息的交换封装起来,客户端和服务器都是使用JSON来沟通的,在服务端声明的所有Hub信息,都会生成JavaScript输出到客户端,.NET则依赖Proxy来生成代理对象,而Proxy的内部则是将JSON转换成对象。

SignalR将整个信息的交换封装起来,客户端和服务器都是使用JSON来沟通的,在服务端声明的所有Hub信息,都会生成JavaScript输出到客户端,.NET则依赖Proxy来生成代理对象,而Proxy的内部则是将JSON转换成对象。

客户端和服务端的具体交互情况如下图所示:

 

基本流程如图:

 

其实说白点SignalR其实就是微软自己封装好的实现即时通讯的一个类库

如何使用:

Nuget引入 Microsoft.AspNet.SignalR 系列 2.4.1

 

添加完signalR你可以在 Scripts 文件夹下看到自动添加了两个js文件:

 

向项目中添加一个signalR集线器(V2)命名为ServerHub:

 

在刚刚新建的ServerHub.cs 中写入 以下代码:

//*********************************************************************************
//Description:自定义扩展一个消息通知类库模块>集线器
//Author:DennyHui
//Create Date: 2019年10月15日18:39:33
//*********************************************************************************
using Microsoft.AspNet.SignalR;
using Microsoft.AspNet.SignalR.Hubs;
 
namespace Fisk.DataWithReportManage.AutoTask
{
    /// <summary>
    /// 消息通知集线器  2019年10月16日12:28:08  Dennyhui
    /// </summary>
    [HubName("serverhub")]
    public class ServerHub:Hub
    {
        /// <summary>
        /// 发送消息 2019年10月16日12:28:18  Dennyhui
        /// </summary>
        /// <param name="message"></param>
        public void SendMsg(string id,string title, string message,string poptype)
        {
            //调用所有客户端的sendMessage方法(sendMessage有2个参数)  
            //Clients.All.SendMessage("测试");
            //Clients.All.broadcastMessage("测试");
            //Clients.All.notify("测试");
            var hubContext = GlobalHost.ConnectionManager.GetHubContext<ServerHub>();//此处的“ServerHub”需要和当前的类名一直
            hubContext.Clients.All.sendMessage(id,title,message, poptype); //用户调用客户端的函数 
            //Clients.All.sendMessage(DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"), "测试");
        }
        /// <summary>
        /// 实例化  2019年10月16日12:28:31  Dennhui
        /// </summary>
        public void Init() { }
    }
}

如果你的mvc项目是不进行身份验证的那种吧,必须得添加一个Startup 类.      如果没有这个类,请添加,不然的话项目运行不起来的,具体代码如下:

using Microsoft.Owin;
using Owin;
[assembly: OwinStartup(typeof(SignalRQuickStart.Startup))]
 
namespace SignalRQuickStart
{
    public class Startup
    {
        public void Configuration(IAppBuilder app)
        {
            // 有关如何配置应用程序的详细信息,请访问 http://go.microsoft.com/fwlink/?LinkID=316888
            // 配置集线器
            app.MapSignalR();
        }
    }
}
在Control 里新建一个MessageAction方法,在Message视图里添加代码如下:

@{
    ViewBag.title = "SignaIR聊天窗口";
}
    <div class="container">
        <input type="text" id="message" />
        <input type="button" id="sendmessage" value="Send" />
        <input type="hidden" id="displayname" />
        <ul id="messageBox"></ul>
    </div>
@section scripts
{
   <script src="~/Scripts/jquery.signalR-2.2.1.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">'+htmlEncode(name)+'</strong>:'+htmlEncode(message)+'</li>');
            }
            //设置焦点到输入框
            $('#message').focus();
            //开始连接服务器
            $.connection.hub.start().done(function () {
                $('#sendmessage').click(function () {
                    //调用服务器端集线器的Send方法
                    chat.server.sendMsg($('#message').val());
                    //清空输入框信息并获取焦点
                    $("#message").val('').focus();
                })
            })
        });
        //为显示的消息进行html编码
        function htmlEncode(value)
        {
            var encodeValue = $('<div/>').text(value).html();
            return encodeValue;
        }
    </script>
}

         //消息通知  2019年10月15日18:38:56  Dennyhui
        function  SignalRMessage () {
            //toastr.info("向页面添加消息  ", "新消息");
            var NowDateNoticeList = window.WebNotificationList;
            //引用自动生成的集线器代理  
            var chat = $.connection.serverhub;
            //定义服务器调用的客户端sendMessage来显示新消息  
            //此处的“sendMessage”需要和后台发送消息的方法名一致
            chat.client.sendMessage = function (id, title, message, poptype) {
                
                // do somethings
               
            }
            //集线器开始工作
            $.connection.hub.start().done(function () {
                chat.server.init();
            });

好了,一个signalR简单的入门的例子就ok了.

在任何一个web 页面中发送的消息所有的 页面都会接收到该消息。这种应用在IM系统非常广泛常见。

当然signalR并不局限于这种B/S模式的消息推送,在C/S 同样也能应用,目前我们公司xamarin android所用的就是这个signalR实现的PC之间、PC与移动端、移动端与移动端之间的交流,使用之后会发现的确挺方便的。

有人可能感觉很郁闷了,在视图中引入 这段js有什么作用?也并有写啊。

注意!,这是虚拟目录,也就是你在OWIN Startup中注册的地址

<script src="~/signalr/hubs"></script>
这个路径你在项目里面是找不到的!

其实在服务器端声明的所有Hub信息,最终都会生成JavaScript输出到客户端,其实谷歌浏览器中F12 ,在Sources你就可以看到写的源代码了:

 

来看一下在这种B/S 模式中 signalR是如何运行的吧。首先程序开始的时候,Web页面就已经与signalR的服务建立连接。

$.connection.hub.start() 意思就是有signalR服务建立连接

.done 函数表示连接成功后为发送的按钮绑定一个单击事件

发送消息的方法:chat.server.sendMsg($('#message').val())

在ServerHub重写一个 OnConnected 方法来监控客户端的连接情况,的确程序运行的时候web页面就已经开始建立连接了,在调试的时候可以在输入中看到 "客户端连接成功!

一个简单的如何使用signalR就是这么多,用法很广泛,当然还可以进行扩展。

可以使用Quartz这个组件和Signalr搭配进行定时调度发送消息


————————————————
版权声明:本文为CSDN博主「Denny辉」的原创文章
原文链接:https://blog.csdn.net/qq_23502409/article/details/102968078

 

asp.net signalr 指定用户消息推送简单示例-爱代码爱编程

 一、首先,在MVC项目中安装SingalR包(SingalR2.0需要.net4.5以上,VS2010可以安装1.1.3版本,本例为VS2010+SignalR1.1.3)。 打开工具—NuGet程序管理器—程序包管理器控制台,输入: Install-Package Microsoft.AspNet.SignalR-V

asp.net 利用signalr实现在线聊天系统_行侠者的博客-爱代码爱编程

先看下最终实现效果图 预览地址:http://www.mkadmin.cn/ 开发步骤: 一:因为整个推送都是使用SignalR来完成,所以先添加引用SignalR    Install-Package Microsoft.AspNet.SignalR 二:编写代码,由于篇幅原因,这里只暂时核心代码   1. SignalR后台推送逻辑

【小5聊】C# SignalR之主动推送信息的简单解决方案-爱代码爱编程

注:Core下的SignalR实现原理一样,只是写法不一样,在后续文章中再写一遍来做对比,敬请期待下下! 主动推送消息的场景使用:页面登录后台管理系统,最新订单信息的通知等 1、描述:Form窗体下使用SignalR,通过页面客户端触发服务端,在服务端触发一次后,开启一个定时器,让定时器给加入到连接列表的客户端主动推送消息 2、主动推送,客户端和

C#项目集成SignalR-爱代码爱编程

1、什么是SugnalR?        ASP. NET Signal是为ASP.NET开发人员提供的一个库,可以简化开发人员将实时Web功能添加到应用程序的过程。实时Web功能是指这样一种功能:当所连接的客户端变得可用时服务器代码可以立即向其推送内容,而不是让服务器等待客户端请求新的数据。        我个人的理解是:当客户端向服务器端发起一次请

C# 系统添加signalr推送功能模块,在后台各个项目web和api相关模块操作处,添加对应触发点,触发大屏实时更新相关数据-爱代码爱编程

背景:公司有web后台项目,有供手机app调用的api接口项目,要求在web,app上操作时,将相关数据实时显示到大屏tv,它是用vue写的,整个是前后端分离的方式,   第一部分:基础掌握基本的如何利用signalr实现基本的推送功能模块, 备注:既然工作中使用,总得尽量了解这个signalr的细节,不然使用的心里没底,,通过下面相关文档了解原理,

signalr 控制台做服务端-爱代码爱编程

服务端 一、新建控制台应用程序(.net framework 4.8) SignalRSelfHost 二、引入NuGet包 install-package Microsoft.AspNet.SignalR.Core install-package Microsoft.AspNet.SignalR.SelfHost install-package Mi

signalr向部分客户端进行消息推送_董厂长的博客-爱代码爱编程

前置笔记: 关于SignalR的身份认证问题_董厂长的博客-CSDN博客 之前做Task的解决方案是不同的功能对应不同的Hub,分开进行消息推送。应付简单的场景是足够的。后期复杂场景可能会出现单个HUB向部分客户端发送消息。 举个栗子:聊天室的demo下,北京客户端 和 上海客户端链接是同一个hub,但是需求是单个hub向上海客户端发消息。 不要局