AngularJS+ASP.NET MVC+SignalR實現訊息推送

i魷魚發表於2015-02-11
AngularJSASP.NETMVCSignalR

背景

OA管理系統中，員工提交申請單，訊息實時通知到相關人員及時進行審批，審批之後將結果推送給使用者。

技術選擇

最開始發現的是firebase，於是很興奮的開始倒騰起來。firebase用起來倒是簡單：引用一個js即可，按官網上的教程很快便應用到了專案中。第二天開啟專案發現推送功能不好使了，這是為何？最後發現firebase官網打不開了。。。難道firebase被google收了也會被天朝給牆掉？也許是firebase自己掛掉了，總之是用不了了。因為要完全把推送資料存放在firebase伺服器上來實現推送功能，就會有以下幾個需要擔心的問題：

1.資料不安全

2.對firebase依賴性太強

3.firebase收費（免費版太弱）

於是果斷放棄firebase，朋友推薦有個叫SignalR的東東可以試試，這是專門為ASP.NET開發人員準備的一款訊息推送類庫，且不依賴別的伺服器、免費。

使用方法

1.在nuget中搜尋並新增SignalR最新版本

2.在頁面中引用jquery.signalR-2.2.0.min.js檔案(依賴jquery)，再新增<script src=”/signalr/hubs”></script>用於自動生成signalr的指令碼

3.新增MsgHub.cs類，用於處理對應使用者資訊和訊息推送實現

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

namespace ZmeiOA.Services
{
　　 [Authorize]
    [HubName("ZmHub")]
    public class MsgHub : Hub
    {/// <summary>
        /// 連線
        /// </summary>
        /// <returns></returns>
        public override System.Threading.Tasks.Task OnConnected()
        {
            Groups.Add(Context.ConnectionId, Context.User.Identity.Name);
            return base.OnConnected();
        }

        /// <summary>
        /// 重新連線
        /// </summary>
        /// <returns></returns>
        public override System.Threading.Tasks.Task OnReconnected()
        {
            Groups.Add(Context.ConnectionId, Context.User.Identity.Name);
            return base.OnReconnected();
        }

        /// <summary>
        /// 斷開連線
        /// </summary>
        /// <param name="stopCalled"></param>
        /// <returns></returns>
        public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled)
        {
            Groups.Remove(Context.ConnectionId, Context.User.Identity.Name);
            return base.OnDisconnected(stopCalled);
        }
    }
}

說明：SignalR的推送訊息是基於使用者連線(ConnectionId)的，SignalR會為每個會話自動生成一個ConnectionId。但是我們的推送是基於使用者的（許可權體系），也就是隻有登入之後才註冊到此Hub。在這裡我用到的是SignalR中的Groups，把登入使用者的ConnectionId與對應的UserId新增到Groups中，推送的時候只要指定Groups的Name，SignalR便會自動找出其對應的ConnectionId併傳送訊息（這種方式可能不是最好的，因為每個使用者的UserId都會作為Groups的Key新增進去，當使用者量很大的時候Groups也會很龐大，但我還沒找到更好的替代方案）。

4.訊息推送有兩種形式：a.服務端直接推送；b.客戶端推送。

區別在於，服務端推送是在持久化資料之後便可以直接把訊息推送給相關人；而客戶端推送是持久化資料之後，客戶端根據返回值的情況，使用SignalR的JS方法呼叫服務端的推送功能。我使用的是伺服器端直接推送資料，因為在持久化資料之後就完全可以根據業務通知相關人，如果返回到前臺之後再呼叫服務端的推送方法只是多此一舉。

如：儲存申請單成功之後立刻通知審批人

在Service中獲取Hub的上下文

　　/// <summary>
　　/// 訊息推送上下文
　　/// </summary>
　　protected static IHubContext ZmHubContext = GlobalHost.ConnectionManager.GetHubContext<MsgHub>();

在儲存申請單之後給相關人員推送訊息(注意：dynamic方法broadcastTodo就是在客戶端需要接收訊息的方法)

