快捷導(dǎo)航

SignalR中豐富多彩的消息推送方式的實(shí)現(xiàn)代碼

更新時(shí)間：2019年04月02日 11:12:14 作者：梁規(guī)曉

這篇文章主要介紹了SignalR中豐富多彩的消息推送方式的實(shí)現(xiàn)代碼，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

在上一篇 SignalR 文章中，演示了如何通過 SignalR 實(shí)現(xiàn)了簡(jiǎn)單的聊天室功能；本著簡(jiǎn)潔就是美的原則，這一篇我們也來聊聊在 SignalR 中的用戶和組的概念，理解這些基礎(chǔ)知識(shí)有助于更好的開發(fā)基于 SignalR 的應(yīng)用，通過對(duì)用戶和分組的理解，進(jìn)一步擴(kuò)展出對(duì)用戶和分組的管理，以及消息推送的各種方式，為全面接入 SignalR 做準(zhǔn)備。

1. 用戶

在 SignalR 中，用戶表示連接，一個(gè)用戶代表一個(gè)連接，一個(gè)“系統(tǒng)用戶”可以創(chuàng)建多個(gè)連接身份，通過函數(shù)集線器，可以給一個(gè)用戶的所有連接發(fā)送消息；比如一個(gè)“系統(tǒng)用戶”擁有多個(gè)連接，這些連接分別是 Web連接、AndroId手機(jī)客戶端連接，IOS手機(jī)客戶端連接、或者其它客戶端連接，“系統(tǒng)用戶”分別登錄了這些客戶端，同時(shí)創(chuàng)建了多個(gè)連接；默認(rèn)情況下這些連接都通過 ClaimTypes.NameIdentifier 在 ClaimsPrincipal 于用戶標(biāo)識(shí)進(jìn)行關(guān)聯(lián)。

** 注意：用戶標(biāo)識(shí)符是區(qū)分大小寫的，為了實(shí)現(xiàn)一個(gè)客戶多個(gè)連接，本例還簡(jiǎn)單實(shí)現(xiàn)了一個(gè)基于 ClaimsIdentity 登錄接口，算是意外驚喜。

1.1 用戶連接管理

為了直觀的觀察到用戶是可以擁有多連接的，需要建立一個(gè)本地靜態(tài)對(duì)象，用于存儲(chǔ)用戶連接

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("哇，有人進(jìn)來了：{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);
  }
 }

上面的代碼包含了一個(gè)內(nèi)部成員 UserList，用于存儲(chǔ)用戶的每個(gè)連接，在用戶進(jìn)行 SignalR 連接時(shí)，將當(dāng)前連接存儲(chǔ)到 UserList 中，當(dāng)連接斷開的時(shí)候，將當(dāng)前連接從 UserList 中刪除。這樣就實(shí)現(xiàn)了一個(gè)簡(jiǎn)單的用戶連接管理。

在上面的代碼中，當(dāng)前用戶昵稱是根據(jù) var userName = this.Context.User.Identity.Name; 這行代碼獲取的，為了取得這個(gè)用戶昵稱，我們實(shí)現(xiàn)了一個(gè)簡(jiǎn)單的 UserIdentity 登錄，然后將 User 信息寫入到 Cookie 中，最后才可以通過 var userName = this.Context.User.Identity.Name; 獲得當(dāng)前登錄用戶昵稱（熟悉 ID 登錄流程的同學(xué)應(yīng)該不會(huì)感到陌生，實(shí)際上我也很少使用 ID 驗(yàn)證）

1.2 給單個(gè)用戶發(fā)送消息

  [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 ，客戶端傳入用戶昵稱和消息，然后服務(wù)端就會(huì)去根據(jù) ChatHub.UserList 成員查找目標(biāo)用戶的連接信息，最后，通過 SendAsync 將消息推送到目標(biāo)客戶端連接中。

2. 分組

分組的概念類似于聊天室，每個(gè)房間就是一個(gè)獨(dú)立的分組，用戶可以選擇加入 A 房間，也可以選擇加入 B 房間，如果業(yè)務(wù)允許，一個(gè)用戶還可以加入多個(gè)分組（房間），通過使用分組對(duì)用戶進(jìn)行管理，可以實(shí)現(xiàn)一個(gè)或者多個(gè)聊天房間，用戶可以加入分組，也可以將用戶從分組中刪除（類似離開房間），這里的用戶并發(fā)真正意義上的“系統(tǒng)用戶”，而是指系統(tǒng)用戶創(chuàng)建的那些 SignalR連接。

** 注意：當(dāng)連接斷開后重新發(fā)起連接的時(shí)候，SignalR 不會(huì)保留組成員身份，必須重新加入分組。

下面的代碼演示了如何對(duì)分組進(jìn)行操作，要對(duì)分組進(jìn)行操作，主要包含三個(gè)方面：

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 發(fā)送消息到指定分組

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

對(duì)分組的操作非常的簡(jiǎn)單，幾乎都是一行代碼的事情，不得不說，微軟的封裝實(shí)在是太好了。

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

通過上面對(duì)用戶和分組的學(xué)習(xí)，再去擴(kuò)展學(xué)習(xí)其它推送消息的方式，就非常的好理解和上手，在 SignalR 內(nèi)部還有多種推送消息的方式，他們分別是

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)
  {
   // 給當(dāng)前連接到 Hub 上的所有連接發(fā)送消息，相當(dāng)于廣播
   await Clients.All.SendAsync("Recv", body);

   // 給當(dāng)前連接對(duì)象發(fā)送消息
   await Clients.Caller.SendAsync("Recv", body);

   // 給其它所有連接的客戶端發(fā)送消息，除了當(dāng)前正在連接的客戶端
   await Clients.Others.SendAsync("Recv", body);

   // 查找當(dāng)前所有連接的客戶端（排除自己），如果是已加入此分組，則給他們推送消息
   await Clients.OthersInGroup("groupName").SendAsync("Recv", body);

   // 給除了 blackList（黑名單）之外的所有人發(fā)送消息
   await Clients.AllExcept(blackList).SendAsync("Recv", body);
  }

4. 一個(gè)簡(jiǎn)單的示例

本示例代碼包含兩個(gè)簡(jiǎn)單的界面

4.1 登錄