利用html 5 websocket做个山寨版web聊天室(手写C#服务器)

  1. 云栖社区>
  2. 博客>
  3. 正文

利用html 5 websocket做个山寨版web聊天室(手写C#服务器)

橘子红了呐 2017-11-21 22:21:00 浏览1332
展开阅读全文

之前的博客中提到过看到html5 的websocket后很感兴趣,终于可以摆脱长轮询(websocket之前的实现方式可以看看Developer Works上的一篇文章,有简单提到,同时也说了websocket基本概念)等方式做一个山寨版的web聊天室。

什么是websocket

 WebSocket 协议是html5引入的一种新的协议,其目的在于实现了浏览器与服务器全双工通信。看了上面链接的同学肯定对过去怎么低效率高消耗(轮询或comet)的做此事已经有所了解了,而在websocket API,浏览器和服务器只需要要做一个握手的动作,然后,浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。同时这么做有两个好处

1.通信传输字节减少:比起以前使用http传输数据,websocket传输的额外信息很少,据百度说只有2k

2.服务器可以主动向客户端推送消息,而不用客户端去查询

关于概念和好处,网上到处都是,不再赘述,简单看看其原理,然后动手写一个web版聊天室吧

握手

 除了TCP连接的三次握手,websocket协议中客户端与服务器想建立连接需要一次额外的握手动作,在最新版的协议中是这个样子的

客户端向服务器发送请求

复制代码
GET / HTTP/1.1
Upgrade: websocket
Connection: Upgrade
Host: 127.0.0.1:8080
Origin: http://test.com
Pragma: no-cache
Cache-Control: no-cache
Sec-WebSocket-Key: OtZtd55qBhJF2XLNDRgUMg==
Sec-WebSocket-Version: 13
Sec-WebSocket-Extensions: x-webkit-deflate-frame
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36
复制代码

服务器给出响应

HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: xsOSgr30aKL2GNZKNHKmeT1qYjA=

 在请求中的“Sec-WebSocket-Key”是随机的,服务器端会用这些数据来构造出一个SHA-1的信息摘要。把“Sec-WebSocket-Key”加上一个魔幻字符串“258EAFA5-E914-47DA-95CA-C5AB0DC85B11”。使用 SHA-1 加密,之后进行 BASE-64编码,将结果做为 “Sec-WebSocket-Accept” 头的值,返回给客户端(来自维基百科)。

websocket API

经过握手之后浏览器与服务器建立连接,两者就可以互相通信了。websocket的API真心很简单,看看W3C的定义

复制代码
enum BinaryType { "blob", "arraybuffer" };
[Constructor(DOMString url, optional (DOMString or DOMString[]) protocols)]
interface WebSocket : EventTarget {
  readonly attribute DOMString url;

  // ready state
  const unsigned short CONNECTING = 0;
  const unsigned short OPEN = 1;
  const unsigned short CLOSING = 2;
  const unsigned short CLOSED = 3;
  readonly attribute unsigned short readyState;
  readonly attribute unsigned long bufferedAmount;

  // networking
           attribute EventHandler onopen;
           attribute EventHandler onerror;
           attribute EventHandler onclose;
  readonly attribute DOMString extensions;
  readonly attribute DOMString protocol;
  void close([Clamp] optional unsigned short code, optional DOMString reason);

  // messaging
           attribute EventHandler onmessage;
           attribute BinaryType binaryType;
  void send(DOMString data);
  void send(Blob data);
  void send(ArrayBuffer data);
  void send(ArrayBufferView data);
};
复制代码

创建websocket

ws=new WebSocket(address); //ws://127.0.0.1:8080

 

调用其构造函数,传入地址,就可以创建一个websocket了,值得注意的是地址协议得是ws/wss

关闭socket

ws.close();

 

调用webservice实例的close()方法就可以关闭webservice,当然也可以传入一个code和string说明为什么关了

几个回调函数句柄

由于其异步执行,回调函数自然少不了,有四个重要的

  • onopen:连接创建后调用
  • onmessage:接收到服务器消息后调用
  • onerror:出错时调用
  • onclose:关闭连接的时候调用

看名字就知道是干什么的了,每个回调函数都会传入一个Event对象,可以通过event.data访问消息

使用API

我们可以在创建socket成功后为其回调函数赋值

复制代码
ws=new WebSocket(address);
            ws.onopen=function(e){
                var msg=document.createElement('div');
                msg.style.color='#0f0';
                msg.innerHTML="Server > connection open.";
                msgContainer.appendChild(msg);
                ws.send('{<'+document.getElementById('name').value+'>}');
            };
复制代码

 也可以通过事件绑定的方式

复制代码
ws=new WebSocket(address);
            ws.addEventListener('open',function(e){
                var msg=document.createElement('div');
                msg.style.color='#0f0';
                msg.innerHTML="Server > connection open.";
                msgContainer.appendChild(msg);
                ws.send('{<'+document.getElementById('name').value+'>}');
            });
复制代码

 客户端实现

其实客户端的实现比较简单,除了websocket相关的几句就是一些自动focus、回车键事件处理、消息框自动定位到底部等简单功能,不一一说明了

View Code

 

服务器支持

 其实websocket的服务器实现网上可以找到很多了,向维基百科中列出的

 但是我希望加入一些自己特定的处理,比如用户名识别啊、广播啊什么的,所以自己实现了一个简单的C#版本

websocket 聊天室C#服务器实现

我上篇博客C# socket编程实践——支持广播的简单socket服务器中介绍了怎么实现一个简单的C#广播服务器,在这上面扩展两个部分就能作为websocket服务器了

1.wecsocket握手处理

 当服务器收到浏览器握手请求后,首先需要识别握手信息,我简单粗暴的使用了包含字符串处理,当然加入了是否握过手的判断

复制代码
client.BeginReceive (buffer, 0, buffer.Length, SocketFlags.None, new AsyncCallback (Recieve), client);
                string msg = Encoding.UTF8.GetString (buffer, 0, length);

                if (!clientPool [client].IsHandShaked && msg.Contains ("Sec-WebSocket-Key")) {
                    client.Send (PackageHandShakeData (buffer, length));
                    clientPool [client].IsHandShaked = true;
                    return;
                }
复制代码

 

识别成功后就可以生成服务器响应发送给客户端了

复制代码
/// <summary>
        /// 打包服务器握手数据
        /// </summary>
        /// <returns>The hand shake data.</returns>
        /// <param name="handShakeBytes">Hand shake bytes.</param>
        /// <param name="length">Length.</param>
        private byte[] PackageHandShakeData (byte[] handShakeBytes, int length)
        {
            string handShakeText = Encoding.UTF8.GetString (handShakeBytes, 0, length);
            string key = string.Empty;
            Regex reg = new Regex (@"Sec\-WebSocket\-Key:(.*?)\r\n");
            Match m = reg.Match (handShakeText);
            if (m.Value != "") {
                key = Regex.Replace (m.Value, @"Sec\-WebSocket\-Key:(.*?)\r\n", "$1").Trim ();
            }

            byte[] secKeyBytes = SHA1.Create ().ComputeHash (
                                     Encoding.ASCII.GetBytes (key + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"));
            string secKey = Convert.ToBase64String (secKeyBytes);

            var responseBuilder = new StringBuilder ();
            responseBuilder.Append ("HTTP/1.1 101 Switching Protocols" + "\r\n");
            responseBuilder.Append ("Upgrade: websocket" + "\r\n");
            responseBuilder.Append ("Connection: Upgrade" + "\r\n");
            responseBuilder.Append ("Sec-WebSocket-Accept: " + secKey + "\r\n\r\n");

            return Encoding.UTF8.GetBytes (responseBuilder.ToString ());
        }
复制代码

 

 2.解析浏览器消息和处理发送给浏览器的消息

 websocket中数据并不完全是消息本身,我们需要做一些处理

解析客户端发送来的数据

 

把发送给客户端消息打包处理

 

如果看不懂我在写什么,并且对C#版websocket感兴趣的同学需要看一下我上一篇博客了

有图有真相

看看我们写的聊天室运行效果吧

 服务器

 

 客户端——Byron

 

客户端——Casper

 

源代码

 源代码我已经上传到了我的github上,对github不感冒的同学可以直接点击这里下载,有兴趣的同学可以下载看看,因为我在Mac+mono+Xamarin Studio上开发的(忽然感觉自己好极品在Mac上用C#。。。),所以代码编码和Windows可能会有些差距,改成Windows兼容的应该就可以直接运行了,不过没在Window下跑过,如果有错误还请大家多多指正。




    本文转自魏琼东博客园博客,原文链接:http://www.cnblogs.com/dolphinX/p/3462898.html,如需转载请自行联系原作者

网友评论

登录后评论
0/500
评论
橘子红了呐
+ 关注