WebSocket 是一种网络通信协议,很多高级功能都需要它。

  本文介绍 WebSocket 协议的使用方法。

最简单的WebSocket博一把白菜论坛手机教程

  一、为什么需要 WebSocket?

  初次接触 WebSocket 的人,都会问同样的问题:我们已经有了 HTTP 协议,为什么还需要另一个协议?它能带来什么好处?

  答案很简单,因为 HTTP 协议有一个缺陷:通信只能由客户端发起。

  举例来说,我们想了解今天的天气,只能是客户端向服务器发出请求,服务器返回查询结果。HTTP 协议做不到服务器主动向客户端推送信息。

最简单的WebSocket博一把白菜论坛手机教程

  这种单向请求的特点,注定了如果服务器有连续的状态变化,客户端要获知就非常麻烦。我们只能使用 "轮询" :每隔一段时候,就发出一个询问,了解服务器有没有新的信息。最典型的场景就是聊天室。

  轮询的效率低,非常浪费资源(因为必须不停连接,或者 HTTP 连接始终打开)。因此,工程师们一直在思考,有没有更好的方法。WebSocket 就是这样发明的。

  二、简介

  WebSocket 协议在2008年诞生,2011年成为国际标准。所有浏览器都已经支持了。

  它的最大特点就是,服务器可以主动向客户端推送信息,客户端也可以主动向服务器发送信息,是真正的双向平等对话,属于 服务器推送技术 的一种。

最简单的WebSocket博一把白菜论坛手机教程

  其他特点包括:

  (1)建立在 TCP 协议之上,服务器端的实现比较容易。

  (2)与 HTTP 协议有着良好的兼容性。默认端口也是80和443,并且握手阶段采用 HTTP 协议,因此握手时不容易屏蔽,能通过各种 HTTP 代理服务器。

  (3)数据格式比较轻量,性能开销小,通信高效。

  (4)可以发送文本,也可以发送二进制数据。

  (5)没有同源限制,客户端可以与任意服务器通信。

  (6)协议标识符是 ws (如果加密,则为 wss ),服务器网址就是 URL。

  ws://example.com:80/some/path

最简单的WebSocket博一把白菜论坛手机教程

  三、客户端的简单示例

  WebSocket 的用法相当简单。

  下面是一个网页脚本的例子(点击 这里 看运行结果),基本上一眼就能明白。

JavaScript代码
  1. var ws = new WebSocket("wss://echo.websocket.org");  
  2.   
  3. ws.onopen = function(evt) {   
  4.   console.log("Connection open ...");   
  5.   ws.send("Hello WebSockets!");  
  6. };  
  7.   
  8. ws.onmessage = function(evt) {  
  9.   console.log( "Received Message: " + evt.data);  
  10.   ws.close();  
  11. };  
  12.   
  13. ws.onclose = function(evt) {  
  14.   console.log("Connection closed.");  
  15. };        

  四、客户端的 API

  WebSocket 客户端的 API 如下。

  4.1 WebSocket 构造函数

  WebSocket 对象作为一个构造函数,用于新建 WebSocket 实例。

JavaScript代码
  1. var ws = new WebSocket('ws://localhost:8080');  

  执行上面语句之后,客户端就会与服务器进行连接。

  实例对象的所有属性和方法清单,参见 这里

  4.2 webSocket.readyState

  readyState 属性返回实例对象的当前状态,共有四种。

  CONNECTING:值为0,表示正在连接。

  OPEN:值为1,表示连接成功,可以通信了。

  CLOSING:值为2,表示连接正在关闭。

  CLOSED:值为3,表示连接已经关闭,或者打开连接失败。

  下面是一个示例。

JavaScript代码
  1. switch (ws.readyState) {  
  2.   case WebSocket.CONNECTING:  
  3.     // do something  
  4.     break;  
  5.   case WebSocket.OPEN:  
  6.     // do something  
  7.     break;  
  8.   case WebSocket.CLOSING:  
  9.     // do something  
  10.     break;  
  11.   case WebSocket.CLOSED:  
  12.     // do something  
  13.     break;  
  14.   default:  
  15.     // this never happens  
  16.     break;  
  17. }  

  4.3 webSocket.onopen

  实例对象的 onopen 属性,用于指定连接成功后的回调函数。

JavaScript代码
  1. ws.onopen = function () {  
  2.   ws.send('Hello Server!');  
  3. }  

  如果要指定多个回调函数,可以使用 addEventListener 方法。

JavaScript代码
  1. ws.addEventListener('open'function (event) {  
  2.   ws.send('Hello Server!');  
  3. });  

  4.4 webSocket.onclose

  实例对象的 onclose 属性,用于指定连接关闭后的回调函数。

JavaScript代码
  1. ws.onclose = function(event) {  
  2.   var code = event.code;  
  3.   var reason = event.reason;  
  4.   var wasClean = event.wasClean;  
  5.   // handle close event  
  6. };  
  7.   
  8. ws.addEventListener("close"function(event) {  
  9.   var code = event.code;  
  10.   var reason = event.reason;  
  11.   var wasClean = event.wasClean;  
  12.   // handle close event  
  13. });  

  4.5 webSocket.onmessage

  实例对象的 onmessage 属性,用于指定收到服务器数据后的回调函数。

JavaScript代码
  1. ws.onmessage = function(event) {  
  2.   var data = event.data;  
  3.   // 处理数据  
  4. };  
  5.   
  6. ws.addEventListener("message"function(event) {  
  7.   var data = event.data;  
  8.   // 处理数据  
  9. });  

  注意,服务器数据可能是文本,也可能是二进制数据( blob 对象或 Arraybuffer 对象)。

