一步一步学习SignalR进行实时通信_2_Persistent Connections

2023-08-23 08:19:16

原文:一步一步学习SignalR进行实时通信_2_Persistent Connections

一步一步学习SignalR进行实时通信\_2_Persistent Connections

SignalR

一步一步学习SignalR进行实时通信_2_Persistent Connections

前言

上一篇文章简单的介绍了下SignalR,从此篇文章就开始对SignalR进行剖析。在介绍Persistent connections之前,先简单介绍下安装signalR的方法。

我的开发环境:win10+vs2013

安装

首先我们新建一个空的MVC5的项目
通过Nuget[1]安装SignalR,通过Tools->Nuget Package Manager->Package Manager Console打开Package Manager Console
输入安装语句Install-Package Microsoft.AspNet.SignalR

可以看到添加了JQuery和SignalR2.0

Persistent Connections

映射并配置持久连接

如果我们要是实现基于PersistentConnection的实时信息传输,首先第一步我们需要在服务器启动时对SignalR进行配置。由于我们是基于Owin来实现SignalR的所以,我们在Startup中找到Configuration中配置,类似如果我们要实现其他的Owin框架我们也可以在这里进行配置。

映射


using System;
using System.Threading.Tasks;
using Microsoft.Owin;
using Owin;
using SignalR_2.Models;
//设置Owin的启动项
[assembly: OwinStartup(typeof(SignalR_1.Startup))]
namespace SignalR_·
{
    public class Startup
    {
        public void Configuration(IAppBuilder app)
        {
            // For more information on how to configure your application, visit http://go.microsoft.com/fwlink/?LinkID=316888
            app.MapSignalR<EchoConnection>("/echo");
        }
    }
}

通过MapSignalR()方法来做映射,/echo表示将会映射到/echo,后面我我们转到MapSignalR定义

一步一步学习SignalR进行实时通信_2_Persistent Connections " title="">

MapSignalR()是一个扩展方法,它有许多重载方法,而我们主要关心的就是如图所示的泛型方法。这个方法的TConnection要求是一个PersistentConnection类型。

好了,到此为止我们已经知道我们需要什么了,没必要继续深究下去。通过以上的研究,很明显,我们需要构造这么一个类去继承PersistentConnection来实现SignalR服务

实现SignalR服务

我们新建一个类叫做EchoConnection,代码如下:


using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using System.Web;
using Microsoft.AspNet.SignalR;

namespace SignalR_1.Models
{
    public class EchoConnection : PersistentConnection
    {
        /// <summary>
        /// 当前连接数
        /// </summary>
        private static int _connections = 0;
        /// <summary>
        /// 连接建立时执行
        /// </summary>
        /// <param name="request"></param>
        /// <param name="connectionId"></param>
        /// <returns></returns>
        protected override async Task OnConnected(IRequest request, string connectionId)
        {
            //原子操作,防止多条现成同时+1而只做一次变化
            Interlocked.Increment(ref _connections);
            await Connection.Send(connectionId, "Hi, " + connectionId + "!");
            await Connection.Broadcast("新连接 " + connectionId + "开启. 当前连接数: " + _connections);
        }
        /// <summary>
        /// 连接关闭时执行
        /// </summary>
        /// <param name="request"></param>
        /// <param name="connectionId"></param>
        /// <returns></returns>
        protected override Task OnDisconnected(IRequest request, string connectionId)
        {
            //原子操作,防止多条现成同时-1而只做一次变化
            Interlocked.Decrement(ref _connections);
            return Connection.Broadcast(connectionId + " 连接关闭. 当前连接数: " + _connections);
        }
        /// <summary>
        /// 连接开始时执行
        /// </summary>
        /// <param name="request"></param>
        /// <param name="connectionId"></param>
        /// <param name="data"></param>
        /// <returns></returns>
        protected override Task OnReceived(IRequest request, string connectionId, string data)
        {
            var message = connectionId + ">> " + data;
            return Connection.Broadcast(message);
        }
    }
}

我们定义了一个EchoConnection类继承PersistentConnetion,并写了OnConnected、OnDisconnected、OnReceived、三个方法,大致功能是当客户端连接时,服务器会通过Send()方法向它打招呼,参数是他的ConnectionId,并发送广播消息给所有客户端,并使总连接数+1,当客户端关闭连接时,服务器会广播给所有客户端XXX连接关闭,并使总连接数-1

客户端实现


<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>persistent connections</title>
    <script src="Scripts/jquery-1.10.2.min.js"></script>
    <script src="Scripts/jquery.signalR-2.0.0.min.js"></script>
</head>
<body>
    <h1>Echo service</h1>
    <div>
        <input type="text" id="text" />
        <button id="send">Send</button>
    </div>
    <script>
        $(function () {
            var connection = $.connection("/echo");
            connection.logging = true;

            connection.received(function (data) {
                $("body").append(data + "<br />");
            });

            connection.error(function (err) {
                alert("存在一个错误. \n" +
                            "Error: " + err.message);
            });

            connection.start().done(function () {
                $("#send").click(function () {
                    connection.send($("#text").val());
                    $("#text").val("").focus();
                });
            });
        });
    </script>
</body>
</html>