一. 说在前面的话

  该篇文章为实时通讯系列的第一节,基于WebSocket编写了一个简易版聊天样例,主要作用是为引出后面SignalR系列的用法及其强大方便之处,通过这个样例与后续的SignalR对比,可以体会到用原生的WebSocket编程的不灵活以及繁琐之处。(PS:下面那个案例 编写+调试 用了大约2个小时的时间)

  特别强调:该案例只是一个简易版的Demo,实现了一些基本的功能,起到一个基本入门的作用,在一些细节方面的限制、验证、以及关键信息的存放位置是有一定缺陷的,在实际项目中,需要根据实际情况进行调整。

  后面打算以一个真实的微信项目为例【二人夺宝】如下图,介绍里面需要用到的实时通讯技术,即SignalR在里面起到的作用,你会发现如果业务复杂,如果采用原生的WebSocket进行编程,“你能累死”,或者说有些功能很难实现。

 最后以一个真实的App混合开发项目【红猴代派】如下图,介绍用SignalR替代推送技术的实现。

 ps:鉴于保密协议,以上提到的两个项目名称并非最终上线的真实名称。

二. WebSocket简介

  WebSocket可以通过JS与服务器端建立实时的双向通信,它主要包括:2个核心方法、4个监听函数、1个核心属性。

2个核心方法:

  ① send() 向远程服务器发送信息

  ② close() 关闭与远程服务器的连接

4个监听函数:

  ① onopen 当网络连接建立成功时触发该事件
  ② onerror 当网络发生错误时触发该事件
  ③ onclose 当网络连接被关闭时触发该事件
  ④ onmessage 当websocket接收到服务器发来的消息的时触发该事件

1个核心属性:readyState,它有四种状态

  ① WebSocket.OPEN:表示与服务器已经建立好连接

  ② WebSocket.CLOSED:表示与服务器连接已经断开

  ③ WebSocket.CONNECTING:表示正在尝试与服务建立连接

  ④  WebSocket.CLOSING:表示正在关闭与服务器连接

服务器端主要用到两个方法:

  ① SendAsync()  发送信息给客户端

  ② CloseAsync() 关闭该Socket连接

三. 聊天室实现的功能

  1. 通过输入登录标记,进行建立连接,会提示当前所有在线的人(包括自己),登录成功。(Ps:同一个标记不能重复登录)

  2. 点击关闭连接,断开当前连接,提示除了自己以外的所有人,“某某离开了”。

  3. 群发功能:给所有在线的人(自己除外)的发送消息。

  4. 单发功能:点对点发送消息。(需要输入内容和接收人的标识)

 

四. 代码分享

  代码主要分为3部分组成:前端html页面、服务器端ashx一般处理程序、封装的消息发送帮助类。

