首页 > 后端开发 > C#.Net教程 > Asp.net使用SignalR实现酷炫端对端聊天功能

Asp.net使用SignalR实现酷炫端对端聊天功能

高洛峰
发布: 2016-12-24 14:16:56
原创
1571 人浏览过

一、引言

  在前一篇文章已经详细介绍了SignalR了,并且简单介绍它在Asp.net MVC 和WPF中的应用。在上篇博文介绍的都是群发消息的实现,然而,对于SignalR是为了实时聊天而生的,自然少了不像QQ一样的端对端的聊天了。本篇博文将介绍如何使用SignalR来实现类似QQ聊天的功能。

二、使用SignalR实现端对端聊天的思路

   在介绍具体实现之前,我先来介绍了使用SignalR实现端对端聊天的思路。相信大家在前篇文章已经看到过Clients.All.sendMessage(name, message);这样的代码,其表示调用所有客户端的SendMessage。SignalR的集线器使得客户端和服务端可以进行实时通信。那要实现端对端的聊天,自然就不能像所有客户端发送消息了,而只能向特定的客户端发送消息才可以,不然不就乱套了,没有任何隐私权了。那怎样才可以向特定的客户端发送消息呢?这个问题也就是我们实现端对端聊天功能的关键。

  我们发送Clients对象除了All属性外,还具有其他属性,你可以在VS中按F12来查看Clients对象的所有属性或方法,具体的定义如下:

public interface IHubConnectionContext<T>
{
T All { get; } // 代表所有客户端
 
T AllExcept(params string[] excludeConnectionIds); // 除了参数中的所有客户端
T Client(string connectionId); // 特定的客户端,这个方法也就是我们实现端对端聊天的关键
T Clients(IList<string> connectionIds); // 参数中的客户端端
T Group(string groupName, params string[] excludeConnectionIds); // 指定客户端组,这个也是实现群聊的关键所在
T Groups(IList<string> groupNames, params string[] excludeConnectionIds);
T User(string userId); // 特定的用户
T Users(IList<string> userIds); // 参数中的用户
}
登录后复制

  在SignalR中,每一个客户端为标记其唯一性,SignalR都会分配它一个ConnnectionId,这样我们就可以通过ConnnectionId来找到特定的客户端了。这样,我们在向某个客户端发送消息的时候,除了要将消息传入,也需要将发送给对方的ConnectionId输入,这样服务端就能根据传入的ConnectionId来转发对应的消息给对应的客户端了。这样也就完成了端对端聊天的功能。另外,如果用户如果不在线的话,服务端可以把消息保存到数据库中,等对应的客户端上线的时候,再从数据库中查看该客户端是否有消息需要推送,有的话,从数据库取出数据,将该数据推送给该客户端。(不过这点,服务端缓存数据的功能本篇博文没有实现,在这里介绍就是让大家明白QQ一个实现原理)。

  下面我们来梳理下端对端聊天功能的实现思路:

客户端登入的时候记录下客户端的ConnnectionId,并将用户加入到一个静态数组中,该数据为了记录所有在线用户。
用户可以点击在线用户中的用户聊天,在发送消息的时候,需要将ConnectionId一并传入到服务端。
服务端根据传入的消息内容和ConnectionId调用Clients.Client(connnection).sendMessage方法来进行转发到对应的客户端。

三、实现酷炫聊天功能核心代码

  有了实现思路,实现功能也就得心应手了,接下来,让我们先看下集线器ChatHub中的代码:

