Asp.net使用SignalR实现聊天室的功能

一、引言
在前一篇文章《asp.net使用signalr实现酷炫端对端聊天功能》中,我向大家介绍了如何实现实现端对端聊天的功能的,在这一篇文章中将像大家如何使用signalr实现群聊这样的功能。

二、实现思路
  要想实现群聊的功能,首先我们需要创建一个房间,然后每个在线用户可以加入这个房间里面进行群聊,我们可以为房间设置一个唯一的名字来作为标识。那SignalR类库里面是否有这样现有的方法呢?答案是肯定的。

// IGroupManager接口提供如下方法// 作用:将连接ID加入某个组// Context.ConnectionId 连接ID,每个页面连接集线器即会产生唯一ID// roomName分组的名称Groups.Add(Context.ConnectionId, roomName); // 作用:将连接ID从某个分组移除Groups.Remove(Context.ConnectionId, roomName); // IHubConnectionContext接口提供了如下方法// 调用客户端方法向房间内所有用户群发消息// Room:分组名称// new string[0]:过滤(不发送)的连接ID数组 Clients.Group(Room, new string[0]).clientMethod

登录后复制

   

  上面的代码也就是实现群聊的核心方法。Groups对象说白了也就是SignalR类库维护的一个列表对象而已,其实我们完全可以自己来维护一个Dictionary>这个对象,创建一个房间的时候,我们将房间名称和进入房间的客户端的ConnectionId加入到这个字典里面,然后在聊天室里面点发送消息的时候,我们根据房间名查找到所有加入群聊的ConnectionId,然后调用Clients.Clients(IList connectionIds)方法来将消息群发到每个客户端。以上也就是实现聊天室的原理。

三、使用SignalR实现聊天室的功能
理清楚了实现思路之后,接下来我们就看下具体的实现代码,同时大家也可以对照代码来对照前面的实现思路。
首先看下聊天室功能所涉及实体类的实现代码:

///  /// 用户类 ///  public class User {  ///   /// 用户Id  ///   public string UserId { get; set; }   ///   /// 用户的连接集合  ///   public List Connections { get; set; }   ///   /// 用户房间集合,一个用户可以加入多个房间  ///   public List Rooms { get; set; }   public User()  {   Connections = new List();   Rooms = new List();  } }  public class Connection {  //连接ID  public string ConnectionId { get; set; }   //用户代理  public string UserAgent { get; set; }  //是否连接  public bool Connected { get; set; } }   ///  /// 房间类 ///  public class ChatRoom {  // 房间名称  public string RoomName { get; set; }   // 用户集合  public List Users { get; set; }   public ChatRoom()  {   Users = new List();  } }  ///  /// 上下文类,用来模拟EF中的DbContext ///  public class ChatContext {  public List Users { get; set; }   public List Connections { get; set; }   public List Rooms { get; set; }   public ChatContext()  {   Users = new List();   Connections = new List();   Rooms = new List();  } }

登录后复制

   

2. 接下来,让我们来看到集线器的实现:

[HubName("chatRoomHub")] public class GroupsHub : Hub {  public static ChatContext DbContext = new ChatContext();   #region IHub Members  // 重写Hub连接事件  public override Task OnConnected()  {   // 查询用户   var user = DbContext.Users.FirstOrDefault(u => u.UserId == Context.ConnectionId);    if (user == null)   {    user = new User    {     UserId = Context.ConnectionId    };     DbContext.Users.Add(user);   }    // 发送房间列表   var items = DbContext.Rooms.Select(p => new {p.RoomName});   Clients.Client(this.Context.ConnectionId).getRoomList(JsonHelper.ToJsonString(items.ToList()));   return base.OnConnected();  }   // 重写Hub连接断开的事件  public override Task OnDisconnected(bool stopCalled)  {   // 查询用户   var user = DbContext.Users.FirstOrDefault(u => u.UserId == Context.ConnectionId);    if (user != null)   {    // 删除用户    DbContext.Users.Remove(user);     // 从房间中移除用户    foreach (var item in user.Rooms)    {     RemoveUserFromRoom(item.RoomName);    }   }   return base.OnDisconnected(stopCalled);  }   #endregion   #region Public Methods   // 为所有用户更新房间列表  public void UpdateRoomList()  {   var itme = DbContext.Rooms.Select(p => new {p.RoomName});   var jsondata = JsonHelper.ToJsonString(itme.ToList());   Clients.All.getRoomlist(jsondata);  }   ///   /// 加入聊天室  ///   public void JoinRoom(string roomName)  {   // 查询聊天室   var room = DbContext.Rooms.Find(p => p.RoomName == roomName);    // 存在则加入   if (room == null) return;    // 查找房间中是否存在此用户   var isExistUser = room.Users.FirstOrDefault(u => u.UserId == Context.ConnectionId);    // 不存在则加入   if (isExistUser == null)   {    var user = DbContext.Users.Find(u => u.UserId == Context.ConnectionId);    user.Rooms.Add(room);    room.Users.Add(user);         // 将客户端的连接ID加入到组里面    Groups.Add(Context.ConnectionId, roomName);     //调用此连接用户的本地JS(显示房间)    Clients.Client(Context.ConnectionId).joinRoom(roomName);   }   else   {    Clients.Client(Context.ConnectionId).showMessage("请勿重复加入房间!");   }  }   ///   /// 创建聊天室  ///   ///   public void CreateRoom(string roomName)  {   var room = DbContext.Rooms.Find(a => a.RoomName == roomName);   if (room == null)   {    var cr = new ChatRoom    {     RoomName = roomName    };     //将房间加入列表    DbContext.Rooms.Add(cr);     // 本人加入聊天室    JoinRoom(roomName);    UpdateRoomList();   }   else   {    Clients.Client(Context.ConnectionId).showMessage("房间名重复!");   }  }   public void RemoveUserFromRoom(string roomName)  {   //查找房间是否存在   var room = DbContext.Rooms.Find(a => a.RoomName == roomName);    //存在则进入删除   if (room == null)   {    Clients.Client(Context.ConnectionId).showMessage("房间名不存在!");    return;   }    // 查找要删除的用户   var user = room.Users.FirstOrDefault(a => a.UserId == Context.ConnectionId);   // 移除此用户   room.Users.Remove(user);   //如果房间人数为0,则删除房间   if (room.Users.Count   /// 给房间内所有的用户发送消息  ///   /// 房间名  /// 信息  public void SendMessage(string room, string message)  {   // 调用房间内所有客户端的sendMessage方法   // 因为在加入房间的时候,已经将客户端的ConnectionId添加到Groups对象中了,所有可以根据房间名找到房间内的所有连接Id   // 其实我们也可以自己实现Group方法,我们只需要用List记录所有加入房间的ConnectionId   // 然后调用Clients.Clients(connectionIdList),参数为我们记录的连接Id数组。   Clients.Group(room, new string[0]).sendMessage(room, message + " " + DateTime.Now);  }  #endregion}

登录后复制

   

3. 上面SignalR服务端的代码实现已经完成,接下来就让我们一起看看客户端视图的实现:

@{ Layout = null;} nbsp;html>   Index         var chat;  var roomcount = 0;     $(function() {   chat = $.connection.chatRoomHub;   chat.client.showMessage = function(message) {    alert(message);   };   chat.client.sendMessage = function(roomname, message) {    $("#" + roomname).find("ul").each(function() {     $(this).append('
  • ' + message + ''); }); }; chat.client.removeRoom = function(data) { alert(data); }; chat.client.joinRoom = function (roomname) { var html = '