WebSocket 教程
on1024
8年前
<p><a href="/misc/goto?guid=4958348492202997634" rel="nofollow,noindex">WebSocket</a> 是一种网络通信协议，很多高级功能都需要它。</p> <p>本文介绍 WebSocket 协议的使用方法。</p> <p><img src="https://simg.open-open.com/show/6b8940e4560392303d9afe7734f2ad3a.png"></p> <h2>一、为什么需要 WebSocket？</h2> <p>初次接触 WebSocket 的人，都会问同样的问题：我们已经有了 HTTP 协议，为什么还需要另一个协议？它能带来什么好处？</p> <p>答案很简单，因为 HTTP 协议有一个缺陷：通信只能由客户端发起。</p> <p>举例来说，我们想了解今天的天气，只能是客户端向服务器发出请求，服务器返回查询结果。HTTP 协议做不到服务器主动向客户端推送信息。</p> <p><img src="https://simg.open-open.com/show/4a213c0209b95a990ceb021b76fff18a.jpg"></p> <p>这种单向请求的特点，注定了如果服务器有连续的状态变化，客户端要获知就非常麻烦。我们只能使用 <a href="/misc/goto?guid=4959748757932907205" rel="nofollow,noindex">"轮询"</a> ：每隔一段时候，就发出一个询问，了解服务器有没有新的信息。最典型的场景就是聊天室。</p> <p>轮询的效率低，非常浪费资源（因为必须不停连接，或者 HTTP 连接始终打开）。因此，工程师们一直在思考，有没有更好的方法。WebSocket 就是这样发明的。</p> <h2>二、简介</h2> <p>WebSocket 协议在2008年诞生，2011年成为国际标准。所有浏览器都已经支持了。</p> <p>它的最大特点就是，服务器可以主动向客户端推送信息，客户端也可以主动向服务器发送信息，是真正的双向平等对话，属于 <a href="/misc/goto?guid=4959748758013325642" rel="nofollow,noindex">服务器推送技术</a> 的一种。</p> <p><img src="https://simg.open-open.com/show/01881d8f5cd4dc6d8650a6b9f173cb49.png"></p> <p>其他特点包括：</p> <p>（1）建立在 TCP 协议之上，服务器端的实现比较容易。</p> <p>（2）与 HTTP 协议有着良好的兼容性。默认端口也是80和443，并且握手阶段采用 HTTP 协议，因此不容易屏蔽，能通过各种 HTTP 代理服务器。</p> <p>（3）数据格式比较轻量，性能开销小，通信高效。</p> <p>（4）可以发送文本，也可以发送二进制数据。</p> <p>（5）没有同源限制，客户端可以与任意服务器通信。</p> <p>（6）协议标识符是 ws （如果加密，则为 wss ），服务器网址就是 URL。</p> <pre> <code class="language-java">ws://example.com:80/some/path</code></pre> <p><img src="https://simg.open-open.com/show/49345da67692d6013e53851c0301dc33.jpg"></p> <h2>三、客户端的简单示例</h2> <p>WebSocket 的用法相当简单。</p> <p>下面是一个网页脚本的例子（点击 <a href="/misc/goto?guid=4959748758102758423" rel="nofollow,noindex">这里</a> 看运行结果），基本上一眼就能明白。</p> <pre> <code class="language-java">var ws = new WebSocket("wss://echo.websocket.org"); ws.onopen = function(evt) { console.log("Connection open ..."); ws.send("Hello WebSockets!"); }; ws.onmessage = function(evt) { console.log( "Received Message: " + evt.data); ws.close(); }; ws.onclose = function(evt) { console.log("Connection closed."); };</code></pre> <h2>四、客户端的 API</h2> <p>WebSocket 客户端的 API 如下。</p> <h3>4.1 WebSocket 构造函数</h3> <p>WebSocket 对象作为一个构造函数，用于新建 WebSocket 实例。</p> <pre> <code class="language-java">var ws = new WebSocket('ws://localhost:8080');</code></pre> <p>执行上面语句之后，客户端就会与服务器进行连接。</p> <p>实例对象的所有属性和方法清单，参见 <a href="/misc/goto?guid=4959633287826285467" rel="nofollow,noindex">这里</a> 。</p> <h3>4.2 webSocket.readyState</h3> <p>readyState 属性返回实例对象的当前状态，共有四种。</p> <ul> <li>CONNECTING：值为0，表示正在连接。</li> <li>OPEN：值为1，表示连接成功，可以通信了。</li> <li>CLOSING：值为2，表示连接正在关闭。</li> <li>CLOSED：值为3，表示连接已经关闭，或者打开连接失败。</li> </ul> <p>下面是一个示例。</p> <pre> <code class="language-java">switch (ws.readyState) { case WebSocket.CONNECTING: // do something break; case WebSocket.OPEN: // do something break; case WebSocket.CLOSING: // do something break; case WebSocket.CLOSED: // do something break; default: // this never happens break; }</code></pre> <h3>4.3 webSocket.onopen</h3> <p>实例对象的 onopen 属性，用于指定连接成功后的回调函数。</p> <pre> <code class="language-java">ws.onopen = function () { ws.send('Hello Server!'); }</code></pre> <p>如果要指定多个回调函数，可以使用addEventListener`方法。</p> <pre> <code class="language-java">ws.addEventListener('open', function (event) { ws.send('Hello Server!'); });</code></pre> <h3>4.4 webSocket.onclose</h3> <p>实例对象的 onclose 属性，用于指定连接关闭后的回调函数。</p> <pre> <code class="language-java">ws.onclose = function(event) { var code = event.code; var reason = event.reason; var wasClean = event.wasClean; // handle close event }; ws.addEventListener("close", function(event) { var code = event.code; var reason = event.reason; var wasClean = event.wasClean; // handle close event });</code></pre> <h3>4.5 webSocket.onmessage</h3> <p>实例对象的 onmessage 属性，用于指定收到服务器数据后的回调函数。</p> <pre> <code class="language-java">ws.onmessage = function(event) { var data = event.data; // 处理数据 }; ws.addEventListener("message", function(event) { var data = event.data; // 处理数据 });</code></pre> <p>注意，服务器数据可能是文本，也可能是二进制数据（ blob 对象或 Arraybuffer 对象）。</p> <pre> <code class="language-java">ws.onmessage = function(event){ if(typeOf event.data === String) { console.log("Received data string"); } if(event.data instanceof ArrayBuffer){ var buffer = event.data; console.log("Received arraybuffer"); } }</code></pre> <p>除了动态判断收到的数据类型，也可以使用 binaryType 属性，显式指定收到的二进制数据类型。</p> <pre> <code class="language-java">// 收到的是 blob 数据 ws.binaryType = "blob"; ws.onmessage = function(e) { console.log(e.data.size); }; // 收到的是 ArrayBuffer 数据 ws.binaryType = "arraybuffer"; ws.onmessage = function(e) { console.log(e.data.byteLength); };</code></pre> <h3>4.6 webSocket.send()</h3> <p>实例对象的 send() 方法用于向服务器发送数据。</p> <p>发送文本的例子。</p> <pre> <code class="language-java">ws.send('your message');</code></pre> <p>发送 Blob 对象的例子。</p> <pre> <code class="language-java">var file = document .querySelector('input[type="file"]') .files[0]; ws.send(file);</code></pre> <p>发送 ArrayBuffer 对象的例子。</p> <pre> <code class="language-java">// Sending canvas ImageData as ArrayBuffer var img = canvas_context.getImageData(0, 0, 400, 320); var binary = new Uint8Array(img.data.length); for (var i = 0; i < img.data.length; i++) { binary[i] = img.data[i]; } ws.send(binary.buffer);</code></pre> <h3>4.7 webSocket.bufferedAmount</h3> <p>实例对象的 bufferedAmount 属性，表示还有多少字节的二进制数据没有发送出去。它可以用来判断发送是否结束。</p> <pre> <code class="language-java">var data = new ArrayBuffer(10000000); socket.send(data); if (socket.bufferedAmount === 0) { // 发送完毕 } else { // 发送还没结束 }</code></pre> <h3>4.8 webSocket.onerror</h3> <p>实例对象的 onerror 属性，用于指定报错时的回调函数。</p> <pre> <code class="language-java">socket.onerror = function(event) { // handle error event }; socket.addEventListener("error", function(event) { // handle error event });</code></pre> <h2>五、服务端的实现</h2> <p>WebSocket 服务器的实现，可以查看维基百科的 <a href="/misc/goto?guid=4959748758210382007" rel="nofollow,noindex">列表</a> 。</p> <p>常用的 Node 实现有以下三种。</p> <ul> <li><a href="/misc/goto?guid=4959748758291514701" rel="nofollow,noindex">µWebSockets</a></li> <li><a href="/misc/goto?guid=4958331662353341543" rel="nofollow,noindex">Socket.IO</a></li> <li><a href="/misc/goto?guid=4959748758398234337" rel="nofollow,noindex">WebSocket-Node</a></li> </ul> <p>具体的用法请查看它们的文档，这里不详细介绍了。</p> <h2>六、WebSocketd</h2> <p>下面，我要推荐一款非常特别的 WebSocket 服务器： <a href="/misc/goto?guid=4959748758485759755" rel="nofollow,noindex">Websocketd</a> 。</p> <p>它的最大特点，就是后台脚本不限语言，标准输入（stdin）就是 WebSocket 的输入，标准输出（stdout）就是 WebSocket 的输出。</p> <p><img src="https://simg.open-open.com/show/ead473cf48a85187dd089b055b810653.png"></p> <p>举例来说，下面是一个 Bash 脚本 counter.sh 。</p> <pre> <code class="language-java">#!/bin/bash echo 1 sleep 1 echo 2 sleep 1 echo 3</code></pre> <p>命令行下运行这个脚本，会输出1、2、3，每个值之间间隔1秒。</p> <pre> <code class="language-java">$ bash ./counter.sh 1 2 3</code></pre> <p>现在，启动 websocketd ，指定这个脚本作为服务。</p> <pre> <code class="language-java">$ websocketd --port=8080 bash ./counter.sh</code></pre> <p>上面的命令会启动一个 WebSocket 服务器，端口是 8080 。每当客户端连接这个服务器，就会执行 counter.sh 脚本，并将它的输出推送给客户端。</p> <pre> <code class="language-java">var ws = new WebSocket('ws://localhost:8080/'); ws.onmessage = function(event) { console.log(event.data); };</code></pre> <p>上面是客户端的 JavaScript 代码，运行之后会在控制台依次输出1、2、3。</p> <p>有了它，就可以很方便地将命令行的输出，发给浏览器。</p> <pre> <code class="language-java">$ websocketd --port=8080 ls</code></pre> <p>上面的命令会执行 ls 命令，从而将当前目录的内容，发给浏览器。使用这种方式实时监控服务器，简直是轻而易举（ <a href="/misc/goto?guid=4959748758579726981" rel="nofollow,noindex">代码</a> ）。</p> <p><img src="https://simg.open-open.com/show/9ba9d5f40d586d6af0dd1099251ae40e.jpg"></p> <p>更多的用法可以参考 <a href="/misc/goto?guid=4959748758658884843" rel="nofollow,noindex">官方示例</a> 。</p> <ul> <li>Bash 脚本 <a href="/misc/goto?guid=4959748758744371060" rel="nofollow,noindex">读取客户端输入</a> 的例子</li> <li>五行代码实现一个最简单的 <a href="/misc/goto?guid=4959748758828441675" rel="nofollow,noindex">聊天服务器</a></li> </ul> <p><img src="https://simg.open-open.com/show/f5cff00f34f9e9006bcf97458acbfab1.png"></p> <p>websocketd 的实质，就是命令行的 WebSocket 代理。只要命令行可以执行的程序，都可以通过它与浏览器进行 WebSocket 通信。下面是一个 Node 实现的回声服务 <a href="/misc/goto?guid=4959748758910738011" rel="nofollow,noindex"> greeter.js </a> 。</p> <pre> <code class="language-java">process.stdin.setEncoding('utf8'); process.stdin.on('readable', function() { var chunk = process.stdin.read(); if (chunk !== null) { process.stdout.write('data: ' + chunk); } });</code></pre> <p>启动这个脚本的命令如下。</p> <pre> <code class="language-java">$ websocketd --port=8080 node ./greeter.js</code></pre> <p>官方仓库还有其他 <a href="/misc/goto?guid=4959554490461131734" rel="nofollow,noindex">各种语言</a> 的例子。</p> <h2>七、参考链接</h2> <ul> <li><a href="/misc/goto?guid=4959748759019885287" rel="nofollow,noindex">How to Use WebSockets</a></li> <li><a href="/misc/goto?guid=4959748759103991602" rel="nofollow,noindex">WebSockets - Send & Receive Messages</a></li> <li><a href="/misc/goto?guid=4959748759188652020" rel="nofollow,noindex">Introducing WebSockets: Bringing Sockets to the Web</a></li> </ul> <p>（完）</p> <p> </p> <p>来自：http://www.ruanyifeng.com/blog/2017/05/websocket.html</p> <p> </p>