前端页面代码:

 @{
Layout = null;
} <!DOCTYPE html> <html>
<head>
<meta name="viewport" content="width=device-width" />
<title>Index</title>
<script src="~/Scripts/jquery-3.3.1.min.js"></script>
<script> //封装WebSocket的相关方法
(function (w) {
//声明全局对象
var ws; //websocket对象
var url = "ws://localhost:9008/webSocketHandler.ashx"; //连接地址
var mainUitls = {
//1.初始化基本事件
init: function () {
this.initClick();
},
//2.建立通讯事件
initConnect: function () {
var newUrl = url + "?userKey=" + $("#j_userKey").val();
ws = new WebSocket(newUrl);
//2.1 网络建立连接的时候触发该事件
ws.onopen = function () {
$('#j_notice').html('已经连接');
}
//2.2 接受服务器发来消息时触发事件
ws.onmessage = function (evt) {
$("#j_Msg").append("<li>" + evt.data + "</li>");
}
//2.3 网络错误时候触发
ws.onerror = function (evt) {
$('#j_notice').html(JSON.stringify(evt));
}
//2.4 当连接关闭的时候触发该事件
ws.onclose = function () {
//这里根据实际场景来编写 (比如断线重连机制)
//该版本只是简单的给个提示
$('#j_notice').html("连接断开");
}
},
//3. 各种点击事件
initClick: function () {
//3.1 建立连接
$("#j_connect").on("click", function () {
if ($("#j_userKey").val()=="") {
$('#j_notice').html("请输入用户标记");
return;
}
mainUitls.initConnect();
});
//3.2 关闭连接
$("#j_close").on("click", function () {
ws.close();
});
//3.3 群发发送消息
$("#j_send").on("click", function () {
//表示与服务器已经建立好连接
if (ws.readyState == WebSocket.OPEN) {
ws.send($('#j_content').val());
}
//表示与服务器连接已经断开
else if (ws.readyState == WebSocket.CLOSED) {
$('#j_notice').html('与服务器连接已经断开');
}
//表示正在尝试与服务建立连接
else if (ws.readyState == WebSocket.CONNECTING) {
$('#j_notice').html('正在尝试与服务建立连接');
}
//正在关闭与服务器连接
else if (ws.readyState == WebSocket.CLOSING) {
$('#j_notice').html('正在关闭与服务器连接');
} });
//3.4 单发消息
$("#j_send2").on("click", function () {
var msg = $('#j_receiveUserKey').val();
if (msg=="") {
$('#j_notice').html('请输入接收人的标识');
return;
}
//下面对内容进行拼接
// "$--$--**" + msg + "$--$--**" + "发送的内容"; var finalMsg = "$--$--**" + msg + "$--$--**" + $('#j_content').val(); //表示与服务器已经建立好连接
if (ws.readyState == WebSocket.OPEN) {
ws.send(finalMsg);
}
//表示与服务器连接已经断开
else if (ws.readyState == WebSocket.CLOSED) {
$('#j_notice').html('与服务器连接已经断开');
}
//表示正在尝试与服务建立连接
else if (ws.readyState == WebSocket.CONNECTING) {
$('#j_notice').html('正在尝试与服务建立连接');
}
//正在关闭与服务器连接
else if (ws.readyState == WebSocket.CLOSING) {
$('#j_notice').html('正在关闭与服务器连接');
} });
} }; w.mainUitls = mainUitls;
})(window) $(function () {
mainUitls.init();
});
</script>
</head>
<body>
<div>
<div><span>提示:</span><span id="j_notice"></span></div>
<div style="margin-top:20px">
<input type="text" name="name" value="" placeholder="请输入登录标识" id="j_userKey" />
<button id="j_connect">建立连接</button>
<button id="j_close">关闭连接</button>
</div>
<div style="margin-top:20px">
<input type="text" value="" placeholder="请输入发送内容" id="j_content" />
<button id="j_send">群发</button>
</div> <div style="margin-top:20px">
<input type="text" value="" placeholder="请输入接收人标识" id="j_receiveUserKey" />
<button id="j_send2">单发</button>
</div>
<div>
<ul id="j_Msg"></ul>
</div>
</div>
</body>
</html>

一般处理程序代码:

 using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using System.Net.WebSockets;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Web;
using System.Web.SessionState;
using System.Web.WebSockets; namespace WebSocketDemo
{
/// <summary>
/// webSocketHander
/// </summary>
public class webSocketHandler : IHttpHandler, IRequiresSessionState
{
//用户登记标识
private string userKey = "";
public void ProcessRequest(HttpContext context)
{
if (context.IsWebSocketRequest)
{
this.userKey = context.Request.QueryString["userKey"];
context.AcceptWebSocketRequest(ProcessChat);
}
else
{
context.Response.Write("不是WebSocket请求");
}
}
private async Task ProcessChat(AspNetWebSocketContext context)
{
WebSocket socket = context.WebSocket;
CancellationToken cancellationToken = new CancellationToken();
bool isExits = WebManager.AddUser(userKey, socket);
if (isExits == false)
{
//表示该用户有在线
await WebManager.SendToMySelf(cancellationToken, $"用户【{this.userKey}】 已在线", this.userKey);
}
else
{
//表示登录成功
//某人登陆后,给群里其他人发送提示信息(本人除外)
await WebManager.SendLoginSucesssNotice(cancellationToken, $"用户【{this.userKey}】 进入聊天室,当前时间:{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss")}");
while (socket.State == WebSocketState.Open)
{
ArraySegment<byte> buffer = new ArraySegment<byte>(new byte[]);
//接受指令
WebSocketReceiveResult result = await socket.ReceiveAsync(buffer, cancellationToken);
//表示是关闭指令
if (result.MessageType == WebSocketMessageType.Close)
{
//移除该用户对应的socket对象
WebManager.RemoveUser(userKey);
//发送离开提醒
await WebManager.SendOutNotice(cancellationToken, $"用户【{this.userKey}】 离开聊天室,当前时间:{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss")}");
await socket.CloseAsync(WebSocketCloseStatus.NormalClosure, String.Empty, cancellationToken);
}
//获取是发送消息指令
else
{
string userMsg = Encoding.UTF8.GetString(buffer.Array, , result.Count);
//这里要区分是单发还是群发(通过与前端在内容开头做一个标记,来区分是单发还是群发)
if (userMsg.Length > && userMsg.Substring(, ) == "$--$--**")
{
//表示是单发,截取内容和接受者的标记
var array = userMsg.Split(new string[] { "$--$--**" }, StringSplitOptions.None);
var receiveNotice = array[];
string content = $"用户【{this.userKey}】 发来消息:{array[2]},当前时间:{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss")}";
WebManager.SendSingleMessage(cancellationToken, content, receiveNotice);
}
else
{
//表示群发信息
string content = $"用户【{this.userKey}】 群发消息:{userMsg},当前时间:{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss")}";
WebManager.SendAllMessage(cancellationToken, content, userKey);
}
}
}
} } /// <summary>
/// true 如果 System.Web.IHttpHandler 实例是可重复使用; 否则为 false。
/// </summary>
public bool IsReusable
{
get
{
return false;
}
}
} }

