作者： 阮一峰
WebSocket 是一種網(wǎng)絡(luò)通信協(xié)議侣滩，很多高級功能都需要它口注。
本文介紹 WebSocket 協(xié)議的使用方法。
一君珠、為什么需要 WebSocket寝志？
初次接觸 WebSocket 的人，都會問同樣的問題：我們已經(jīng)有了 HTTP 協(xié)議，為什么還需要另一個(gè)協(xié)議材部？它能帶來什么好處毫缆？
答案很簡單，因?yàn)?HTTP 協(xié)議有一個(gè)缺陷：通信只能由客戶端發(fā)起乐导。
舉例來說苦丁，我們想了解今天的天氣，只能是客戶端向服務(wù)器發(fā)出請求物臂，服務(wù)器返回查詢結(jié)果旺拉。HTTP 協(xié)議做不到服務(wù)器主動向客戶端推送信息。
這種單向請求的特點(diǎn)棵磷，注定了如果服務(wù)器有連續(xù)的狀態(tài)變化蛾狗，客戶端要獲知就非常麻煩。我們只能使用"輪詢"：每隔一段時(shí)候泽本，就發(fā)出一個(gè)詢問淘太，了解服務(wù)器有沒有新的信息。最典型的場景就是聊天室规丽。
輪詢的效率低蒲牧，非常浪費(fèi)資源（因?yàn)楸仨毑煌＿B接，或者 HTTP 連接始終打開）赌莺。因此冰抢，工程師們一直在思考，有沒有更好的方法艘狭。WebSocket 就是這樣發(fā)明的挎扰。
二、簡介
WebSocket 協(xié)議在2008年誕生巢音，2011年成為國際標(biāo)準(zhǔn)遵倦。所有瀏覽器都已經(jīng)支持了。
它的最大特點(diǎn)就是官撼，服務(wù)器可以主動向客戶端推送信息梧躺，客戶端也可以主動向服務(wù)器發(fā)送信息，是真正的雙向平等對話傲绣，屬于服務(wù)器推送技術(shù)的一種掠哥。
其他特點(diǎn)包括：
（1）建立在 TCP 協(xié)議之上，服務(wù)器端的實(shí)現(xiàn)比較容易秃诵。
（2）與 HTTP 協(xié)議有著良好的兼容性续搀。默認(rèn)端口也是80和443，并且握手階段采用 HTTP 協(xié)議菠净，因此握手時(shí)不容易屏蔽禁舷，能通過各種 HTTP 代理服務(wù)器彪杉。
（3）數(shù)據(jù)格式比較輕量，性能開銷小榛了，通信高效在讶。
（4）可以發(fā)送文本，也可以發(fā)送二進(jìn)制數(shù)據(jù)霜大。
（5）沒有同源限制构哺，客戶端可以與任意服務(wù)器通信。
（6）協(xié)議標(biāo)識符是ws（如果加密战坤，則為wss）曙强，服務(wù)器網(wǎng)址就是 URL。
ws://example.com:80/some/path
三途茫、客戶端的簡單示例
WebSocket 的用法相當(dāng)簡單碟嘴。
下面是一個(gè)網(wǎng)頁腳本的例子（點(diǎn)擊這里看運(yùn)行結(jié)果），基本上一眼就能明白囊卜。
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."); };
四娜扇、客戶端的 API
WebSocket 客戶端的 API 如下。
4.1 WebSocket 構(gòu)造函數(shù)
WebSocket 對象作為一個(gè)構(gòu)造函數(shù)栅组，用于新建 WebSocket 實(shí)例雀瓢。
var ws = new WebSocket('ws://localhost:8080');
執(zhí)行上面語句之后，客戶端就會與服務(wù)器進(jìn)行連接玉掸。
實(shí)例對象的所有屬性和方法清單刃麸，參見這里。
4.2 webSocket.readyState
readyState屬性返回實(shí)例對象的當(dāng)前狀態(tài)司浪，共有四種泊业。
- CONNECTING：值為0，表示正在連接啊易。
- OPEN：值為1吁伺，表示連接成功，可以通信了租谈。
- CLOSING：值為2箱蝠，表示連接正在關(guān)閉。
- CLOSED：值為3垦垂，表示連接已經(jīng)關(guān)閉，或者打開連接失敗牙瓢。
下面是一個(gè)示例劫拗。
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; }
4.3 webSocket.onopen
實(shí)例對象的onopen屬性，用于指定連接成功后的回調(diào)函數(shù)矾克。
ws.onopen = function () { ws.send('Hello Server!'); }
如果要指定多個(gè)回調(diào)函數(shù)页慷，可以使用addEventListener方法。
ws.addEventListener('open', function (event) { ws.send('Hello Server!'); });
4.4 webSocket.onclose
實(shí)例對象的onclose屬性，用于指定連接關(guān)閉后的回調(diào)函數(shù)酒繁。
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 });
4.5 webSocket.onmessage
實(shí)例對象的onmessage屬性滓彰，用于指定收到服務(wù)器數(shù)據(jù)后的回調(diào)函數(shù)。
ws.onmessage = function(event) { var data = event.data; // 處理數(shù)據(jù) }; ws.addEventListener("message", function(event) { var data = event.data; // 處理數(shù)據(jù) });
注意州袒，服務(wù)器數(shù)據(jù)可能是文本揭绑，也可能是二進(jìn)制數(shù)據(jù)（blob對象或Arraybuffer對象）。
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"); } }
除了動態(tài)判斷收到的數(shù)據(jù)類型郎哭，也可以使用binaryType屬性他匪，顯式指定收到的二進(jìn)制數(shù)據(jù)類型。
// 收到的是 blob 數(shù)據(jù) ws.binaryType = "blob"; ws.onmessage = function(e) { console.log(e.data.size); }; // 收到的是 ArrayBuffer 數(shù)據(jù) ws.binaryType = "arraybuffer"; ws.onmessage = function(e) { console.log(e.data.byteLength); };
4.6 webSocket.send()
實(shí)例對象的send()方法用于向服務(wù)器發(fā)送數(shù)據(jù)夸研。
發(fā)送文本的例子邦蜜。
ws.send('your message');
發(fā)送 Blob 對象的例子。
var file = document .querySelector('input[type="file"]') .files[0]; ws.send(file);
發(fā)送 ArrayBuffer 對象的例子亥至。
// 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);
4.7 webSocket.bufferedAmount
實(shí)例對象的bufferedAmount屬性悼沈，表示還有多少字節(jié)的二進(jìn)制數(shù)據(jù)沒有發(fā)送出去。它可以用來判斷發(fā)送是否結(jié)束姐扮。
var data = new ArrayBuffer(10000000); socket.send(data); if (socket.bufferedAmount === 0) { // 發(fā)送完畢 } else { // 發(fā)送還沒結(jié)束 }
4.8 webSocket.onerror
實(shí)例對象的onerror屬性絮供，用于指定報(bào)錯(cuò)時(shí)的回調(diào)函數(shù)。
socket.onerror = function(event) { // handle error event }; socket.addEventListener("error", function(event) { // handle error event });
五溶握、服務(wù)端的實(shí)現(xiàn)
WebSocket 服務(wù)器的實(shí)現(xiàn)杯缺，可以查看維基百科的列表。
常用的 Node 實(shí)現(xiàn)有以下三種睡榆。
具體的用法請查看它們的文檔萍肆，這里不詳細(xì)介紹了。
六胀屿、WebSocketd
下面塘揣，我要推薦一款非常特別的 WebSocket 服務(wù)器：Websocketd。
它的最大特點(diǎn)宿崭，就是后臺腳本不限語言亲铡，標(biāo)準(zhǔn)輸入（stdin）就是 WebSocket 的輸入，標(biāo)準(zhǔn)輸出（stdout）就是 WebSocket 的輸出葡兑。
舉例來說奖蔓，下面是一個(gè) Bash 腳本counter.sh。
#!/bin/bash echo 1 sleep 1 echo 2 sleep 1 echo 3
命令行下運(yùn)行這個(gè)腳本讹堤，會輸出1吆鹤、2、3洲守，每個(gè)值之間間隔1秒疑务。
$ bash ./counter.sh 1 2 3
現(xiàn)在沾凄，啟動websocketd，指定這個(gè)腳本作為服務(wù)知允。
$ websocketd --port=8080 bash ./counter.sh
上面的命令會啟動一個(gè) WebSocket 服務(wù)器撒蟀，端口是8080。每當(dāng)客戶端連接這個(gè)服務(wù)器温鸽，就會執(zhí)行counter.sh腳本保屯，并將它的輸出推送給客戶端。
var ws = new WebSocket('ws://localhost:8080/'); ws.onmessage = function(event) { console.log(event.data); };
上面是客戶端的 JavaScript 代碼嗤朴，運(yùn)行之后會在控制臺依次輸出1配椭、2、3雹姊。
有了它股缸，就可以很方便地將命令行的輸出，發(fā)給瀏覽器吱雏。
$ websocketd --port=8080 ls
上面的命令會執(zhí)行ls命令敦姻，從而將當(dāng)前目錄的內(nèi)容，發(fā)給瀏覽器歧杏。使用這種方式實(shí)時(shí)監(jiān)控服務(wù)器镰惦，簡直是輕而易舉（代碼）。
更多的用法可以參考官方示例犬绒。
websocketd 的實(shí)質(zhì)旺入，就是命令行的 WebSocket 代理。只要命令行可以執(zhí)行的程序凯力，都可以通過它與瀏覽器進(jìn)行 WebSocket 通信茵瘾。下面是一個(gè) Node 實(shí)現(xiàn)的回聲服務(wù)greeter.js。
process.stdin.setEncoding('utf8'); process.stdin.on('readable', function() { var chunk = process.stdin.read(); if (chunk !== null) { process.stdout.write('data: ' + chunk); } });
啟動這個(gè)腳本的命令如下咐鹤。
$ websocketd --port=8080 node ./greeter.js
官方倉庫還有其他各種語言的例子拗秘。