public class ChatHub : Hub
 {
 // 静态属性
 public static List<UserInfo> OnlineUsers = new List<UserInfo>(); // 在线用户列表
 
 /// <summary>
 /// 登录连线
 /// </summary>
 /// <param name="userId">用户Id</param>
 /// <param name="userName">用户名</param>
 public void Connect(string userId, string userName)
 {
  var connnectId = Context.ConnectionId;
 
  if (OnlineUsers.Count(x => x.ConnectionId == connnectId) == 0)
  {
  if (OnlineUsers.Any(x => x.UserId == userId))
  {
   var items = OnlineUsers.Where(x => x.UserId == userId).ToList();
   foreach (var item in items)
   {
   Clients.AllExcept(connnectId).onUserDisconnected(item.ConnectionId, item.UserName);
   }
   OnlineUsers.RemoveAll(x => x.UserId == userId);
  }
 
  //添加在线人员
  OnlineUsers.Add(new UserInfo
  {
   ConnectionId = connnectId,
   UserId = userId,
   UserName = userName,
   LastLoginTime = DateTime.Now
  });
  }
 
  // 所有客户端同步在线用户
  Clients.All.onConnected(connnectId, userName, OnlineUsers);
 }
 
 
 /// <summary>
 /// 发送私聊
 /// </summary>
 /// <param name="toUserId">接收方用户连接ID</param>
 /// <param name="message">内容</param>
 public void SendPrivateMessage(string toUserId, string message)
 {
  var fromUserId = Context.ConnectionId;
 
  var toUser = OnlineUsers.FirstOrDefault(x => x.ConnectionId == toUserId);
  var fromUser = OnlineUsers.FirstOrDefault(x => x.ConnectionId == fromUserId);
 
  if (toUser != null && fromUser != null)
  {
  // send to
  Clients.Client(toUserId).receivePrivateMessage(fromUserId, fromUser.UserName, message);
 
  // send to caller user
  // Clients.Caller.sendPrivateMessage(toUserId, fromUser.UserName, message);
  }
  else
  {
  //表示对方不在线
  Clients.Caller.absentSubscriber();
  }
 }
 
 /// <summary>
 /// 断线时调用
 /// </summary>
 /// <param name="stopCalled"></param>
 /// <returns></returns>
 public override Task OnDisconnected(bool stopCalled)
 {
  var user = OnlineUsers.FirstOrDefault(u => u.ConnectionId == Context.ConnectionId);
 
  // 判断用户是否存在,存在则删除
  if (user == null) return base.OnDisconnected(stopCalled);
 
  Clients.All.onUserDisconnected(user.ConnectionId, user.UserName); //调用客户端用户离线通知
  // 删除用户
  OnlineUsers.Remove(user);
 
 
  return base.OnDisconnected(stopCalled);
 }
 }
登录后复制

  上面是服务端主要的实现,接下来看看客户端的实现代码:

