AjaxSignalR来开实时Web聊天

本章和豪门大饱眼福的情节是行使Signal
R框架创建个简单的群聊功能,主要教授如何在.Net的MVC中使用这个框架,由于这类型起合法文档(当然都英文),后面呢无打算写分享篇了,主要目的是让爱人等在急需使用Web实时通信的时光发出再度多一致栽缓解方案,毕竟这是微软主推的平等种植缓解方案之一。

SignalR网上简介

ASP.NET SignalR 是啊 ASP.NET
开发人员提供的一个仓房,可以简化开发人员用实时 Web
功能丰富到应用程序的长河。实时 Web
功能是因这样平等栽功效:当所连接的客户端转移得可用时服务器代码可以马上往其推送内容,而休是被服务器等客户端请求新的数量。

SignalR当然也供了非常简单易用底高阶API,使劳动器端可以么或批量调用客户端上的JavaScript函数,并且非常
方便地拓展连续管理,例如客户端连接到服务器端,或断开连接,客户端分组,以及客户端授权,使用SignalR都颇
容易实现。

SignalR将同客户端进行实时通信带来被了ASP .NET
。当然如此既好用,而且为起足够的扩展性。以前用户需刷新页面或用Ajax轮询才能够落实的实时显示数据,现在只要采取SignalR,就可简简单单实现了。最紧要的凡您无需更成立项目,使用现有ASP
.NET项目即可无缝使用SignalR。

群聊实例效果

咋们先来探测试用例的效应吧,这里是线及效果链接:神牛聊天室(http://lovexins.com:1001/home/shenniuchat),效果图:

Ajax 1

界面及其简单,样式这里虽不考虑了,主要是显得其故法,这里涉及到的效用来:

1. 统计于线人数量

2.
展示在线人数之昵称和连续方式(本测试用例支持webSockets和longPolling(长连))

  1. 群聊信息

MVC中哪利用SignalR

率先,我们平常做法创建MVC的Web项目,然后经过Nuget控制高命令: Install-package
Microsoft.AspNet.SignalR 加入SignalR的指,自动抬高的包如下:

  <package id="Microsoft.AspNet.SignalR" version="2.2.2" targetFramework="net45" />
  <package id="Microsoft.AspNet.SignalR.Core" version="2.2.2" targetFramework="net45" />
  <package id="Microsoft.AspNet.SignalR.JS" version="2.2.2" targetFramework="net45" />
  <package id="Microsoft.AspNet.SignalR.SystemWeb" version="2.2.2" targetFramework="net45" />

再就是自动往MVC项目遭到之Script文件夹着长有关的js文件:

jquery.signalR-2.2.2.min.js
jquery.signalR-2.2.2.js

接下来,我们用在品种一级目录创建一个文件名称为Startup.cs的类似,里面要内容补充全无生:

 1 [assembly: OwinStartup(typeof(Stage.Api.Extend.Startup))]
 2 namespace Stage.Api.Extend
 3 {
 4     public class Startup
 5     {
 6         public void Configuration(IAppBuilder app)
 7         {
 8             app.MapSignalR("/chat", new Microsoft.AspNet.SignalR.HubConfiguration
 9             {
10                 EnableDetailedErrors = true,
11                 EnableJavaScriptProxies = true
12             });
13         }
14     }
15 }

率先我们由高达通往下分析注意点:

  1.  OwinStartup(Type) 构造函数传递的凡一个品类,而之类型对应之尽管是咱创建的Startup类,这个通过者构造函数类标志起始位置;

  2.  namespace
    Stage.Api.Extend 是自身种之命名空间,这个得无定义;

  3.  public void Configuration(IAppBuilder
    app) 函数是定点必须的,这里先后会率先登这方式执行中的逻辑代码;

4.  app.MapSignalR 是扩张的IAppBuilder接口方法,他起强表现形式,这里自己选的是 public static IAppBuilder MapSignalR(this IAppBuilder builder, string path, HubConfiguration
configuration); ,这里关押有点类似于咋们MVC的路由,这里要注意的凡这Path参数,在前者页面的时节需要因此到之路;

交此处后台需要的布其实已经就是得了,下面是切实可行需要操作的业务逻辑处理类似,新建一个看似(这里自己取名为ChatHub)并继承Hub(这是SignalR框架提供),然后中间的逻辑代码如下:

 1 public class ChatHub : Hub
 2     {
 3         //
 4         public int Num = 10001;
 5         public static List<MoHubUser> _Users = new List<MoHubUser>();
 6 
 7         /// <summary>
 8         /// 添加聊天人
 9         /// </summary>
10         /// <param name="user"></param>
11         public void AddUser(MoHubUser user)
12         {
13 
14             user.Id = Context.ConnectionId;
15             if (!_Users.Any(b => b.Id == user.Id))
16             {
17                 _Users.Add(user);
18             }
19 
20             //Clients.All.newUser(user);
21             Clients.All.userList(_Users);
22         }
23 
24         /// <summary>
25         /// 发送信息
26         /// </summary>
27         /// <param name="user"></param>
28         /// <param name="message"></param>
29         public void SendAll(MoHubUser user, string message)
30         {
31             Clients.All.addNewMessageToPage(user, message);
32         }
33 
34         /// <summary>
35         /// 某个聊天人退出是,通知所有在线人重新加载聊天人数
36         /// </summary>
37         /// <param name="stopCalled"></param>
38         /// <returns></returns>
39         public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled)
40         {
41             var user = _Users.SingleOrDefault(x => x.Id == Context.ConnectionId);
42             if (user != null)
43             {
44                 _Users.Remove(user);
45                 Clients.All.userList(_Users);
46             }
47             return base.OnDisconnected(stopCalled);
48         }
49     }

