• 在 Asp.NET MVC 中使用 SignalR 实现推送功能


     

    一,简介

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

    参考自飘飘白云博客:http://blog.csdn.net/kesalin/article/details/8166925

    二,实现机制

    SignalR 的实现机制与 .NET WCF 或 Remoting 是相似的,都是使用远程代理来实现。在具体使用上,有两种不同目的的接口:PersistentConnection 和 Hubs,其中 PersistentConnection 是实现了长时间的 Javascript 轮询(类似于 Comet),Hub 是用来解决实时信息交换问题,它是利用 Javascript 动态载入执行方法实现的。SignalR 将整个连接,信息交换过程封装得非常漂亮,客户端与服务器端全部使用 JSON 来交换数据。

    下面就 Hubs 接口的使用来讲讲整个流程:

    1,在服务器端定义对应的 hub class;

    2,在客户端定义 hub class 所对应的 proxy 类;

    3,在客户端与服务器端建立连接(connection);

    4,然后客户端就可以调用 proxy 对象的方法来调用服务器端的方法,也就是发送 request 给服务器端;

    5,服务器端接收到 request 之后,可以针对某个/组客户端或所有客户端(广播)发送消息。

    三,Hub 示例教程

    1,工具准备

    SignalR 运行在 .NET 4.5 平台上,所以需要安装 .NET 4.5。为了方便演示,本示例使用 ASP.NET MVC 在 Win 7 系统来实现。这需要安装 ASP.NET MVC 3 或 ASP.NET MVC 4

    2,安装 SignalR

    打开 NuGet 的 package manager console(Tools->Library package manager),输入:install-package SignalR.Sample,回车安装。如图所示:

    3,实现 Hub 服务器端代码

    向工程中新建 SignalR 目录,在其中添加 ChatHub.cs 文件,内容如下:

    namespace SignalTutorial.SignalR
    {
        [HubName("chat")]
        public class Chat : Hub
        {
            public void Send(string clientName, string message)
            {
                //var toSelfinfo = "You had sent message " + message;
                //Caller.addSomeMessage(clientName, toSelfinfo);
    
                // Call the addMessage method on all clients
                Clients.All.addSomeMessage(clientName, message);
                //Clients[Context.ConnectionId].addSomeMessage(clientName, data);
            }
        }
    }

    在上面的代码中:

    1),HubName 这个特性是为了让客户端知道如何建立与服务器端对应服务的代理对象,如果没有设定该属性,则以服务器端的服务类名字作为 HubName 的缺省值;

    2),Chat 继承自 Hub,从下面 Hub 的接口图可以看出:Hub 支持向发起请求者(Caller),所有客户端(Clients),特定组(Group) 推送消息。

    3),public void Send(string clientName, string message) 这个接口是被客户端通过代理对象调用的;

    4),Clients 是 Hub 的属性,表示所有链接的客户端页面,它和 Caller 一样是 dynamic,因为要直接对应到 Javascript 对象;

    5),Clients.addSomeMessage(clientName, message); 表示服务器端调用客户端的 addSomeMessage 方法,这是一个 Javascript 方法,从而给客户端推送消息。

    6),总结:这里实现的服务很简单,就是当一个客户端调用 Send 方法向服务器发送 message 后,服务器端负责将该 message 广播给所有的客户端(也可以给特定组或特定客户端,见屏蔽代码),以实现聊天室的功能。

    4,实现 Hub 客户端代码

    1),引用 SignalR Javascript

    为了简化引用 SignalR 脚本操作,我直接在 View/Shared/_Layout.cshtml 中引入 SignalR 及其他脚本:

    <head>
            <meta charset="utf-8" />
            <title>@ViewBag.Title</title>
            <link href="@Url.Content("~/Content/Site.css")" rel="stylesheet" type="text/css" />
            <script src="@Url.Content("~/Scripts/jquery-1.5.1.min.js")" type="text/javascript"></script>
            <script src="@Url.Content("~/Scripts/jquery-1.6.4.js")" type="text/javascript"></script>
            <script src="@Url.Content("~/Scripts/jquery-ui-1.8.24.js")" type="text/javascript"></script>
            <script src="@Url.Content("~/Scripts/jquery.signalR-0.5.3.js")" type="text/javascript"></script>
            <script src="@Url.Content("~/Scripts/modernizr-1.7.min.js")" type="text/javascript"></script>
            <script src="@Url.Content("~/signalr/hubs")" type="text/javascript"></script>
        </head>

    注意:signalR 依赖于 jquery,所以 signalR 必须放在 jquery 之后,而 hubs 又必须放在 signalR 之后。

    然后在 body 部分加入 HubChat Tab:

    <li>@Html.ActionLink("HubChat", "HubChat", "Home")</li>
    2),生成访问页面

    在 HomeController 中添加如下方法:

    public ActionResult HubChat()
    {

         Random ro = new Random();
         ViewBag.ClientName = "用户-" + ro.Next(10000, 99999);
         return View();

    }

    这里由服务器根据随机数来设定客户端的名字,不够严谨,因为随机数生成的名字不是唯一的的,在这里仅为简化演示,实际应用中应该使用 GUID 。

    然后生成对应的 View:HubChat.cshtml

    @model dynamic
    
    @{
        ViewBag.Title = "title";
    }
    
    <script src="@Url.Content("~/Scripts/hubDemo.js")" type="text/javascript"></script>
    <script type="text/javascript">
        $(document).ready(function () {
        });
    </script>
    
    <h2>Hub Chat</h2>
    
    <div>
        <input type="text" id="Placeholder" value="@ViewBag.ClientName" hidden="true"/>
        <input type="text" id="msg" />
        <input type="button" id="broadcast" value="广播" />
        
        <br />
        <br />
    
        <h3>
            消息记录: (你是:<span id="MyClientName">@ViewBag.ClientName</span>):
        </h3>
    
        <ul id="messages">
        </ul>
    </div>

    在上面的页面代码中,我添加了名为 hubDemo.js 的脚本,这将在下面介绍;此外还有一个id 为 Placeholder 的隐藏 input 控件,这是为了向 Javascript 中传递客户端的名字。

    3),编写 Javascript

    向 Scripts 目录添加新的 Javescript 脚本:hubDemo.js。其内容如下:

    $(function () {

    var myClientName = $('#Placeholder').val();

    // Proxy created on the fly
    var chat = $.connection.chat;

    // Declare a function on the chat hub so the server can invoke it
    chat.client.addSomeMessage = function (clientName, message) {
    writeEvent('<b>' + clientName + '</b> 对大家说: ' + message, 'event-message');
    };

    $("#broadcast").click(function () {
    // Call the chat method on the server
    chat.server.send(myClientName, $('#msg').val())
    .done(function () {
    console.log('Sent message success!');
    })
    .fail(function (e) {
    console.warn(e);
    });
    });

    // Start the connection
    $.connection.hub.start();

    //A function to write events to the page
    function writeEvent(eventLog, logClass) {
    var now = new Date();
    var nowStr = now.getHours() + ':' + now.getMinutes() + ':' + now.getSeconds();
    $('#messages').prepend('<li class="' + logClass + '"><b>' + nowStr + '</b> ' + eventLog + '.</li>');
    }
    });

    上面代码有详细的注释,下面再讲讲关键之处:

    1,首先获取客户端页面的名字;

    2,然后通过 $.connection.chat 建立对应服务器端 Hub 类的代理对象 chat;

    3,定义客户端的 Javascript 方法 addSomeMessage ,服务器通过 dynamic 方式调用客户端的该方法以实现推送功能。在这里每当收到服务器推送来的消息,就在客户端页面的 messages 列表表头插入该消息。

    4,当点击广播按钮时,客户端通过代理对象调用服务器端的 send 方法以实现向服务器发送消息。

    5,通过 $.connection.hub.start(); 语句打开链接。

    5),编译运行 Hub 报错

    解决方案:打开文件SignalRange.Simpal/Startup.cs文件

    using Microsoft.Owin;
    using Owin;
    
    [assembly: OwinStartupAttribute(typeof(Microsoft.AspNet.SignalR.StockTicker.Startup), "Configuration")]
    namespace Microsoft.AspNet.SignalR.StockTicker
    {
    
        public static class Startup
        {
            public static void ConfigureSignalR(IAppBuilder app)
            {
                app.MapSignalR();
            }
    
            public static void Configuration(IAppBuilder app)
            {
                Microsoft.AspNet.SignalR.StockTicker.Startup.ConfigureSignalR(app);
            }
        }
    }

    6),编译运行 Hub 示例

    在多个浏览器窗口打开页面,效果如下:

  • 相关阅读:
    wzplayer for android V1.5 整合硬解码(仍然支持加密音视频)
    mac osx 快捷键
    从零开始学AS3游戏开发【七】永无终结,不断完善的游戏
    flash flex as3 类库 资料大全
    php include一个有全局变量的应注意
    MySQL事件调度器 CREATE EVENT
    The Miner – 专业Flash AS3性能分析器(profiler)入门教程
    as3加密入门1使用alchemy进行代码混淆
    从零开始学AS3游戏开发【五】 告别方块,添加碰撞
    PHP实现的Mysql读写分离
  • 原文地址:https://www.cnblogs.com/tengchong/p/5353973.html
Copyright © 2020-2023  润新知