SignalR的高频实时通讯

英文渣水平,大伙凑合着看吧……

这是微软官方SignalR 2.0教程Getting Started with ASP.NET SignalR 2.0系列的翻译,这里是第七篇:SignalR的高频实时通讯

原文:Tutorial: High-Frequency Realtime with SignalR 2.0

概述

本教程演示如何创建一个对象与其他浏览器共享实时状态的应用程序。我们要穿件的应用程序为MoveShape,该MoveShape页面会显示一个Html Div元素,用户可以拖动。并且在用户拖动时,该元素的新位置被发送到服务器,这样其他所有已连接的客户端都会同步更新该元素的位置。

这个教程中使用的应用程序是基于迪米安·爱德华兹的Demo制作的,你可以在这里看到该视频。

本教程将演示从形状的拖动事件引发时如何发送SignalR消息开始,至每个已连接的客户端将接收该消息并更新本地形状的位置。

虽然使用这种方法能够很好的对SignalR的功能进行演示,但这不是一个推荐的编程模型。因为没有限制发送消息的上限,所以客户端和服务器会发送与接收大量的消息,最终导致性能的下降。同时客户端上形状的动画也会被打乱,因为每次接收到位置后形状的位置会由方法立即更新,而不是平滑的移动到新位置。本教程的后面部分将演示如何创建一个定时器功能,限制该消息在客户端和服务器之间发送更新消息的最大频率。本教程中创建的应用程序的最终版本可以在这里下载。

创建项目并添加SignalR和jQuery.UI NuGet包

在本节中,我们使用VS2013来创建项目。

下面演示使用VS2013来创建一个空的ASP.NET应用程序项目,并添加SignalR和jQuery库:

1.在VS2013中创建一个ASP.NET WEB应用程序。

2.在新的ASP.NET项目窗口中,选择空项目并创建。

3.在解决方案资源管理器中,右击该项目,添加一个SignalR集线器类(V2),将该类命名为MoveShapeHub.cs并将其添加到项目中,此步骤创建MoveShapeHub类,并将SignalR脚本和程序集引用添加到该项目中。

注意:您同样可以用库软件包管理器来添加SignalR引用,可以参见前面的教程。

4.使用库软件包管理器来添加jQueryUI。

在程序包管理器控制台中,运行以下命令:

Install-Package jQuery.UI.Combined

该步将jQuery.UI库添加到项目中。

5.在解决方案资源管理器中展开脚本文件夹,你可以看到SignalR和jQuery脚本已经被添加到项目中。

创建基础应用程序

在本节中,我们将创建在客户端中鼠标移动事件触发时将形状的位置发送到服务器的应用程序。至于创建服务器广播该消息给所有其它已连接的客户端的功能,我们将在后面的章节继续。 现在把注意力集中在集线器类的创建上。

1.如果在之前您使用包控制台来添加SignalR,请先添加MoveShapeHub类到项目中。

2.使用下面的代码替换掉MoveShapeHub中的:

 using Microsoft.AspNet.SignalR;
 using Newtonsoft.Json;
 
 namespace MoveShapeDemo
 {
     public class MoveShapeHub : Hub
     {
         public void UpdateModel(ShapeModel clientModel)
         {
             clientModel.LastUpdatedBy = Context.ConnectionId;
             // Update the shape model within our broadcaster
             Clients.AllExcept(clientModel.LastUpdatedBy).updateShape(clientModel);
         }
     }
     public class ShapeModel
     {
         // We declare Left and Top as lowercase with 
         // JsonProperty to sync the client and server models
         [JsonProperty("left")]
         public double Left { get; set; }
         [JsonProperty("top")]
         public double Top { get; set; }
         // We don't want the client to get the "LastUpdatedBy" property
         [JsonIgnore]
         public string LastUpdatedBy { get; set; }
     }
 }

MoveShapeHub是SignalR集线器类的一个实现。在入门教程中,我们使用了客户端直接调用的方法。在这本教程中,客户端将会发送一个包含形状的新的X及Y坐标点对象到服务器上,并且被广播给其他所有已连接的客户端。SignalR将使用JSON来序列化该对象。

