SignalR 中豐富多彩的訊息推送方式

在上一篇 SignalR 文章中，演示瞭如何透過 SignalR 實現了簡單的聊天室功能；本著簡潔就是美的原則，這一篇我們也來聊聊在 SignalR 中的使用者和組的概念，理解這些基礎知識有助於更好的開發基於 SignalR 的應用，透過對使用者和分組的理解，進一步擴展出對使用者和分組的管理，以及訊息推送的各種方式，為全面接入 SignalR 做準備。

1. 使用者

在 SignalR 中，使用者表示連線，一個使用者代表一個連線，一個“系統使用者”可以建立多個連線身份，透過函式集線器，可以給一個使用者的所有連線傳送訊息；比如一個“系統使用者”擁有多個連線，這些連線分別是 Web連線、AndroId手機客戶端連線，IOS手機客戶端連線、或者其它客戶端連線，“系統使用者”分別登入了這些客戶端，同時建立了多個連線；預設情況下這些連線都透過 ClaimTypes.NameIdentifier 在 ClaimsPrincipal 於使用者標識進行關聯。

** 註意：使用者識別符號是區分大小寫的，為了實現一個客戶多個連線，本例還簡單實現了一個基於 ClaimsIdentity 登入介面，算是意外驚喜。

 

1.1 使用者連線管理

為了直觀的觀察到使用者是可以擁有多連線的，需要建立一個本地靜態物件，用於儲存使用者連線

public class WeChatHub : Hub
    {
        public Dictionary<string, List<string>> UserList { get; set; } = new Dictionary<string, List<string>>();

        public void Send(ChatMessage body)
        {
            Clients.All.SendAsync("Recv", body);
        }

        public override Task OnConnectedAsync()
        {
            var userName = this.Context.User.Identity.Name;
            var connectionId = this.Context.ConnectionId;
            if (!UserList.ContainsKey(userName))
            {
                UserList[userName] = new List<string>();
                UserList[userName].Add(connectionId);
            }
            else if (!UserList[userName].Contains(connectionId))
            {
                UserList[userName].Add(connectionId);
            }
            Console.WriteLine("哇，有人進來了：{0},{1},{2}", this.Context.UserIdentifier, this.Context.User.Identity.Name, this.Context.ConnectionId);
            return base.OnConnectedAsync();
        }

        public override Task OnDisconnectedAsync(Exception exception)
        {
            var userName = this.Context.User.Identity.Name;
            var connectionId = this.Context.ConnectionId;
            if (UserList.ContainsKey(userName))
            {
                if (UserList[userName].Contains(connectionId))
                {
                    UserList[userName].Remove(connectionId);
                }
            }

            Console.WriteLine("靠，有人跑路了：{0}", this.Context.ConnectionId);
            return base.OnDisconnectedAsync(exception);
        }
    }

上面的程式碼包含了一個內部成員 UserList，用於儲存使用者的每個連線，在使用者進行 SignalR 連線時，將當前連線儲存到 UserList 中，當連線斷開的時候，將當前連線從 UserList 中刪除。這樣就實現了一個簡單的使用者連線管理。

在上面的程式碼中，當前使用者暱稱是根據 var userName = this.Context.User.Identity.Name; 這行程式碼獲取的，為了取得這個使用者暱稱，我們實現了一個簡單的 UserIdentity 登入，然後將 User 資訊寫入到 Cookie 中，最後才可以透過 var userName = this.Context.User.Identity.Name; 獲得當前登入使用者暱稱（熟悉 ID 登入流程的同學應該不會感到陌生，實際上我也很少使用 ID 驗證）

1.2 給單個使用者傳送訊息

        [Authorize(Roles = "User")]
        [HttpPost("SendToUser")]
        public async Task SendToUser([FromBody] UserInfoViewModel model)
        {
            ChatMessage message = new ChatMessage()
            {
                Type = 1,
                Content = model.Content,
                UserName = model.UserName
            };

            if (this.chatHub.UserList.ContainsKey(model.UserName))
            {
                var connections = this.chatHub.UserList[model.UserName].First();
                await this.chatHub.Clients.Client(connections).SendAsync("Recv", new object[] { message });
            }

            return Json(new { Code = 0 });
        }

在 UserController 中，定義了上面的介面 SendToUser ，客戶端傳入使用者暱稱和訊息，然後服務端就會去根據 ChatHub.UserList 成員查詢標的使用者的連線資訊，最後，透過 SendAsync 將訊息推送到標的客戶端連線中。

2. 分組

分組的概念類似於聊天室，每個房間就是一個獨立的分組，使用者可以選擇加入 A 房間，也可以選擇加入 B 房間，如果業務允許，一個使用者還可以加入多個分組（房間），透過使用分組對使用者進行管理，可以實現一個或者多個聊天房間，使用者可以加入分組，也可以將使用者從分組中刪除（類似離開房間），這裡的使用者併發真正意義上的“系統使用者”，而是指系統使用者建立的那些 SignalR連線。

** 註意：當連線斷開後重新發起連線的時候，SignalR 不會保留組成員身份，必須重新加入分組。

下麵的程式碼演示瞭如何對分組進行操作，要對分組進行操作，主要包含三個方面：

 

2.1 加入分組

    public async Task AddToGroupAsync(string groupName)
        {
            await Groups.AddToGroupAsync(this.Context.ConnectionId, groupName);
        }

 

2.2 離開分組

        public async Task RemoveFromGroupAsync(string groupName)
        {
            await Groups.RemoveFromGroupAsync(this.Context.ConnectionId, groupName);
        }

 

2.3 傳送訊息到指定分組

        public async Task SendToGroupAsync(string groupName, ChatMessage message)
        {
            await Clients.Group(groupName).SendAsync(groupName, new object[] { message });
        }

對分組的操作非常的簡單，幾乎都是一行程式碼的事情，不得不說，微軟的封裝實在是太好了。

3. SignalR的推送訊息的其它方式

透過上面對使用者和分組的學習，再去擴充套件學習其它推送訊息的方式，就非常的好理解和上手，在 SignalR 內部還有多種推送訊息的方式，他們分別是

 

3.1 All（全站推送）

 

3.2 Others（全站推送排除自己）

 

3.3 OthersInGroup（指定分組推送，排除自己）

 

3.4 AllExcept（除指定串列外的所有人）

 

3.5 演示程式碼

        List<string> blackList = new List<string>();
        public async Task OtherSendAsync(ChatMessage body)
        {
            
            await Clients.All.SendAsync("Recv", body);

            
            await Clients.Caller.SendAsync("Recv", body);

            
            await Clients.Others.SendAsync("Recv", body);

            
            await Clients.OthersInGroup("groupName").SendAsync("Recv", body);

            
            await Clients.AllExcept(blackList).SendAsync("Recv", body);
        }

4. 一個簡單的示例

本示例程式碼包含兩個簡單的介面

 

4.1 登入

 

4.2 各種方式傳送訊息

結束語

最近在做一個開源專案，還處於試用階段，準備寫個使用的 WIKI 出來，看看大家是否感興趣，此 SingalR 系列只能不定期更新了，抱歉。

演示程式碼下載

已託管到 GitHub 倉庫
https://github.com/lianggx/Examples/tree/master/SignalR/Ron.SignalRLesson2