SignalR來做實時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)，效果圖：

介面及其簡單，樣式這裡就不考慮了，主要是展示其用法，這裡涉及到的功能有：

1. 統計線上人數量

2. 顯示線上人數的暱稱和連線方式（本測試用例支援webSockets和longPolling(長連線)）

3. 群聊資訊

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的類，裡面主要內容補全不下：

[assembly: OwinStartup(typeof(Stage.Api.Extend.Startup))]
namespace Stage.Api.Extend
{
    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框架提供)，然後裡面的邏輯程式碼如下：

public class ChatHub : Hub
    {
        //
        public int Num = 10001;
        public static List<MoHubUser> _Users = new List<MoHubUser>();

        /// <summary>
        /// 新增聊天人
        /// </summary>
        /// <param name="user"></param>
        public void AddUser(MoHubUser user)
        {

            user.Id = Context.ConnectionId;
            if (!_Users.Any(b => b.Id == user.Id))
            {
                _Users.Add(user);
            }

            //Clients.All.newUser(user);
            Clients.All.userList(_Users);
        }

        /// <summary>
        /// 傳送資訊
        /// </summary>
        /// <param name="user"></param>
        /// <param name="message"></param>
        public void SendAll(MoHubUser user, string message)
        {
            Clients.All.addNewMessageToPage(user, message);
        }

        /// <summary>
        /// 某個聊天人退出是，通知所有線上人重新載入聊天人數
        /// </summary>
        /// <param name="stopCalled"></param>
        /// <returns></returns>
        public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled)
        {
            var user = _Users.SingleOrDefault(x => x.Id == Context.ConnectionId);
            if (user != null)
            {
                _Users.Remove(user);
                Clients.All.userList(_Users);
            }
            return base.OnDisconnected(stopCalled);
        }
    }

上面的3個方法分別做了：新增聊天人到List，傳送資訊到客戶端，某個連線失效後通知各個有效的聊天人重新載入資訊；這裡值得關注的是通過重新 public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled) 方法來實現捕獲並移除失效連線（這裡是聊天人的資訊）;整篇測試用例通過Context.ConnectionId來保證連線的唯一性，只要有新的連結請求，那麼服務端就會分配一個唯一串給這個連結，當客戶端關閉頁面或關閉連結這個是有就能在OnDisconnected方法中捕獲到這個失效的連結的ConnectionId，這樣就達到了移除失效聊天人的要求了；為了程式碼的方便性，這裡建立了一個聊天人資訊類：

 public class MoHubUser
    {

        public string Id { get; set; }
        public string NickName { get; set; }
        public string TransportMethod { get; set; }
    }

到這裡後臺的聊天室程式碼就完成了就是這麼簡單；我們再來看試圖中如何來寫程式碼，這裡我先給出我的html佈局程式碼：

@{
    ViewBag.Title = "神牛聊天室 - SignalR";
}
<style type="text/css">
    .div_left {
        width: 70%;
        float: left;
    }

    .div_right {
        width: 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;
        }
</style>
<h3>@ViewBag.Title 線上人數：<span id="sapnUserTotal">0</span>人</h3>
<div class="container text-left">
    <div class="div_left">
        <ul class="ul" id="discussion"></ul>
        <textarea rows="5" class="form-control" id="message" maxlength="500" placeholder="開始聊天. . ." style="max-width: 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.signalR-2.2.2.min.js"></script>
@*<script src="~/chat/hubs"></script>*@

客戶端這裡寫法大致有兩種選擇，一種直接使用生成的代理來操作，一種不用自動生成的代理採用手動建立代理的方式；為了內容的簡潔性，這裡只簡單講解下自動生成的代理方式，而更多的是分享手動建立代理連結的方式；

使用生成的代理獲取連結

首先，我們需要通過Script標籤來引用一下自動生成代理的路徑： <script src="~/chat/hubs"></script> ，注意啦這裡的路徑/chat對應的就是咋們在前面Startup.cs檔案中配置 app.MapSignalR("/chat" 路徑，而後面/hubs固定的寫法(至少目前我還沒更多的試驗過)，只有先應用了這個~/chat/hubs，才能在後面使用生成的代理，先上段程式碼：

 var chat = $.connection.chatHub;
        chat.client.newUser = function (user) {
            $("#users").append(' <li><strong>' + user.NickName + '[' + user.TransportMethod + ']</strong></li>');
        };

        chat.client.userList = function (users) {
            console.log(users);
            $("#sapnUserTotal").html(users.length);
            $.each(users, function (i, item) {
                $("#users").append(' <li>[' + item.TransportMethod + '] <strong>' + item.NickName + '</strong>(' + item.Id + ')</li>');
            });
        };
        chat.client.addNewMessageToPage = function (user, message) {
            console.log(user);
            $("#discussion").append(' <li ><span><strong>' + user.NickName + '[' + user.TransportMethod + ']</strong>：</span><div class="send">' + message + '<div class="arrow"></div></div></li>');
        };
   //connection.hub.start({ transport: ['webSockets', 'longPolling'] }).done(function () {
        //    my.TransportMethod = connection.hub.transport.name;
        //    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("連結聊天室失敗，請重新重新整理頁面。");
        //});

咋們逐步來解析下程式碼注意點：

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引用自動代理的程式碼去掉，因為這個時候不需要了，我們還是先上程式碼：

var my = { NickName: "神牛001", TransportMethod: "" };
        var connection = $.hubConnection("/chat/hubs");
        var chat = connection.createHubProxy('chatHub');

        chat.on("userList", function (users) {
            console.log(users);
            $("#sapnUserTotal").html(users.length);
            $("#users").html("");
            $.each(users, function (i, item) {
                $("#users").append(' <li>[' + item.TransportMethod + '] <strong>' + item.NickName + '</strong>(' + item.Id + ')</li>');
            });
        });

        chat.on("addNewMessageToPage", function (user, message) {
            console.log(user);
            $("#discussion").append(' <li ><span><strong>' + user.NickName + '[' + user.TransportMethod + ']</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 nickName = prompt("請輸入一個暱稱：", my.NickName);
        my.NickName = nickName.length > 0 ? nickName : my.NickName;
        $('#displayname').val(nickName);
        $('#message').focus();
     

        connection.start({ transport: ['webSockets', 'longPolling'] }).done(function () {

            my.TransportMethod = connection.transport.name;
            //console.log(my.TransportMethod);
            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();
            });
        });

同樣列出如下注意點：

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) 

寫在最後

到此如果滿足以上注意點，那麼基本SignalR就能連結使用成功了，注意點比較多不過都是總結的經驗，希望多朋友們有幫助；在寫本文的時候剛好有朋友在看我git開源的LovePicture.Web專案，據說他們也將開始嘗試在公司中使用Netcore來構建應用，我為此感到榮幸也高興，榮幸能夠把我專案當做範例，高興是NetCore也越來越有影響力了哈哈；如果覺得本篇還可以，或給您收穫，不妨點個推薦，謝謝！！！