public static ApplyForm Save(FormView view)
{　　
　　 //省略業務操作...
　　 //...
    //通知待辦事項
    ZmHubContext.Clients.Groups(app.AuditorIds.Split(',')).broadcastTodo(app.AuditorIds, new { type = "new", data = app });
    return app;
}

5.在註冊Angular模組時連線Hub並作為value傳入到模組中，這樣每個controller都可以使用此連線：

　　var zmHub = $.connection.ZmHub;

　　var zmApp = angular.module('zmApp', ['ngRoute', 'ngResource', 'ngSanitize', 'ngMessages', 'ngSVGAttributes']).value('zmHub', zmHub);

6.在首頁的controller中接收推送的訊息，並提供兩種推送體驗：a.桌面通知；b.頁面內訊息。桌面通知很酷，即使是瀏覽器最小化的時候，在桌面右下角也可以收到提示（Chrome和Firefox支援，IE不支援）

zmHub.client.broadcastTodo = function (userIds, obj) {
    //通知下級控制器有待辦事項
    $scope.$broadcast('todoschanged', obj);
    //顯示桌面通知
    if (obj.type == 'new') {
　　　　 //桌面通知標題
        var title = '來自[' + obj.data.ApplicantName + ']的申請單';
        //申請單型別名稱
        var formTypeName = DefaultService.getEnumText(17, obj.data.Type);
        var msg = '[' + formTypeName + ']' + obj.data.Name;
　　　　 //桌面通知方法
        NotifyService.Notify('todos', title, msg);
    }
}

下級控制器的接收方法（關於angularjs的broadcast不多解釋，不明白的可以到官網查閱）：

//接收推送的待辦事項
$scope.$on('todoschanged', function (d, obj) {
    $scope.$apply(function () {
　　　　 //如果是新增資料，在當前列表中新增一條
        if (obj.type == 'new') {
            $scope.todoApps.unshift(obj.data);
        }
        else if (obj.type == 'delete') {//如果是撤銷申請，則把當前列表中那條資料刪除
            for (var j = 0; j < $scope.todoApps.length; j++) {
                if ($scope.todoApps[j].Id == obj.data.Id) {
                    $scope.todoApps.splice(j, 1);
                    break;
                }
            }
        }
    });
});

桌面通知服務：

//桌面通知服務
zmApp.factory('NotifyService', function () {

    return {
        Notify: function (icon, title, msg) {
            // At first, let's check if we have permission for notification
            // If not, let's ask for it
            if (window.Notification && Notification.permission !== "granted") {
                Notification.requestPermission(function (status) {
                    if (Notification.permission !== status) {
                        Notification.permission = status;
                    }
                });
            }
            var iconPath = '/Content/images/icons/' + (icon || 'info') + '.png';
            var options = {
                lang: 'zh-CN',
                body: msg,
                icon: iconPath
            };
            var notify;
            // If the user agreed to get notified
            if (window.Notification && Notification.permission === "granted") {
                notify = new Notification(title, options);
            }
            else if (window.Notification && Notification.permission !== "denied") {
                Notification.requestPermission(function (status) {
                    if (Notification.permission !== status) {
                        Notification.permission = status;
                    }
                    if (status === "granted") {
                        notify = new Notification(title, options);
                    }
                    else {
                        console.log('您禁止了桌面通知，無法推送到您的桌面！');
                    }
                });
            }
            else {
                console.log('您禁止了桌面通知，無法推送到您的桌面！');
            }
            if (notify) {
                notify.onclose = function (evt) {

                };
                //點選切換到瀏覽器
                notify.onclick = function () {
                    window.focus();
                };
            }
        }
    };
});

桌面通知效果：

總結：

用SignalR推送訊息總的來說比較簡單，只需要簡單幾步便可實現，而且是selfhost，不必擔心對其它伺服器的依賴和資料安全問題，感興趣的朋友可以試試

相關文章