点的3单主意分别做了:添加聊天人及List,发送信息到客户端,某个连接失效后通报顺序有效之聊天人重新加载信息;这里值得关注的凡由此重复 public override System.Threading.Tasks.Task
OnDisconnected(bool
stopCalled) 方法来实现捕获并移除失效连接(这里是聊天人的音);整篇测试用例通过Context.ConnectionId来保管连接的唯一性,只要发生新的链接求,那么服务端就会分配一个唯一串给这个链接,当客户端关闭页面或关闭链接是是发出就是能够在OnDisconnected方法吃抓获到是失效的链接的ConnectionId,这样便高达了移除失效聊天人的求了;为了代码的方便性,这里开创了一个聊天人信息类:

1  public class MoHubUser
2     {
3 
4         public string Id { get; set; }
5         public string NickName { get; set; }
6         public string TransportMethod { get; set; }
7     }

及这边后台的聊天室代码就到位了就是这样简单;我们还来拘禁试图中争来形容代码,这里自己先被起我之html布局代码:

 1 @{
 2     ViewBag.Title = "神牛聊天室 - SignalR";
 3 }
 4 <style type="text/css">
 5     .div_left {
 6         width: 70%;
 7         float: left;
 8     }
 9 
10     .div_right {
11         width: 28%;
12         float: left;
13     }
14 
15     .ul {
16         list-style: none;
17         border: 1px solid #ccc;
18         height: 500px;
19         overflow-y: scroll;
20         color: black;
21     }
22 
23         .ul li {
24             padding-top: 5px;
25             padding-right: 25px;
26         }
27 
28     .ul_user {
29         list-style: none;
30     }
31 
32         .ul_user li {
33             padding-top: 5px;
34         }
35 
36     .send {
37         position: relative;
38         background: #eae7e7;
39         border-radius: 5px; /* 圆角 */
40         padding-top: 4px;
41         padding-left: 5px;
42         margin-top: 13px;
43     }
44 
45         .send .arrow {
46             position: absolute;
47             top: -16px;
48             font-size: 0;
49             border: solid 8px;
50             border-color: #fff #fff #eae7e7 #fff;
51         }
52 </style>
53 <h3>@ViewBag.Title 在线人数:0人</h3>
54 <div class="container text-left">
55     <div class="div_left">
56         <ul class="ul" id="discussion"></ul>
57         <textarea rows="5" class="form-control" id="message" maxlength="500" placeholder="开始聊天. . ." style="max-width: 100%"></textarea><br />
58         <input type="button" id="sendmessage" value="发 送" class="btn btn-default" />
59         <input type="hidden" id="displayname" />
60     </div>
61     <div class="div_right">
62         <ul id="users" class="ul_user"></ul>
63     </div>
64 </div>
65 
66 <script src="~/Scripts/jquery.signalR-2.2.2.min.js"></script>
67 @*<script src="~/chat/hubs"></script>*@

