第二节. SignalR开篇以及如何指定传输协议

时间 2019-12-02

标签第二 signalr 开篇以及如何指定传输协议栏目快乐工作繁體版

原文原文链接

一. 声明　javascript

　　该节主要介绍SignalR的一些理论知识，代码量很小，在后续章节编写中，会不断回来更新该节，完善该节的介绍；待该系列结束时，该节会和目录章节合并。

　　下面的理论介绍相对枯燥，但对于后面的理解有必定意义，不感兴趣的朋友能够右上角离开了，从下一节开始，正式开始撸代码。

　　原计划三天更新一篇，结果周五下班前忘记提交代码了，加上周六公司组织活动，该系列推迟一天，今天大清早跑到公司，务必也要写完这一节，这里分享一下昨天公司组织活动拍摄的照片。html

　　上面废话说多了，下面进入正题。前端

二. SignalR简介java

　　SignalR是微软的一个开源项目，为客户端和服务器端实时通信的问题提供了很好的解决方案，经过简单的配置和API调用，便可完成相应的通信功能的开发。jquery

　　(PS：截止目前【2018-07-08】最新版本为 2.3.0，GitHub地址为：https://github.com/SignalR/SignalR)git

　前面一节提到已经有了WebSocket，那么为何还要SignalR呢？github

　　首先WebSocket兼容性存在问题，针对这一点，SignalR对目前为止几类主流的传输协议进行了封装，让浏览器自行选择能够兼容的版本（固然也能够自行指定），这样就解决了开发者使用WebSocket时候的痛点了。web

SignalR大一统：浏览器

　　它封装了 WebSocket、ForeverFrame、ServerSentEvents、LongPolling四种主要的传输协议。服务器

　　① WebSocket：它是HTML5提供的一种在单个 TCP 链接上进行全双工通信的协议。

　　② ForeverFrame(永久帧)：它适用于IE浏览器，是在页面中插入一个隐藏的iframe，利用其src属性在服务器和客户端之间建立一条长连接，服务器向iframe传输数据（一般是HTML，内有负责插入信息的javascript），来实时更新页面。

　　③ SeverSentEvents（服务器发送事件，也成EventSourse）：顾名思义。

　　④ longPolling(Ajax长轮询)：长轮询是对轮询的改进，客户端经过请求链接到服务器，并保持一段时间的链接状态，直到消息更新或超时才返回Response并停止链接，能够有效减小无效请求的次数。

　　如何指定传输协议：

　　(1). 默认选择：conn.start().done(function () {});

　　(2). 手动指定：conn.start({ transport: 'serverSentEvents' }).done(function () {});

　　　注. 可选参数有：webSockets、foreverFrame、serverSentEvents、longPolling

　　 (3). 手动指定多个，若是不兼容，依次向后选择：conn.start({ transport: ['foreverFrame','webSockets'] }).done(function () {});

这里简单分享一下我这里使用的代码，不介绍了后面章节有详细的介绍。

前端代码：

 1 @{
 2     Layout = null;
 3 }
 4 
 5 <!DOCTYPE html>
 6 
 7 <html>
 8 <head>
 9     <meta name="viewport" content="width=device-width" />
10     <title>Index</title>
11     <script src="~/Scripts/jquery-3.3.1.min.js"></script>
12     <script src="~/Scripts/jquery.signalR-2.3.0.js"></script>
13     <script type="text/javascript">
14         $(function () {
15             var conn = $.connection("/myPreConnection1");
16             //开启日志
17             conn.logging = true;
18 
19             //1. 默认的形式选择
20             conn.start().done(function () {
21 
22             });
23 
24             //2. 手动指定通信方式
25             //webSockets、foreverFrame、serverSentEvents、longPolling
26             //conn.start({ transport: 'serverSentEvents' }).done(function () {
27 
28             //});
29 
30             //3. 手动指定多个通信方式，按顺序选择(第一个不支持的话，依次日后类推)
31             //conn.start({ transport: ['foreverFrame','webSockets'] }).done(function () {
32 
33             //});
34 
35         });
36     </script>
37 </head>
38 <body>
39     <div>
40     </div>
41 </body>
42 </html>

View Code

OWIN Startup Class：

 1 using System;
 2 using System.Threading.Tasks;
 3 using Microsoft.Owin;
 4 using Owin;
 5 
 6 [assembly: OwinStartup(typeof(SignalRDemo.Startup))]
 7 
 8 namespace SignalRDemo
 9 {
10     public class Startup
11     {
12         public void Configuration(IAppBuilder app)
13         {
14             // 有关如何配置应用程序的详细信息，请访问 https://go.microsoft.com/fwlink/?LinkID=316888
15 
16             app.MapSignalR<MyPresitentConnection1>("/myPreConnection1");
17         }
18     }
19 }

View Code

永久链接模型类

 1 using System;
 2 using System.Collections.Generic;
 3 using System.Linq;
 4 using System.Threading.Tasks;
 5 using System.Web;
 6 using Microsoft.AspNet.SignalR;
 7 
 8 namespace SignalRDemo
 9 {
10     public class MyPresitentConnection1 : PersistentConnection
11     {
12         //下面的两个方法OnConnected 和 OnReceived默认带的
13 
14         /// <summary>
15         /// 链接成功后的方法(已测试)
16         /// </summary>
17         /// <param name="request"></param>
18         /// <param name="connectionId"></param>
19         /// <returns></returns>
20         protected override Task OnConnected(IRequest request, string connectionId)
21         {
22             return Connection.Send(connectionId, "Welcome!");
23         }
24 
25         /// <summary>
26         /// 接收请求的方法(已测试)
27         /// </summary>
28         /// <param name="request"></param>
29         /// <param name="connectionId"></param>
30         /// <param name="data"></param>
31         /// <returns></returns>
32         protected override Task OnReceived(IRequest request, string connectionId, string data)
33         {
34             return Connection.Broadcast(data);
35         }
36 
37     }
38 }

View Code

测试一下：

① 默认的形式

② 手动指定

　　能够自行去测试不一样浏览器不一样版本兼容哪些协议，这里就不在过多测试了。

　　若是不指定协议，默认选择传输的协议的顺序为：

三. 两种通信模型

　　SignalR客户端和服务器端通信有两种模型：分别是永久链接模型(PresistentConnection)和中心模型(Hubs)，其中永久链接更加偏向底层，代码编写与原生的WebSocket很像，我我的不是很喜欢这种模式；中心模型Hubs更像面向开发者的模式，它实质上是对PresitentConnection作了封装，使其更加友好，我的很是推荐这种模式，该模式有一个很是好的地方，它容许客户端和服务器端自定义方法而后相互之间调用。

　　(1). PresistentConnection：用于单个发件人、分组、广播消息的简单终结点，开发人员经过使用持久性链接Api，直接访问SignalR公开的底层通讯协议。

　　(2). Hub: 基于永久链接之上更高层的封装，它容许客户端和服务器端自定义方法而且相互调用，它还容许将强类型的参数传递给方法而且绑定模型。

　　下面能够很好的说明这两种模式的关系

　　简单看看PresitentConnection模型的代码和WebSocket确实有点像。

 1     <script type="text/javascript">
 2         $(function () {
 3             var conn = $.connection("/myPreConnection1");
 4             //1. 开启链接
 5             conn.start().done(function () {
 6 
 7             });
 8             //2. 接受服务器发来的消息
 9             conn.received(function (data) {
10                 console.log(data);
11             });
12             //3. 链接断开的方法
13             conn.disconnected(function () {
14                 $("#j_notice").html("链接中断");
15             });
16 
17 
18             //断开链接事件
19             $("#j_close").click(function () {
20                 conn.stop();
21             });
22 
23             //群发事件
24             $("#j_send").click(function () {
25                 conn.send("你好啊");
26             });
27 
28         });
29     </script>

View Code

 1 using System;
 2 using System.Collections.Generic;
 3 using System.Linq;
 4 using System.Threading.Tasks;
 5 using System.Web;
 6 using Microsoft.AspNet.SignalR;
 7 
 8 namespace SignalRDemo
 9 {
10     public class MyPresitentConnection1 : PersistentConnection
11     {
12         //下面的两个方法OnConnected 和 OnReceived默认带的
13 
14         /// <summary>
15         /// 链接成功后的方法(已测试)
16         /// </summary>
17         /// <param name="request"></param>
18         /// <param name="connectionId"></param>
19         /// <returns></returns>
20         protected override Task OnConnected(IRequest request, string connectionId)
21         {
22             return Connection.Send(connectionId, "Welcome!");
23         }
24 
25         /// <summary>
26         /// 接收请求的方法(已测试)
27         /// </summary>
28         /// <param name="request"></param>
29         /// <param name="connectionId"></param>
30         /// <param name="data"></param>
31         /// <returns></returns>
32         protected override Task OnReceived(IRequest request, string connectionId, string data)
33         {
34             return Connection.Broadcast(data);
35         }
36 
37         /// <summary>
38         /// 链接中断调用方法(已测试)
39         /// </summary>
40         /// <param name="request"></param>
41         /// <param name="connectionId"></param>
42         /// <param name="stopCalled"></param>
43         /// <returns></returns>
44         protected override Task OnDisconnected(IRequest request, string connectionId, bool stopCalled)
45         {
46             return base.OnDisconnected(request, connectionId, stopCalled);
47         }
48 
49         /// <summary>
50         /// 当链接在超时后从新链接时调用该方法
51         /// </summary>
52         /// <param name="request"></param>
53         /// <param name="connectionId"></param>
54         /// <returns></returns>
55         protected override Task OnReconnected(IRequest request, string connectionId)
56         {
57             return base.OnReconnected(request, connectionId);
58         }
59     }
60 }

View Code

四. 一些环境的要求

1. .Net Framework的版本

　　SignalR 2 起仅支持在 .Net FrameWork 4.5及以上。

2. 操做系统

　　Win七、Win八、Win十、WinServer 2008 R二、WinServer 20十二、WinServer 2016.

　　注：若是SignalR使用WebSocket协议，须要配置启动Web套接字。

3. IIS版本

　　首先IIS必须使用集成模式，不支持经典模式，另外若是SignalR使用WebSocket协议的话，必须使用IIS8及以上。

　　注：程序必须在彻底信任的模式下运行。

4. web浏览器对传输协议的要求

　　首先配合使用的JQuery版本需在 1.6.4 及以上。

5. 桌面程序对传输协议的要求

　　该节到此结束，写了大约两个小时，下一个章节开始撸代码，先介绍PresistentConnection这种模式，大约下周二(2018-7-10)更新，感兴趣的朋友能够关注一下，相互学习。　　

做者 : Yaopengfei(姚鹏飞)
博客地址 : http://www.cnblogs.com/yaopengfei/
声明1 : 本人才疏学浅，用郭德纲的话说“我是一个小学生”，若有错误，欢迎讨论，请勿谩骂^_^。
声明2 : 原创博客请在转载时保留原文连接或在文章开头加上本人博客地址，如需代码请在评论处留下你的邮箱