我们创建了一个ShapeModel类来作为坐标属性的容器,它包含了形状位置的信息。同时,我们需要指定那些客户单仅仅作为消息的接收端。所以服务器上的对象还包含一个成员跟踪那些客户端的数据被储存。这样,指定的客户端才不会发送它自己的形状坐标数据到服务器上。该成员使用JsonIgnore属性,防止它被序列化并被发送到客户端。

在应用程序启动时启用集线器

1.我们将把设置在应用程序启动时,自动启用集线器映射。在SignalR 2.0中,这是通过增加OWIN启动类来实现的。启动类在类的配置方法中会调用MapSignalR方法,同时启动类会使用Assembly特性来将启动类注册到OWIN的启动处理过程中。

在解决方案资源管理器中,添加一个OWIN启动类,将其命名为Startup并添加。

2.使用以下的代码替换Startup类的内容:

 using Microsoft.Owin;
 using Owin;
 
 [assembly: OwinStartup(typeof(MoveShapeDemo.Startup))]
 namespace MoveShapeDemo
 {
     public class Startup
     {
         public void Configuration(IAppBuilder app)
         {
             // Any connection or hub wire up and configuration should go here
             app.MapSignalR();
         }
     }
 }
     

添加客户端

1.接下来,我们将添加客户端。添加一个HTML页面并命名为Default.html到项目中。

2.在解决方案资源管理其中,右击刚刚添加的页面,点击设为起始页。

3.用下面的代码替换HTML页面中的:

 <!DOCTYPE html>
 <html>
 <head>
     <title>SignalR MoveShape Demo</title>
     <style>
         #shape {
             width: 100px;
             height: 100px;
             background-color: #FF0000;
         }
     </style>
 </head>
 <body>
 <script src="Scripts/jquery-1.10.2.min.js"></script>
 <script src="Scripts/jquery-ui-1.10.4.min.js"></script>
 <script src="Scripts/jquery.signalR-2.0.0.js"></script>
 <script src="/signalr/hubs"></script>
 <script>
  $(function () {
             var moveShapeHub = $.connection.moveShapeHub,
             $shape = $("#shape"),
             shapeModel = {
                 left: ,
                 top: 
             };
             moveShapeHub.client.updateShape = function (model) {
                 shapeModel = model;
                 $shape.css({ left: model.left, top: model.top });
             };
             $.connection.hub.start().done(function () {
                 $shape.draggable({
                     drag: function () {
                         shapeModel = $shape.offset();
                         moveShapeHub.server.updateModel(shapeModel);
                     }
                 });
             });
         });
 </script>
     
     <div id="shape" />
 </body>
 </html>

注意:请检查代码中所引用的脚本是否同脚本文件夹中的一致:

上面的HTML和JS代码创建了一个红色的Div,id为Shape。在Shape拖动时,将触发它的drag事件,并将Div的位置发送给服务器。

4.按下F5启动应用程序,复制页面的URL并打开一个新的浏览器,粘贴并打开,拖动一个浏览器的窗口中的形状,另一个浏览器的形状位置也将同步进行更新。

添加客户端循环

由于每一次移动鼠标都会发送位置信息到服务器端并进行广播,这将大大影响网络流量及程序的性能。我们需要对客户端的消息进行节流限制。我们将使用JS的setIntrval函数来设置一个固定速度的循环方法,使用该方法以固定的频率将形状的位置信息发送到服务器。这个循环是一个"游戏循环",一个被反复调用的函数,用于驱动所有需要定期检查或其他模拟功能的方法。