客户端这里写法大致有零星栽选择,一栽直接下生成的代办来操作,一种不用自动生成的代理采用手动创建代理的法;为了内容之简洁性,这里才简简单单讲解下自动生成的代办方,而又多之是分享手动创建代理链接的艺术;

行使生成的代理获取链接

首先,我们要通过Script标签来引用一下自动生成代理的路径: <script src=”~/chat/hubs”></script> ,注意啊这里的门路/chat相应的即使是咋们在前头Startup.cs文件中配置 app.MapSignalR(“/chat” 路径,而背后/hubs恒的写法(至少目前自还从未还多之考试过),只有先采用了此~/chat/hubs,才能够当背后使用生成的代理,先上段子代码:

 1  var chat = $.connection.chatHub;
 2         chat.client.newUser = function (user) {
 3             $("#users").append(' <li><strong>' + user.NickName + '[' + user.TransportMethod + ']</strong></li>');
 4         };
 5 
 6         chat.client.userList = function (users) {
 7             console.log(users);
 8             $("#sapnUserTotal").html(users.length);
 9             $.each(users, function (i, item) {
10                 $("#users").append(' <li>[' + item.TransportMethod + '] <strong>' + item.NickName + '</strong>(' + item.Id + ')</li>');
11             });
12         };
13         chat.client.addNewMessageToPage = function (user, message) {
14             console.log(user);
15             $("#discussion").append(' <li ><strong>' + user.NickName + '[' + user.TransportMethod + ']</strong>:<div class="send">' + message + '<div class="arrow"></div></div></li>');
16         };
17    //connection.hub.start({ transport: ['webSockets', 'longPolling'] }).done(function () {
18         //    my.TransportMethod = connection.hub.transport.name;
19         //    chat.server.addUser(my);
20 
21         //    $('#sendmessage').click(function () {
22         //        //console.log(chat);
23         //        var content = $.trim($('#message').val());
24         //        if (content.length <= 0) { $('#message').val('').focus(); return; }
25         //        chat.server.sendAll(my, content);
26         //        $('#message').val('').focus();
27         //    });
28         //}).fail(function () {
29         //    alert("链接聊天室失败,请重新刷新页面。");
30         //});

咋们逐步来分析下代码注意点:

1.  var
chat =
$.connection.chatHub; 这里的chatHub对应之饶是咋们创建的并继承Hub的ChatHub类,由于js变量开头都是小写,所以这边是chatHub,这句活虽表示链接到咋们后端了ChatHub类了,然后就是可下其中的计啦(这种多少类似于头的webform中某种ajax请求的写法)

2.
由此chat.client.xxx来收取服务端通知之信息,而之xxx对应的法子名称和咋们后端的Clients.All.xxx,本章实例对应之是:chat.client.userList
= function
(users){}对应Clients.All.userList(_Users);这样后端就能一直通客户端的应和措施了;注意这里自己后端Clients.All用底是打招呼任何客户端的意思,如果你需要通知指定的链接需要用的凡: T Client(string connectionId); 方法

3. chat.client是后端调用客户端,那相对的chat.server就是客户端请求服务端,和上面一样通过chat.server.xxx来指定要的服务端方法,注意是时服务端方法指的是随着承类Hub的子类的国有措施(本篇对应之是:chat.server.sendAll(my,
content)对应ChatHub.cs文件被的 public void SendAll(MoHubUser user, string message) 函数)

4.  connection.hub.start({ transport: [‘webSockets’, ‘longPolling’] }) 来指定运行的并行协议

以上就是采取生成代理的计,按照点的注意点来形容应该无是题材;

用手动创建反往代理来链接

免使浮动的代码的办法,我们惟有待修改前端就实行了,后台代码不用变或设置不用变动;首先我们拿点说之Script引用自动代理的代码去丢,因为这时段不需了,我们或先上代码:

 1 var my = { NickName: "神牛001", TransportMethod: "" };
 2         var connection = $.hubConnection("/chat/hubs");
 3         var chat = connection.createHubProxy('chatHub');
 4 
 5         chat.on("userList", function (users) {
 6             console.log(users);
 7             $("#sapnUserTotal").html(users.length);
 8             $("#users").html("");
 9             $.each(users, function (i, item) {
10                 $("#users").append(' <li>[' + item.TransportMethod + '] <strong>' + item.NickName + '</strong>(' + item.Id + ')</li>');
11             });
12         });
13 
14         chat.on("addNewMessageToPage", function (user, message) {
15             console.log(user);
16             $("#discussion").append(' <li ><strong>' + user.NickName + '[' + user.TransportMethod + ']</strong>:<div class="send">' + message + '<div class="arrow"></div></div></li>');
17 
18             var div = document.getElementById('discussion');
19             //div.scrollTop = div.scrollHeight;
20             div.scrollTop = 999999;
21         });
22 
23         var nickName = prompt("请输入一个昵称:", my.NickName);
24         my.NickName = nickName.length > 0 ? nickName : my.NickName;
25         $('#displayname').val(nickName);
26         $('#message').focus();
27      
28 
29         connection.start({ transport: ['webSockets', 'longPolling'] }).done(function () {
30 
31             my.TransportMethod = connection.transport.name;
32             //console.log(my.TransportMethod);
33             chat.invoke("addUser", my);
34 
35             $('#sendmessage').click(function () {
36                 var content = $.trim($('#message').val());
37                 if (content.length <= 0) { $('#message').val('').focus(); return; }
38 
39                 chat.invoke("sendAll", my, content);
40                 $('#message').val('').focus();
41             });
42         });

同列有如下注意点:

1.  var
connection = $.hubConnection(“/chat/hubs”); 创建链接,这里的path同样对应后端的 app.MapSignalR(“/chat” ,路径保持一致

  1.  var
    chat = connection.createHubProxy(‘chatHub’); 来创建反为代理链接,这里的name:chatHub对应之是后端的ChatHub类名称

3.
通过on(“xxx”,function(){})函数来绑定服务端通知客户端的波,xxx对应Clients.All.xxx中之xxx

4.  connection.start({ transport: [‘webSockets’, ‘longPolling’]
}) 来设置允许的链接方式,并初步链接

5. connection.transport.name来获得链接的不二法门名称,默认start不设置的语句出这般几栽:webSockets,foreverFrame,serverSentEvents,longPolling

6. chat.invoke(“xxx”, param1,
param2)通过invoke来映射继承类Hub的切近的官艺术,这里实例对应之是: chat.invoke(“sendAll”, my, content) 对承诺 public void SendAll(MoHubUser user, string message) 

描绘在结尾

到这个要满足以上注意点,那么基本SignalR就能链接以成功了,注意点于多不了都是总结的更,希望多朋友等发拉;在描绘本文的时候恰恰有情侣以羁押本身git开源的LovePicture.Web路,据说他们为拿起尝试以局面临行使Netcore来构建利用,我耶这个感到光荣也欣喜,荣幸能将自身种作为范例,高兴是NetCore也越有影响力了哄;如果认为本篇还可以,或被您获得,不妨接触单推荐,谢谢!!!

相关文章