帮助类代码:

 using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using System.Net.WebSockets;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Web;
using System.Web.SessionState; namespace WebSocketDemo
{
/// <summary>
/// webSocket帮助类
/// </summary>
public class WebManager
{
/// <summary>
/// 这采用ConcurrentDictionary字典,是线程安全的,不需要加锁
/// </summary>
private static ConcurrentDictionary<string, WebSocket> _UserDictionary = new ConcurrentDictionary<string, WebSocket>(); #region 01-增加用户
/// <summary>
/// 增加用户
/// </summary>
/// <param name="userKey"></param>
/// <param name="socket"></param>
public static bool AddUser(string userKey, WebSocket socket)
{ bool flag = _UserDictionary.Select(d => d.Key).ToList().Contains(userKey);
if (flag == false)
{
_UserDictionary[userKey] = socket;
return true;
}
else
{
//表示该用户在线
return false; }
}
#endregion #region 02-移除用户
/// <summary>
/// 移除用户
/// </summary>
/// <param name="userKey"></param>
public static void RemoveUser(string userKey)
{
WebSocket socket = null;
_UserDictionary.TryRemove(userKey, out socket);
}
#endregion #region 03-登录提醒 /// <summary>
/// 登录提醒(包括自己)
/// </summary>
/// <param name="cancellationToken"></param>
/// <param name="content"></param>
/// <returns></returns>
public static async Task SendLoginSucesssNotice(CancellationToken cancellationToken, string content)
{
ArraySegment<byte> buffer = new ArraySegment<byte>(new byte[]);
buffer = new ArraySegment<byte>(Encoding.UTF8.GetBytes(content));
//登录提醒(包括自己)
foreach (var socket in _UserDictionary.Select(d => d.Value))
{
await socket.SendAsync(buffer, WebSocketMessageType.Text, true, cancellationToken);
}
} #endregion #region 04-离开提醒 /// <summary>
/// 离开提醒
/// </summary>
/// <param name="cancellationToken"></param>
/// <param name="content"></param>
/// <returns></returns>
public static async Task SendOutNotice(CancellationToken cancellationToken, string content)
{
ArraySegment<byte> buffer = new ArraySegment<byte>(new byte[]);
buffer = new ArraySegment<byte>(Encoding.UTF8.GetBytes(content));
//离开提醒
foreach (var socket in _UserDictionary.Select(d => d.Value))
{
await socket.SendAsync(buffer, WebSocketMessageType.Text, true, cancellationToken);
}
} #endregion #region 05-群发消息,不包括自己
/// <summary>
/// 群发消息,不包括自己
/// </summary>
/// <param name="cancellationToken"></param>
/// <param name="content"></param>
/// <param name="myUserKey">当前用户标记</param>
/// <returns></returns>
public static void SendAllMessage(CancellationToken cancellationToken, string content, string myUserKey)
{
try
{
ArraySegment<byte> buffer = new ArraySegment<byte>(new byte[]);
buffer = new ArraySegment<byte>(Encoding.UTF8.GetBytes(content));
//群发消息,但不包括自己
foreach (var item in _UserDictionary)
{
if (item.Key.ToString() != myUserKey)
{
item.Value.SendAsync(buffer, WebSocketMessageType.Text, true, cancellationToken);
}
}
}
catch (Exception ex)
{
var msg = ex.Message;
}
}
#endregion #region 06-单发消息
/// <summary>
/// 单发消息
/// </summary>
/// <param name="cancellationToken"></param>
/// <param name="content"></param>
/// <param name="receiveKey">接收者的标识</param>
/// <returns></returns>
public static void SendSingleMessage(CancellationToken cancellationToken, string content, string receiveKey)
{
try
{
ArraySegment<byte> buffer = new ArraySegment<byte>(new byte[]);
buffer = new ArraySegment<byte>(Encoding.UTF8.GetBytes(content));
//单发消息
foreach (var item in _UserDictionary)
{
if (item.Key.ToString() == receiveKey)
{
item.Value.SendAsync(buffer, WebSocketMessageType.Text, true, cancellationToken);
}
}
}
catch (Exception ex)
{
var msg = ex.Message;
}
}
#endregion #region 07-给自己发送消息 /// <summary>
/// 给自己发送消息
/// </summary>
/// <param name="cancellationToken"></param>
/// <param name="content"></param>
/// <param name="userKey">当前标记</param>
/// <returns></returns>
public static async Task SendToMySelf(CancellationToken cancellationToken, string content,string userKey)
{
ArraySegment<byte> buffer = new ArraySegment<byte>(new byte[]);
buffer = new ArraySegment<byte>(Encoding.UTF8.GetBytes(content));
//离开提醒
foreach (var item in _UserDictionary)
{
if (item.Key.ToString() == userKey)
{
await item.Value.SendAsync(buffer, WebSocketMessageType.Text, true, cancellationToken);
}
}
}
#endregion }
}

最终实现效果:

五. 局限与后续计划

  通过上面这个小例子,我觉得WebSocket主要有这么两个缺陷:

  1. 众所周知,很多低版本的浏览器不支持。

  2. 代码写起来繁琐,客户端和服务器端之间不能自行指定方法名进行直接调用,比如上面单发和群发在客户端是只能通过Send方法进行发送到服务器端固定的位置,使得不得不自己约定规则进行区分;再比如:客户端消息的接受只能通过onmessage进行监听,非常局限不灵活。

  而SignalR很好的解决了上面的两个问题。

    补充一张websocket的兼容性,下图来自于网络。

  

  后续章节开始详细的介绍SignalR的用法,大约3天一篇,有兴趣的朋友可以关注该系列,互相讨论,共同提高。

 

!

  • 作       者 : Yaopengfei(姚鹏飞)
  • 博客地址 : http://www.cnblogs.com/yaopengfei/
  • 声     明1 : 本人才疏学浅,用郭德纲的话说“我是一个小学生”,如有错误,欢迎讨论,请勿谩骂^_^。
  • 声     明2 : 原创博客请在转载时保留原文链接或在文章开头加上本人博客地址,如需代码请在评论处留下你的邮箱
 

第一节:.Net版基于WebSocket的聊天室样例的更多相关文章

  1. Ext JS学习第十六天 事件机制event(一) DotNet进阶系列(持续更新) 第一节:.Net版基于WebSocket的聊天室样例 第十五节:深入理解async和await的作用及各种适用场景和用法 第十五节:深入理解async和await的作用及各种适用场景和用法 前端自动化准备和详细配置(NVM、NPM/CNPM、NodeJs、NRM、WebPack、Gulp/Grunt、G

    code&monkey   Ext JS学习第十六天 事件机制event(一) 此文用来记录学习笔记: 休息了好几天,从今天开始继续保持更新,鞭策自己学习 今天我们来说一说什么是事件,对于事件 ...

  2. 基于WebSocket实现聊天室(Node)

    基于WebSocket实现聊天室(Node) WebSocket是基于TCP的长连接通信协议,服务端可以主动向前端传递数据,相比比AJAX轮询服务器,WebSocket采用监听的方式,减轻了服务器压力 ...

  3. 第四节:SignalR灵魂所在Hub模型及再探聊天室样例

    一. 整体介绍 本节:开始介绍SignalR另外一种通讯模型Hub(中心模型,或者叫集线器模型),它是一种RPC模式,允许客户端和服务器端各自自定义方法并且相互调用,对开发者来说相当友好. 该节包括的 ...

  4. 基于webSocket的聊天室

    前言 不知大家在平时的需求中有没有遇到需要实时处理信息的情况,如站内信,订阅,聊天之类的.在这之前我们通常想到的方法一般都是采用轮训的方式每隔一定的时间向服务器发送请求从而获得最新的数据,但这样会浪费 ...

  5. Swift - 使用socket进行通信(附聊天室样例)

    在Swift开发中,如果我们需要保持客服端和服务器的长连接进行双向的数据通信,使用socket是一种很好的解决方案. 下面通过一个聊天室的样例来演示socket通信,这里我们使用了一个封装好的sock ...

  6. [已解决][HTML5]基于WebSocket开发聊天室应用

    WebSocket示例java的比较少,大部分是nodejs的,比较有名的是socket.io的chat, 借用下他的前端实现一套java的,后端基于https://github.com/genera ...

  7. WebSocket 网页聊天室

    先给大家开一个原始的websocket的连接使用范例 <?php /* * recv是从套接口接收数据,也就是拿过来,但是不知道是什么 * read是读取拿过来的数据,就是要知道recv过来的是 ...

  8. 最简单的基于FFmpeg的移动端样例:Android 视频解码器-单个库版

    ===================================================== 最简单的基于FFmpeg的移动端样例系列文章列表: 最简单的基于FFmpeg的移动端样例:A ...

  9. websocket+golang聊天室

    原文地址: http://www.niu12.com/article/3 websocket+golang聊天室 main.go和index.html放在同一目录下 main.go package m ...

随机推荐

  1. 快速开发Grunt插件----压缩js模板

    前言 Grunt是一款前端构建工具,帮助我们自动化搭建前端工程.它可以实现自动对js.css.html文件的合并.压缩等一些列操作.Grunt有很多插件,每一款插件实现某个功能,你可以通过npm命名去 ...

  2. -[UIKeyboardLayoutStar release]: message sent to deallocated instance

    网上大家都说是因为替换了系统的objextAtIndex方法,但是为了减少应用崩溃的可能,是要进行Hook的,所以不想取消Hook. 解决办法,关掉键盘进入后台. - (void)applicatio ...

  3. OpenFramework中视频或者图片进行中心旋转、平移、放大、缩小、矫正(本例以视频为准,只给出主要代码)

    /********** update mesh部分***********/ for(int i=0;i<4;i++) {  mesh[i].clear(); //重要,不加的话,移动视频的四个角 ...

  4. color 颜色代码 android res/values/colors.xml

    <?xml version="1.0" encoding="utf-8"?> <resources> <color name=&q ...

  5. 【转】Windows环境下Android NDK环境搭建

    原文网址:http://www.metsky.com/archives/525.html 前面介绍Windows下Android 开发环境配置,主要是面向JAVA开发环境,对只做APK上层应用开发人员 ...

  6. BZOJ 1030 [JSOI2007]文本生成器

    1030: [JSOI2007]文本生成器 Time Limit: 1 Sec  Memory Limit: 162 MBSubmit: 2624  Solved: 1087[Submit][Stat ...

  7. STM32f103------ADC(DMA)

    STM32F10x  ADC 技术指标: 分辨率: 12位分辨率  LSB=Vref+  / 2^(12) 转换时间: 采样一次至少14个ADC时钟周期 ,而ADC最高时钟周期为14MHz  选用采样 ...

  8. 获得view所在的控制器

    - (UIViewController*)getViewController{ for (UIView* next = [self superview]; next; next = next.supe ...

  9. 关于Springmvc中include与Sitemesh装饰器的基本使用

    关于Springmvc中include与Sitemesh装饰器的使用 !!!转载请注明出处=>http://www.cnblogs.com/funnyzpc/p/7283443.html 静态包 ...

  10. centos7的内核区别

    最近重新搭建环境准备测试一些东西,在网上随意下载了一个镜像,名字叫做:CentOS-7-i386-Everything-1810 下载完之后开始做实验安装软件的时候发现一直报错:[Errno 14] ...