1.用以下代码更新HTML页的内容:

 <!DOCTYPE html>
 <html>
 <head>
 <title>SignalR MoveShape Demo</title>
 <style>
     #shape {
         width: 100px;
         height: 100px;
         background-color: #FF0000;
     }
 </style>
 </head>
 <body>
 <script src="Scripts/jquery-1.10.2.min.js"></script>
 <script src="Scripts/jquery-ui-1.10.4.min.js"></script>
 <script src="Scripts/jquery.signalR-2.0.1.js"></script>
 <script src="/signalr/hubs"></script>
 <script>
     $(function () {
         var moveShapeHub = $.connection.moveShapeHub,
             $shape = $("#shape"),
             // Send a maximum of 10 messages per second 
             // (mouse movements trigger a lot of messages)
             messageFrequency = , 
             // Determine how often to send messages in
             // time to abide by the messageFrequency
             updateRate = 1000 / messageFrequency, 
             shapeModel = {
                 left: ,
                 top: 
             },
             moved = false;
         moveShapeHub.client.updateShape = function (model) {
             shapeModel = model;
             $shape.css({ left: model.left, top: model.top });
         };
         $.connection.hub.start().done(function () {
             $shape.draggable({
                 drag: function () {
                     shapeModel = $shape.offset();
                     moved = true;
                 }
             });
             // Start the client side server update interval
             setInterval(updateServerModel, updateRate);
         });
         function updateServerModel() {
             // Only update server if we have a new movement
             if (moved) {
                 moveShapeHub.server.updateModel(shapeModel);
                 moved = false;
             }
         }
     });
 </script>
    
 <div id="shape" />
 </body>
 </html> 

我们创建了updateServerModel方法来使用一个固定频率将位置信息发送给服务器。当move标志位变动时,该函数才将信息传送给服务器。

2.按下F5运行,同样复制一个浏览器窗口,拖动一个窗口中的形状并观察另一个。这一次我们发送的数据将被节流,所以你可以看到动画将不如之前的那样平滑。

添加服务器循环

在目前的应用中,每当服务器接收到新消息时,都会将它们广播到所有客户端上。同客户端的问题一样:消息总是发送而不是在需要时才发送,并且连接可能被结果淹没。本节介绍如何更新服务器代码以实现节流传出消息的速率定时器。

1.使用以下代码更新MoveShapeHub:

 using System;
 using System.Threading;
 using Microsoft.AspNet.SignalR;
 using Newtonsoft.Json;
 
 namespace MoveShapeDemo
 {
     public class Broadcaster
     {
         private readonly static Lazy<Broadcaster> _instance = 
             new Lazy<Broadcaster>(() => new Broadcaster());
         // We're going to broadcast to all clients a maximum of 25 times per second
         private readonly TimeSpan BroadcastInterval = 
             TimeSpan.FromMilliseconds(); 
         private readonly IHubContext _hubContext;
         private Timer _broadcastLoop;
         private ShapeModel _model;
         private bool _modelUpdated;
         public Broadcaster()
         {
             // Save our hub context so we can easily use it 
             // to send to its connected clients
             _hubContext = GlobalHost.ConnectionManager.GetHubContext<MoveShapeHub>();
             _model = new ShapeModel();
             _modelUpdated = false;
             // Start the broadcast loop
             _broadcastLoop = new Timer(
                 BroadcastShape, 
                 null, 
                 BroadcastInterval, 
                 BroadcastInterval);
         }
         public void BroadcastShape(object state)
         {
             // No need to send anything if our model hasn't changed
             if (_modelUpdated)
             {
                 // This is how we can access the Clients property 
                 // in a static hub method or outside of the hub entirely
                 _hubContext.Clients.AllExcept(_model.LastUpdatedBy).updateShape(_model);
                 _modelUpdated = false;
             }
         }
         public void UpdateShape(ShapeModel clientModel)
         {
             _model = clientModel;
             _modelUpdated = true;
         }
         public static Broadcaster Instance
         {
             get
             {
                 return _instance.Value;
             }
         }
     }
         
     public class MoveShapeHub : Hub
     {
         // Is set via the constructor on each creation
         private Broadcaster _broadcaster;
         public MoveShapeHub()
             : this(Broadcaster.Instance)
         {
         }
         public MoveShapeHub(Broadcaster broadcaster)
         {
             _broadcaster = broadcaster;
         }
         public void UpdateModel(ShapeModel clientModel)
         {
             clientModel.LastUpdatedBy = Context.ConnectionId;
             // Update the shape model within our broadcaster
             _broadcaster.UpdateShape(clientModel);
         }
     }
     public class ShapeModel
     {
         // We declare Left and Top as lowercase with 
         // JsonProperty to sync the client and server models
         [JsonProperty("left")]
         public double Left { get; set; }
         [JsonProperty("top")]
         public double Top { get; set; }
         // We don't want the client to get the "LastUpdatedBy" property
         [JsonIgnore]
         public string LastUpdatedBy { get; set; }
     }
     
 }

