ASP.NET MＶＣ SignalR 简单聊天推送笔记

介绍：（抄袭于网络）

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

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

SignalR将与客户端进行实时通信带给了ASP .NET 。当然这样既好用，而且也有足够的扩展性。以前用户需要刷新页面或使用Ajax轮询才能实现的实时显示数据，现在只要使用SignalR，就可以简单实现了。最重要的是您无需重新建立项目，使用现有ASP .NET项目即可无缝使用SignalR。

首先，我们平常做法创建MVC的Web项目，然后通过Nuget控制台命令： Install-package Microsoft.AspNet.SignalR 加入SignalR的依赖，并且自动往MVC项目中的Script文件夹中增加相关的js文件

然后，我们需要在项目一级目录创建一个OWIN的类文件名称为 Startup.cs的类，里面主要内容补全不下：

using System;
using System.Threading.Tasks;
using Microsoft.Owin;
using Owin;

[assembly: OwinStartup(typeof(WebExerciseUI.ServerSignalR.Startup))]

namespace WebExerciseUI.ServerSignalR
{
    public class Startup
    {
        public void Configuration(IAppBuilder app)
        {
            app.MapSignalR("/chat",new Microsoft.AspNet.SignalR.HubConfiguration {
                EnableDetailedErrors=true,
                EnableJavaScriptProxies=true
            });
        }
    }
}

首先我们从上往下分析注意点：

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框架提供)，然后里面的逻辑代码如下：

 

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

namespace WebExerciseUI.ServerSignalR
{
    public class ChatHub : Hub
    {
        public static List<ModelUser> userList = new List<ModelUser>();

        /// <summary>
        /// 添加用户
        /// </summary>
        /// <param name="Model"></param>
        public void AddUser(ModelUser Model)
        {
            Model.UserID = Context.ConnectionId;
            if (!userList.Any(n => n.UserID == Model.UserID))
            {
                userList.Add(Model);
            }
            Clients.All.userList(userList);
        }

        /// <summary>
        /// 发送信息
        /// </summary>
        /// <param name="Name"></param>
        /// <param name="Message"></param>
        public void SendAll(ModelUser user, string Message)
        {
            Clients.All.addMessage(user, Message);
        }

        /// <summary>
        /// 某个聊天人退出是，通知所有在线人重新加载聊天人数
        /// </summary>
        /// <param name="stopCalled"></param>
        /// <returns></returns>
        public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled)
        {
            var user = userList.SingleOrDefault(n => n.UserID == Context.ConnectionId);
            if (user != null)
            {
                userList.Remove(user);
                Clients.All.userList(userList);
            }
            return base.OnDisconnected(stopCalled);
        }
    }
}

上面的3个方法分别做了：添加聊天人到List，发送信息到客户端，某个连接失效后通知各个有效的聊天人重新加载信息；这里值得关注的是通过重新 public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled) 方法来实现捕获并移除失效连接（这里是聊天人的信息）;整篇测试用例通过Context.ConnectionId来保证连接的唯一性，只要有新的链接请求，那么服务端就会分配一个唯一串给这个链接，当客户端关闭页面或关闭链接这个是有就能在OnDisconnected方法中捕获到这个失效的链接的ConnectionId，这样就达到了移除失效聊天人的要求了；为了代码的方便性，这里创建了一个聊天人信息类：

namespace WebExerciseUI.ServerSignalR
{
    public class ModelUser
    {
        /// <summary>
        /// 用户ID
        /// </summary>
        public  string UserID { get; set; }

        /// <summary>
        /// 用户名称
        /// </summary>
        public  string UserName { get; set; }
        /// <summary>
        /// 用户信息
        /// </summary>
        public  string UserMessage { get; set; }
    }
}

到这里后台的聊天室代码就完成了就是这么简单；我们再来看试图中如何来写代码，这里我先给出我的html布局代码：

@{
    Layout = null;
}

<style type="text/css">
     .div_left {
         70%;
         float: left;
     }
 
     .div_right {
         28%;
         float: left;
     }
 
     .ul {
         list-style: none;
         border: 1px solid #ccc;
         height: 500px;
         overflow-y: scroll;
         color: black;
     }
 
         .ul li {
             padding-top: 5px;
             padding-right: 25px;
         }
 
     .ul_user {
         list-style: none;
     }
 
         .ul_user li {
             padding-top: 5px;
         }
 
     .send {
         position: relative;
         background: #eae7e7;
         border-radius: 5px; /* 圆角 */
         padding-top: 4px;
         padding-left: 5px;
         margin-top: 13px;
     }
 
         .send .arrow {
             position: absolute;
             top: -16px;
             font-size: 0;
             border: solid 8px;
             border-color: #fff #fff #eae7e7 #fff;
         }
    .text-left {
      margin:auto;
      /*text-align:center;*/
      50%;
   
    }
 </style>
 