<script type="text/javascript">
var systemHub = $.connection.chatHub;
/ 连接IM服务器成功
// 主要是更新在线用户
systemHub.client.onConnected = function (id, userName, allUsers) {
 var node = chatCore.node, myf = node.list.eq(0), str = &#39;&#39;, i = 0;
 myf.addClass(&#39;loading&#39;);
 onlinenum = allUsers.length;
 if (onlinenum > 0) {
 str += &#39;<li class="ChatCore_parentnode ChatCore_liston">&#39;
  + &#39;<h5><i></i><span class="ChatCore_parentname">在线用户</span><em class="ChatCore_nums">(&#39; + onlinenum + &#39;)</em></h5>&#39;
  + &#39;<ul id="ChatCore_friend_list" class="ChatCore_chatlist">&#39;;
 for (; i < onlinenum; i++) {
  str += &#39;<li id="userid-&#39; + allUsers[i].UserID + &#39;" data-id="&#39; + allUsers[i].ConnectionId + &#39;" class="ChatCore_childnode" type="one"><img src="/Content/Images/001.jpg?&#39; + allUsers[i].UserID + &#39;" class="ChatCore_oneface"><span class="ChatCore_onename">&#39; + allUsers[i].UserName + &#39;(&#39; + &#39;)</span><em class="ChatCore_time">&#39; + allUsers[i].LoginTime + &#39;</em></li>&#39;;
 }
 str += &#39;</ul></li>&#39;;
 myf.html(str);
 } else {
 myf.html(&#39;<li class="ChatCore_errormsg">没有任何数据</li>&#39;);
 }
 myf.removeClass(&#39;loading&#39;);
};
//消息传输
chatCore.transmit = function () {
var node = chatCore.node, log = {};
node.sendbtn = $(&#39;#ChatCore_sendbtn&#39;);
node.imwrite = $(&#39;#ChatCore_write&#39;);
 
//发送
log.send = function () {
 var data = {
 content: node.imwrite.val(),
 id: chatCore.nowchat.id,
 sign_key: &#39;&#39;, //密匙
 _: +new Date
 };
 
 if (data.content.replace(/\s/g, &#39;&#39;) === &#39;&#39;) {
 layer.tips(&#39;说点啥呗!&#39;, &#39;#ChatCore_write&#39;, 2);
 node.imwrite.focus();
 } else {
 //此处皆为模拟
 var keys = chatCore.nowchat.type + chatCore.nowchat.id;
 
 //聊天模版
 log.html = function (param, type) {
  return &#39;<li class="&#39; + (type === &#39;me&#39; ? &#39;ChatCore_chateme&#39; : &#39;&#39;) + &#39;">&#39;
  + &#39;<div class="ChatCore_chatuser">&#39;
   + function () {
   if (type === &#39;me&#39;) {
    return &#39;<span class="ChatCore_chattime">&#39; + param.time + &#39;</span>&#39;
     + &#39;<span class="ChatCore_chatname">&#39; + param.name + &#39;</span>&#39;
     + &#39;<img src="&#39; + param.face + &#39;" >&#39;;
   } else {
    return &#39;<img src="&#39; + param.face + &#39;" >&#39;
     + &#39;<span class="ChatCore_chatname">&#39; + param.name + &#39;</span>&#39;
     + &#39;<span class="ChatCore_chattime">&#39; + param.time + &#39;</span>&#39;;
   }
   }()
  + &#39;</div>&#39;
  + &#39;<div class="ChatCore_chatsay">&#39; + param.content + &#39;<em class="ChatCore_zero"></em></div>&#39;
  + &#39;</li>&#39;;
 };
 
 log.imarea = chatCore.chatbox.find(&#39;#ChatCore_area&#39; + keys);
 
 log.imarea.append(log.html({
  time: new Date().toLocaleString(),
  name: config.user.name,
  face: config.user.face,
  content: data.content
 }, &#39;me&#39;));
 node.imwrite.val(&#39;&#39;).focus();
 log.imarea.scrollTop(log.imarea[0].scrollHeight);
 
 // 调用服务端sendPrivateMessage方法来转发消息
 systemHub.server.sendPrivateMessage(chatCore.nowchat.id, data.content);
 }
 
};
node.sendbtn.on(&#39;click&#39;, log.send);
 
node.imwrite.keyup(function (e) {
 if (e.keyCode === 13) {
 log.send();
 }
});
};
 
//用户离线
systemHub.client.onUserDisconnected = function (id, userName) {
 onlinenum = onlinenum - 1;
 $(".ChatCore_nums").html("(" + onlinenum + ")");
 $("#ChatCore_friend_list li[data-id=" + id + "]").remove();
};
// 启动连接
$.connection.hub.start().done(function () {
 systemHub.server.connect(userid, username); // 调用服务端connect方法
});
</script>
登录后复制

   

  上面只是列出了一些核心代码实现。另外,为了实现的酷炫的效果,这里采用了一个Jquery插件:layer,官方网址为:http://layer.layui.com/。这个插件主要为了实现弹出框和弹出层的效果,要实现酷炫的聊天特效,就需要自己写JS代码了,由于本人并不是很熟悉前端,所以这个JS特效代码也是参考网络上的实现。大家如果想运行查看效果,建议到文章末尾下载源码进行运行。

四、最终效果

   介绍完了实现思路和实现代码之后,既然就到了我们激动人心的一刻了,那就是看看我们实现功能是否可以满足需求,另外,除了满足基本的聊天功能外,还需要看看界面是不是够酷炫。

Asp.net使用SignalR实现酷炫端对端聊天功能



更多Asp.net使用SignalR实现酷炫端对端聊天功能相关文章请关注PHP中文网!


相关标签:
来源:php.cn
本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板