轉(zhuǎn)載自WebSocket,侵刪
WebSocket 教程
作者： 阮一峰
WebSocket 是一種網(wǎng)絡(luò)通信協(xié)議鳍鸵，很多高級功能都需要它。
本文介紹 WebSocket 協(xié)議的使用方法裕菠。
一、為什么需要 WebSocket堤结？
初次接觸 WebSocket 的人养涮，都會問同樣的問題：我們已經(jīng)有了 HTTP 協(xié)議，為什么還需要另一個協(xié)議罐监？它能帶來什么好處泽腮？
答案很簡單喇聊，因為 HTTP 協(xié)議有一個缺陷：通信只能由客戶端發(fā)起瘾带。
舉例來說悄谐，我們想了解今天的天氣，只能是客戶端向服務(wù)器發(fā)出請求矢空，服務(wù)器返回查詢結(jié)果航罗。HTTP 協(xié)議做不到服務(wù)器主動向客戶端推送信息。
這種單向請求的特點妇多，注定了如果服務(wù)器有連續(xù)的狀態(tài)變化伤哺，客戶端要獲知就非常麻煩。我們只能使用"輪詢"：每隔一段時候者祖，就發(fā)出一個詢問，了解服務(wù)器有沒有新的信息绢彤。最典型的場景就是聊天室七问。
輪詢的效率低，非常浪費資源（因為必須不停連接茫舶，或者 HTTP 連接始終打開）械巡。因此，工程師們一直在思考饶氏，有沒有更好的方法讥耗。WebSocket 就是這樣發(fā)明的。
二疹启、簡介
WebSocket 協(xié)議在2008年誕生古程，2011年成為國際標準。所有瀏覽器都已經(jīng)支持了喊崖。
它的最大特點就是挣磨，服務(wù)器可以主動向客戶端推送信息，客戶端也可以主動向服務(wù)器發(fā)送信息荤懂，是真正的雙向平等對話茁裙，屬于服務(wù)器推送技術(shù)的一種。
其他特點包括：
（1）建立在 TCP 協(xié)議之上节仿，服務(wù)器端的實現(xiàn)比較容易晤锥。
（2）與 HTTP 協(xié)議有著良好的兼容性。默認端口也是80和443廊宪，并且握手階段采用 HTTP 協(xié)議矾瘾，因此握手時不容易屏蔽女轿，能通過各種 HTTP 代理服務(wù)器。
（3）數(shù)據(jù)格式比較輕量霜威，性能開銷小谈喳，通信高效。
（4）可以發(fā)送文本戈泼，也可以發(fā)送二進制數(shù)據(jù)婿禽。
（5）沒有同源限制，客戶端可以與任意服務(wù)器通信大猛。
（6）協(xié)議標識符是ws（如果加密扭倾，則為wss），服務(wù)器網(wǎng)址就是 URL挽绩。
ws://example.com:80/some/path
三膛壹、客戶端的簡單示例
WebSocket 的用法相當(dāng)簡單。
下面是一個網(wǎng)頁腳本的例子（點擊這里看運行結(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òu)造函數(shù)链方，用于新建 WebSocket 實例。
var ws = new WebSocket('ws://localhost:8080');
執(zhí)行上面語句之后灶搜，客戶端就會與服務(wù)器進行連接祟蚀。
實例對象的所有屬性和方法清單，參見這里割卖。
4.2 webSocket.readyState
readyState屬性返回實例對象的當(dāng)前狀態(tài)前酿，共有四種。
- CONNECTING：值為0鹏溯，表示正在連接罢维。
- OPEN：值為1，表示連接成功剿涮，可以通信了言津。
- CLOSING：值為2，表示連接正在關(guān)閉取试。
- CLOSED：值為3悬槽，表示連接已經(jīng)關(guān)閉，或者打開連接失敗瞬浓。
下面是一個示例初婆。
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
實例對象的onopen屬性，用于指定連接成功后的回調(diào)函數(shù)。
ws.onopen = function () { ws.send('Hello Server!'); }
如果要指定多個回調(diào)函數(shù)磅叛，可以使用addEventListener方法屑咳。
ws.addEventListener('open', function (event) { ws.send('Hello Server!'); });
4.4 webSocket.onclose
實例對象的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
實例對象的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ù)可能是文本紫皇，也可能是二進制數(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屬性聪铺，顯式指定收到的二進制數(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()
實例對象的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
實例對象的bufferedAmount屬性键兜，表示還有多少字節(jié)的二進制數(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
實例對象的onerror屬性蝶押，用于指定報錯時的回調(diào)函數(shù)。
socket.onerror = function(event) { // handle error event }; socket.addEventListener("error", function(event) { // handle error event });
五火欧、服務(wù)端的實現(xiàn)
WebSocket 服務(wù)器的實現(xiàn)，可以查看維基百科的列表茎截。
常用的 Node 實現(xiàn)有以下三種苇侵。
具體的用法請查看它們的文檔，這里不詳細介紹了企锌。
六榆浓、WebSocketd
下面，我要推薦一款非常特別的 WebSocket 服務(wù)器：Websocketd撕攒。
它的最大特點陡鹃，就是后臺腳本不限語言，標準輸入（stdin）就是 WebSocket 的輸入抖坪，標準輸出（stdout）就是 WebSocket 的輸出萍鲸。
舉例來說，下面是一個 Bash 腳本counter.sh擦俐。
#!/bin/bash echo 1 sleep 1 echo 2 sleep 1 echo 3
命令行下運行這個腳本脊阴，會輸出1、2、3嘿期，每個值之間間隔1秒品擎。
$ bash ./counter.sh 1 2 3
現(xiàn)在，啟動websocketd备徐，指定這個腳本作為服務(wù)萄传。
$ websocketd --port=8080 bash ./counter.sh
上面的命令會啟動一個 WebSocket 服務(wù)器，端口是8080蜜猾。每當(dāng)客戶端連接這個服務(wù)器秀菱，就會執(zhí)行counter.sh腳本，并將它的輸出推送給客戶端瓣铣。
var ws = new WebSocket('ws://localhost:8080/'); ws.onmessage = function(event) { console.log(event.data); };
上面是客戶端的 JavaScript 代碼答朋，運行之后會在控制臺依次輸出1、2棠笑、3梦碗。
有了它，就可以很方便地將命令行的輸出蓖救，發(fā)給瀏覽器洪规。
$ websocketd --port=8080 ls
上面的命令會執(zhí)行ls命令，從而將當(dāng)前目錄的內(nèi)容循捺，發(fā)給瀏覽器斩例。使用這種方式實時監(jiān)控服務(wù)器，簡直是輕而易舉（代碼）从橘。
更多的用法可以參考官方示例念赶。
websocketd 的實質(zhì)，就是命令行的 WebSocket 代理恰力。只要命令行可以執(zhí)行的程序叉谜，都可以通過它與瀏覽器進行 WebSocket 通信。下面是一個 Node 實現(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); } });
啟動這個腳本的命令如下停局。
$ websocketd --port=8080 node ./greeter.js
官方倉庫還有其他各種語言的例子。
七香府、參考鏈接
- How to Use WebSockets
- WebSockets - Send & Receive Messages
- Introducing WebSockets: Bringing Sockets to the Web
（完）