<div class="container text-left">
    <h3>@ViewBag.Title 在线人数：<span id="sapnUserTotal">0</span>人</h3>
    <div class="div_left">
        <ul class="ul" id="discussion"></ul>
        <textarea rows="5" class="form-control" id="message" maxlength="500" placeholder="开始聊天. . ." style="max- 100%"></textarea><br />
        <input type="button" id="sendmessage" value="发 送" class="btn btn-default" />
        <input type="hidden" id="displayname" />
    </div>
    <div class="div_right">
        <ul id="users" class="ul_user"></ul>
    </div>
</div>
 <script src="~/Scripts/jquery-1.10.2.min.js"></script>
 <script src="~/Scripts/jquery.signalR-2.2.3.min.js"></script>
@*<script src="/chat/hubs"></script>*@
<script type="text/javascript">

     // 使用生成代理（jq方法） 许调用@*（<script src="/chat/hubs"></script>）*@
    ////信息推行建立连接
    //var chat = $.connection.chatHub;

    ////实时推送登录人名称以及内容
    //   //chat.client.newUser = function (user) {
    //   //    $("#users").append(' <li><strong>' + user.UserName + '[' + user.UserMessage + ']</strong></li>');
    //   //};
    ////实时推送登录人名称以及在线人数
    //   chat.client.userList = function (users) {
    //       console.log(users);
    //       $("#users").html("");
    //       $("#sapnUserTotal").html(users.length);
    //       $.each(users, function (i, item) {
    //           $("#users").append(' <li>[' + item.UserMessage + '] <strong>' + item.UserName + '</strong>(' + item.UserID + ')</li>');
    //       });
    //};
    ////实时推送发送信息
    //   chat.client.addMessage = function (user, message) {
    //       console.log(user);
    //       $("#discussion").append(' <li ><span><strong>' + user.UserName + '[' + user.UserMessage + ']</strong>：</span><div class="send">' + message + '<div class="arrow"></div></div></li>');
    //   };

    //  //定义传入参数
    //   var my = { UserName: "", UserMessage: "" }
    //  //定义聊天名称
    //   var userName = prompt("请输入一个昵称：", my.UserName);
    //   //判断是否定义用户名
    //   if (userName != null && userName != "")
    //      my.UserName = userName.length > 0 ? userName : my.UserName;
       
    //   $('#displayname').val(userName);
    //   $('#message').focus();

    //  //定义客户端连接
    //   $.connection.hub.logging = true;
    //   var options = { transport: ['webSockets', 'longPolling'] };
    //   window.hubReady = $.connection.hub.start(options);
    //   window.hubReady.done(function () {
    //       my.UserMessage = $.connection.hub.transport.name;
    //       if (my.UserName == null || my.UserName == "")
    //        return null;
    //               chat.server.addUser(my);
    //               $('#sendmessage').click(function () {
    //                   //console.log(chat);
    //                   var content = $.trim($('#message').val());
    //                   if (content.length <= 0) { $('#message').val('').focus(); return; }
    //                   chat.server.sendAll(my, content);
    //                   $('#message').val('').focus();
    //               });
    //           }).fail(function () {
    //               alert("链接聊天室失败，请重新刷新页面。");
    //       });

      //不使用生成的代理（jq方法）
      //定义名称
    var my = { UserName: "", UserMessage: "" };
    //定义连接
       var connection = $.hubConnection("/chat/hubs");
       var chat = connection.createHubProxy('chatHub');

    //实时推送用户名称以及在线人数
       chat.on("userList", function (users) {
           console.log(users);
           $("#sapnUserTotal").html(users.length);
           console.log(users.length);
           $("#users").html("");
           $.each(users, function (i, item) {
               $("#users").append(' <li>[' + item.UserMessage + '] <strong>' + item.UserName + '</strong>(' + item.UserID + ')</li>');
           });
       });
    //实时推送发送信息内容
       chat.on("addMessage", function (user, message) {
           console.log(user);
           $("#discussion").append(' <li ><span><strong>' + user.UserName + '[' + user.UserMessage + ']</strong>：</span><div class="send">' + message + '<div class="arrow"></div></div></li>');

           var div = document.getElementById('discussion');
           //div.scrollTop = div.scrollHeight;
           div.scrollTop = 999999;
       });
       //定义用户名
       var userName = prompt("请输入一个昵称：", my.UserName);
       if (userName != null && userName != "")
          my.UserName = userName.length > 0 ? userName : my.UserName;
      
       $('#displayname').val(userName);
       $('#message').focus();

       //建立客户端连接
       connection.start({ transport: ['webSockets', 'longPolling'] }).done(function () {
           my.UserMessage = connection.transport.name;
           //console.log(my.TransportMethod);
           if (my.UserName == null || my.UserName=="")
               return null;
           chat.invoke("AddUser", my);

           $('#sendmessage').click(function () {
              
               var content = $.trim($('#message').val());
               if (content.length <= 0) { $('#message').val('').focus(); return; }

               chat.invoke("sendAll", my, content);
               $('#message').val('').focus();
           });
       });
</script>

咋们逐步来解析下代码注意点：

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'] }) 来指定运行的交互协议

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

2.  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)