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

時間 2019-11-19

標籤 signalr 豐富多彩消息推送方式简体版

原文原文鏈接

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

1. 用戶

在 SignalR 中，用戶表示鏈接，一個用戶表明一個鏈接，一個「系統用戶」能夠建立多個鏈接身份，經過函數集線器，能夠給一個用戶的全部鏈接發送消息；好比一個「系統用戶」擁有多個鏈接，這些鏈接分別是 Web鏈接、AndroId手機客戶端鏈接，IOS手機客戶端鏈接、或者其它客戶端鏈接，「系統用戶」分別登陸了這些客戶端，同時建立了多個鏈接；默認狀況下這些鏈接都經過 ClaimTypes.NameIdentifier 在 ClaimsPrincipal 於用戶標識進行關聯。github

** 注意：用戶標識符是區分大小寫的，爲了實現一個客戶多個鏈接，本例還簡單實現了一個基於 ClaimsIdentity 登陸接口，算是意外驚喜。併發

1.1 用戶鏈接管理

爲了直觀的觀察到用戶是能夠擁有多鏈接的，須要創建一個本地靜態對象，用於存儲用戶鏈接async

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 中刪除。這樣就實現了一個簡單的用戶鏈接管理。ide

在上面的代碼中，當前用戶暱稱是根據 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<IActionResult> 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鏈接。this

** 注意：當鏈接斷開後從新發起鏈接的時候，SignalR 不會保留組成員身份，必須從新加入分組。3d

下面的代碼演示瞭如何對分組進行操做，要對分組進行操做，主要包含三個方面：code

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)
        {
            // 給當前鏈接到 Hub 上的全部鏈接發送消息，至關於廣播
            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);

            // 給除了 blackList（黑名單）以外的全部人發送消息
            await Clients.AllExcept(blackList).SendAsync("Recv", body);
        }