JavaScript代码
  1. ws.onmessage = function(event){  
  2.   if(typeof event.data === String) {  
  3.     console.log("Received data string");  
  4.   }  
  5.   
  6.   if(event.data instanceof ArrayBuffer){  
  7.     var buffer = event.data;  
  8.     console.log("Received arraybuffer");  
  9.   }  
  10. }  

  除了动态判断收到的数据类型,也可以使用 binaryType 属性,显式指定收到的二进制数据类型。

JavaScript代码
  1. // 收到的是 blob 数据  
  2. ws.binaryType = "blob";  
  3. ws.onmessage = function(e) {  
  4.   console.log(e.data.size);  
  5. };  
  6.   
  7. // 收到的是 ArrayBuffer 数据  
  8. ws.binaryType = "arraybuffer";  
  9. ws.onmessage = function(e) {  
  10.   console.log(e.data.byteLength);  
  11. };  

  4.6 webSocket.send()

  实例对象的 send() 方法用于向服务器发送数据。

  发送文本的例子。

JavaScript代码
  1. ws.send('your message');  

  发送 Blob 对象的例子。

JavaScript代码
  1. var file = document  
  2.   .querySelector('input[type="file"]')  
  3.   .files[0];  
  4. ws.send(file);  

  发送 ArrayBuffer 对象的例子。

JavaScript代码
  1. // Sending canvas ImageData as ArrayBuffer  
  2. var img = canvas_context.getImageData(0, 0, 400, 320);  
  3. var binary = new Uint8Array(img.data.length);  
  4. for (var i = 0; i < img.data.length; i++) {  
  5.   binary[i] = img.data[i];  
  6. }  
  7. ws.send(binary.buffer);  

  4.7 webSocket.bufferedAmount

  实例对象的 bufferedAmount 属性,表示还有多少字节的二进制数据没有发送出去。它可以用来判断发送是否结束。

JavaScript代码
  1. var data = new ArrayBuffer(10000000);  
  2. socket.send(data);  
  3.   
  4. if (socket.bufferedAmount === 0) {  
  5.   // 发送完毕  
  6. else {  
  7.   // 发送还没结束  
  8. }  

  4.8 webSocket.onerror

  实例对象的 onerror 属性,用于指定报错时的回调函数。

JavaScript代码
  1. socket.onerror = function(event) {  
  2.   // handle error event  
  3. };  
  4.   
  5. socket.addEventListener("error"function(event) {  
  6.   // handle error event  
  7. });  

  五、服务端的实现

  WebSocket 服务器的实现,可以查看维基百科的 列表

  常用的 Node 实现有以下三种。

  μWebSockets

  Socket.IO

  WebSocket-Node

  具体的用法请查看它们的文档,这里不详细介绍了。

  六、WebSocketd

  下面,我要推荐一款非常特别的 WebSocket 服务器: Websocketd

  它的最大特点,就是后台脚本不限语言,标准输入(stdin)就是 WebSocket 的输入,标准输出(stdout)就是 WebSocket 的输出。

最简单的WebSocket博一把白菜论坛手机教程

  举例来说,下面是一个 Bash 脚本 counter.sh 。

  #!/bin/bash

  echo 1

  sleep 1

  echo 2

  sleep 1

  echo 3

  命令行下运行这个脚本,会输出1、2、3,每个值之间间隔1秒。

  $ bash ./counter.sh

  现在,启动 websocketd ,指定这个脚本作为服务。

  $ websocketd --port=8080 bash ./counter.sh

  上面的命令会启动一个 WebSocket 服务器,端口是 8080 。每当客户端连接这个服务器,就会执行 counter.sh 脚本,并将它的输出推送给客户端。

JavaScript代码
  1. var ws = new WebSocket('ws://localhost:8080/');  
  2.   
  3. ws.onmessage = function(event) {  
  4.   console.log(event.data);  
  5. };  

  上面是客户端的 JavaScript 代码,运行之后会在控制台依次输出1、2、3。

  有了它,就可以很方便地将命令行的输出,发给浏览器。

  $ websocketd --port=8080 ls

  上面的命令会执行 ls 命令,从而将当前目录的内容,发给浏览器。使用这种方式实时监控服务器,简直是轻而易举( 代码 )。

最简单的WebSocket博一把白菜论坛手机教程

  更多的用法可以参考 官方示例

  Bash 脚本 读取客户端输入 的例子

  五行代码实现一个最简单的 聊天服务器

最简单的WebSocket博一把白菜论坛手机教程

  websocketd 的实质,就是命令行的 WebSocket 代理。只要命令行可以执行的程序,都可以通过它与浏览器进行 WebSocket 通信。下面是一个 Node 实现的回声服务 greeter.js 。

JavaScript代码
  1. process.stdin.setEncoding('utf8');  
  2.   
  3. process.stdin.on('readable'function() {  
  4.   var chunk = process.stdin.read();  
  5.   if (chunk !== null) {  
  6.     process.stdout.write('data: ' + chunk);  
  7.   }  
  8. });  

  启动这个脚本的命令如下。

  $ websocketd --port=8080 node ./greeter.js

  官方仓库还有其他 各种语言 的例子。

转自:阮一峰的网络日志

除非特别注明,鸡啄米文章均为原创
转载请标明本文地址:http://www.teaching4real.com/software/745.html
2017年7月19日
作者:鸡啄米 分类:软件开发 浏览: 注册送白菜网:0