在上一篇 SignalR 文章中,演示了如何通過 SignalR 實現了簡單的聊天室功能;本著簡潔就是美的原則,這一篇我們也來聊聊在 SignalR 中的用戶和組的概念,理解這些基礎知識有助于更好的開發基于 SignalR 的應用,通過對用戶和分組的理解,進一步擴展出對用戶和分組的管理,以及消息推送的各種方式,為全面接入 SignalR 做準備。
1. 用戶
在 SignalR 中,用戶表示連接,一個用戶代表一個連接,一個“系統用戶”可以創建多個連接身份,通過函數集線器,可以給一個用戶的所有連接發送消息;比如一個“系統用戶”擁有多個連接,這些連接分別是 Web連接、AndroId手機客戶端連接,IOS手機客戶端連接、或者其它客戶端連接,“系統用戶”分別登錄了這些客戶端,同時創建了多個連接;默認情況下這些連接都通過 ClaimTypes.NameIdentifier 在 ClaimsPrincipal 于用戶標識進行關聯。
** 注意:用戶標識符是區分大小寫的,為了實現一個客戶多個連接,本例還簡單實現了一個基于 ClaimsIdentity 登錄接口,算是意外驚喜。
1.1 用戶連接管理
為了直觀的觀察到用戶是可以擁有多連接的,需要建立一個本地靜態對象,用于存儲用戶連接
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
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 給單個用戶發送消息
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
[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連接。
** 注意:當連接斷開后重新發起連接的時候,SignalR 不會保留組成員身份,必須重新加入分組。
下面的代碼演示了如何對分組進行操作,要對分組進行操作,主要包含三個方面:
2.1 加入分組
1
2
3
4
|
public async Task AddToGroupAsync( string groupName) { await Groups.AddToGroupAsync( this .Context.ConnectionId, groupName); } |
2.2 離開分組
1
2
3
4
|
public async Task RemoveFromGroupAsync( string groupName) { await Groups.RemoveFromGroupAsync( this .Context.ConnectionId, groupName); } |
2.3 發送消息到指定分組
1
2
3
4
|
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 演示代碼
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
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); } |
4. 一個簡單的示例
本示例代碼包含兩個簡單的界面
4.1 登錄
4.2 各種方式發送消息
結束語
最近在做一個開源項目,還處于試用階段,準備寫個使用的 WIKI 出來,看看大家是否感興趣,此 SingalR 系列只能不定期更新了,抱歉。
演示代碼下載
已托管到 GitHub 倉庫
https://github.com/lianggx/Examples/tree/master/SignalR/Ron.SignalRLesson2
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持服務器之家。
原文鏈接:http://www.cnblogs.com/viter/p/10638331.html