上面的代码新增了Broadcaster类,它使用.Net框架中的Timer类来对发送消息进行节流。

由于集线器本身是暂时存在的(每次需要时才创建),Broadcaster被创建为一个单例。使用了延迟初始化(.Net4中新增功能),来推迟其创建时间直到需要它为止。这是为了确保在计时器开始之前就有集线器的实例被成功创建完毕。

调用客户端的updateShape功能被移出集线器的updateModel方法,所有消息传入后它将不再立即被调用。相反,需要发送至客户端的消息会以每秒25次的频率进行发送。Broadcaster类中的_broadcastLoop计时器来承担发送频率的管理功能。

最终,集线器并不直接调用客户端方法,Broadcaster类需要使用GlobalHost来获得一个引用当前正在运行的操作集线器(_hubContext)。

2.按F5启动应用程序,复制窗口并拖动,将不会同上一节中的效果有太大差别。但在后台,我们已经对发送到客户端的消息进行了节流限制。

为客户端加入流畅的动画效果

这个应用程序已经很完善了,但我们还需要做进一步的改进。客户端的形状移动是由接收到服务器消息而进行的,我们将使用jQuery UI库的animate功能来优化形状的移动效果,而不是直接使用服务器提供的新位置来改变形状的当前位置。

1.使用下面的代码更新HTML页面:

 <!DOCTYPE html>
 <html>
 <head>
     <title>SignalR MoveShape Demo</title>
     <style>
         #shape {
             width: 100px;
             height: 100px;
             background-color: #FF0000;
         }
     </style>
 </head>
 <body>
 <script src="Scripts/jquery-1.10.2.min.js"></script>
 <script src="Scripts/jquery-ui-1.10.4.min.js"></script>
 <script src="Scripts/jquery.signalR-2.0.0.js"></script>
 <script src="/signalr/hubs"></script>
 <script>
         $(function () {
             var moveShapeHub = $.connection.moveShapeHub,
                 $shape = $("#shape"),
                 // Send a maximum of 10 messages per second 
                 // (mouse movements trigger a lot of messages)
                 messageFrequency = , 
                 // Determine how often to send messages in
                 // time to abide by the messageFrequency
                 updateRate = 1000 / messageFrequency, 
                 shapeModel = {
                     left: ,
                     top: 
                 },
                 moved = false;
             moveShapeHub.client.updateShape = function (model) {
                  shapeModel = model;
                  // Gradually move the shape towards the new location (interpolate)
                  // The updateRate is used as the duration because by the time 
                  // we get to the next location we want to be at the "last" location
                  // We also clear the animation queue so that we start a new 
                  // animation and don't lag behind.
                  $shape.animate(shapeModel, { duration: updateRate, queue: false });
             };
             $.connection.hub.start().done(function () {
                 $shape.draggable({
                     drag: function () {
                         shapeModel = $shape.offset();
                         moved = true;
                     }
                 });
                 // Start the client side server update interval
                 setInterval(updateServerModel, updateRate);
             });
             function updateServerModel() {
                 // Only update server if we have a new movement
                 if (moved) {
                     moveShapeHub.server.updateModel(shapeModel);
                     moved = false;
                 }
             }
         });
 </script>
    
     <div id="shape" />
 </body>
 </html> 

上面的代码将使用动画来把形状移动到新的位置上,在此例中,我们使用100毫秒作为动画间隔。

2.按下F5启动应用程序,复制窗口并拖动,你可以看到形状的移动比之前更流畅。形状每次移动是随着时间进行插补而不是每当有消息传入就立即更新一次。

下一步

在本教程中,您学习了如何编写客户端同服务器端高频实时通讯的SignalR应用,这种通信模式被经常用来开发网络游戏。比如:the ShootR game created with SignalR

作者: 帕特里克·弗莱彻 -帕特里克·弗莱彻是ASP.NET开发团队的程序员,作家,目前正在SignalR项目工作。