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 的用法相當簡單门怪。
下面是一個網(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
屬性返回實例對象的當前狀態(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
矢劲。每當客戶端連接這個服務(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
命令,從而將當前目錄的內(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
(完)