本文介紹 WebSocket 協(xié)議的使用方法。
一、為什么需要 WebSocket?
初次接觸 WebSocket 的人,都會(huì)問同樣的問題:我們已經(jīng)有了 HTTP 協(xié)議,為什么還需要另一個(gè)協(xié)議?它能帶來什么好處?
答案很簡單,因?yàn)?HTTP 協(xié)議有一個(gè)缺陷:通信只能由客戶端發(fā)起。
舉例來說,我們想了解今天的天氣,只能是客戶端向服務(wù)器發(fā)出請(qǐng)求,服務(wù)器返回查詢結(jié)果。HTTP 協(xié)議做不到服務(wù)器主動(dòng)向客戶端推送信息。
這種單向請(qǐng)求的特點(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ù)器可以主動(dòng)向客戶端推送信息,客戶端也可以主動(dòng)向服務(wù)器發(fā)送信息,是真正的雙向平等對(duì)話,屬于服務(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)識(shí)符是ws(如果加密,則為wss),服務(wù)器網(wǎng)址就是 URL。
ws://example.com:80/some/path
三、客戶端的簡單示例
WebSocket 的用法相當(dāng)簡單。
下面是一個(gè)網(wǎng)頁腳本的例子(點(diǎn)擊這里看運(yùn)行結(jié)果),基本上一眼就能明白。
varws=newWebSocket("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 對(duì)象作為一個(gè)構(gòu)造函數(shù),用于新建 WebSocket 實(shí)例。
varws=newWebSocket('ws://localhost:8080');
執(zhí)行上面語句之后,客戶端就會(huì)與服務(wù)器進(jìn)行連接。
實(shí)例對(duì)象的所有屬性和方法清單,參見這里。
4.2 webSocket.readyState
readyState屬性返回實(shí)例對(duì)象的當(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 somethingbreak;case WebSocket.OPEN: // do somethingbreak;case WebSocket.CLOSING: // do somethingbreak;case WebSocket.CLOSED: // do somethingbreak;default: // this never happensbreak;}
4.3 webSocket.onopen
實(shí)例對(duì)象的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í)例對(duì)象的onclose屬性,用于指定連接關(guān)閉后的回調(diào)函數(shù)。
ws.onclose=function(event){varcode=event.code;varreason=event.reason;varwasClean=event.wasClean; // handle close event};ws.addEventListener("close",function(event){varcode=event.code;varreason=event.reason;varwasClean=event.wasClean; // handle close event});
4.5 webSocket.onmessage
實(shí)例對(duì)象的onmessage屬性,用于指定收到服務(wù)器數(shù)據(jù)后的回調(diào)函數(shù)。
ws.onmessage=function(event){vardata=event.data; // 處理數(shù)據(jù)};ws.addEventListener("message",function(event){vardata=event.data; // 處理數(shù)據(jù)});
注意,服務(wù)器數(shù)據(jù)可能是文本,也可能是二進(jìn)制數(shù)據(jù)(blob對(duì)象或Arraybuffer對(duì)象)。
ws.onmessage=function(event){if(typeofevent.data===String){console.log("Received data string");}if(event.datainstanceofArrayBuffer){varbuffer=event.data;console.log("Received arraybuffer");}}
除了動(dòng)態(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í)例對(duì)象的send()方法用于向服務(wù)器發(fā)送數(shù)據(jù)。
發(fā)送文本的例子。
ws.send('your message');
發(fā)送 Blob 對(duì)象的例子。
varfile=document.querySelector('input[type="file"]').files[0];ws.send(file);
發(fā)送 ArrayBuffer 對(duì)象的例子。
// Sending canvas ImageData as ArrayBuffervarimg=canvas_context.getImageData(0,0,400,320);varbinary=newUint8Array(img.data.length);for(vari=0;i
4.7 webSocket.bufferedAmount
實(shí)例對(duì)象的bufferedAmount屬性,表示還有多少字節(jié)的二進(jìn)制數(shù)據(jù)沒有發(fā)送出去。它可以用來判斷發(fā)送是否結(jié)束。
vardata=newArrayBuffer(10000000);socket.send(data);if(socket.bufferedAmount===0){ // 發(fā)送完畢}else{ // 發(fā)送還沒結(jié)束}
4.8 webSocket.onerror
實(shí)例對(duì)象的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)有以下三種。
具體的用法請(qǐng)查看它們的文檔,這里不詳細(xì)介紹了。
六、WebSocketd
下面,我要推薦一款非常特別的 WebSocket 服務(wù)器:Websocketd。
它的最大特點(diǎn),就是后臺(tái)腳本不限語言,標(biāo)準(zhǔn)輸入(stdin)就是 WebSocket 的輸入,標(biāo)準(zhǔn)輸出(stdout)就是 WebSocket 的輸出。
舉例來說,下面是一個(gè) Bash 腳本counter.sh。
#!/bin/bashecho1sleep1echo2sleep1echo3
命令行下運(yùn)行這個(gè)腳本,會(huì)輸出1、2、3,每個(gè)值之間間隔1秒。
$ bash./counter.sh123
現(xiàn)在,啟動(dòng)websocketd,指定這個(gè)腳本作為服務(wù)。
$ websocketd--port=8080bash./counter.sh
上面的命令會(huì)啟動(dòng)一個(gè) WebSocket 服務(wù)器,端口是8080。每當(dāng)客戶端連接這個(gè)服務(wù)器,就會(huì)執(zhí)行counter.sh腳本,并將它的輸出推送給客戶端。
varws=newWebSocket('ws://localhost:8080/');ws.onmessage=function(event){console.log(event.data);};
上面是客戶端的 JavaScript 代碼,運(yùn)行之后會(huì)在控制臺(tái)依次輸出1、2、3。
有了它,就可以很方便地將命令行的輸出,發(fā)給瀏覽器。
$ websocketd--port=8080ls
上面的命令會(huì)執(zhí)行l(wèi)s命令,從而將當(dāng)前目錄的內(nèi)容,發(fā)給瀏覽器。使用這種方式實(shí)時(shí)監(jiān)控服務(wù)器,簡直是輕而易舉(代碼)。
更多的用法可以參考官方示例。
Bash 腳本讀取客戶端輸入的例子
五行代碼實(shí)現(xiàn)一個(gè)最簡單的聊天服務(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(){varchunk=process.stdin.read();if(chunk!==null){process.stdout.write('data: '+chunk);}});
啟動(dòng)這個(gè)腳本的命令如下。
$ websocketd--port=8080node./greeter.js