JavaScript WebSocket

2018-07-24 11:54 更新

目錄

WebSocket 的由來

WebSocket 是一種網(wǎng)絡(luò)通信協(xié)議,很多高級(jí)功能都需要它。

初次接觸 WebSocket 的人,都會(huì)問同樣的問題:我們已經(jīng)有了 HTTP 協(xié)議,為什么還需要另一個(gè)協(xié)議?它能帶來什么好處?

答案很簡(jiǎn)單,因?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ù)器有沒有新的信息。最典型的場(chǎng)景就是聊天室。

輪詢的效率低,非常浪費(fèi)資源(因?yàn)楸仨毑煌_B接,或者 HTTP 連接始終打開)。因此,工程師們一直在思考,有沒有更好的方法。WebSocket 就是這樣發(fā)明的。

簡(jiǎn)介

WebSocket 協(xié)議在2008年誕生,2011年成為國(guó)際標(biāo)準(zhǔn)。所有瀏覽器都已經(jīng)支持了。

它的最大特點(diǎn)就是,服務(wù)器可以主動(dòng)向客戶端推送信息,客戶端也可以主動(dòng)向服務(wù)器發(fā)送信息,是真正的雙向平等對(duì)話,屬于服務(wù)器推送技術(shù)的一種。WebSocket 允許服務(wù)器端與客戶端進(jìn)行全雙工(full-duplex)的通信。舉例來說,HTTP 協(xié)議有點(diǎn)像發(fā)電子郵件,發(fā)出后必須等待對(duì)方回信;WebSocket 則是像打電話,服務(wù)器端和客戶端可以同時(shí)向?qū)Ψ桨l(fā)送數(shù)據(jù),它們之間存著一條持續(xù)打開的數(shù)據(jù)通道。

其他特點(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ù)器通信,完全可以取代 Ajax。

(6)協(xié)議標(biāo)識(shí)符是ws(如果加密,則為wss,對(duì)應(yīng) HTTPS 協(xié)議),服務(wù)器網(wǎng)址就是 URL。

ws://example.com:80/some/path

WebSocket 握手

瀏覽器發(fā)出的 WebSocket 握手請(qǐng)求類似于下面的樣子:

GET / HTTP/1.1
Connection: Upgrade
Upgrade: websocket
Host: example.com
Origin: null
Sec-WebSocket-Key: sN9cRrP/n9NdMgdcy2VJFQ==
Sec-WebSocket-Version: 13

上面的頭信息之中,有一個(gè) HTTP 頭是Upgrade。HTTP1.1 協(xié)議規(guī)定,Upgrade表示將通信協(xié)議從HTTP/1.1轉(zhuǎn)向該字段指定的協(xié)議。Connection字段表示瀏覽器通知服務(wù)器,如果可以的話,就升級(jí)到 WebSocket 協(xié)議。Origin字段用于提供請(qǐng)求發(fā)出的域名,供服務(wù)器驗(yàn)證是否許可的范圍內(nèi)(服務(wù)器也可以不驗(yàn)證)。Sec-WebSocket-Key則是用于握手協(xié)議的密鑰,是 Base64 編碼的16字節(jié)隨機(jī)字符串。

服務(wù)器的 WebSocket 回應(yīng)如下。

HTTP/1.1 101 Switching Protocols
Connection: Upgrade
Upgrade: websocket
Sec-WebSocket-Accept: fFBooB7FAkLlXgRSz0BT3v4hq5s=
Sec-WebSocket-Origin: null
Sec-WebSocket-Location: ws://example.com/

上面代碼中,服務(wù)器同樣用Connection字段通知瀏覽器,需要改變協(xié)議。Sec-WebSocket-Accept字段是服務(wù)器在瀏覽器提供的Sec-WebSocket-Key字符串后面,添加“258EAFA5-E914-47DA-95CA-C5AB0DC85B11”字符串,然后再取 SHA-1 的哈希值。瀏覽器將對(duì)這個(gè)值進(jìn)行驗(yàn)證,以證明確實(shí)是目標(biāo)服務(wù)器回應(yīng)了 WebSocket 請(qǐng)求。Sec-WebSocket-Location字段表示進(jìn)行通信的 WebSocket 網(wǎng)址。

完成握手以后,WebSocket 協(xié)議就在 TCP 協(xié)議之上,開始傳送數(shù)據(jù)。

客戶端的簡(jiǎn)單示例

WebSocket 的用法相當(dāng)簡(jiǎn)單。

下面是一個(gè)網(wǎng)頁腳本的例子,基本上一眼就能明白。

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

瀏覽器對(duì) WebSocket 協(xié)議的處理,無非就是三件事。

  • 建立連接和斷開連接
  • 發(fā)送數(shù)據(jù)和接收數(shù)據(jù)
  • 處理錯(cuò)誤

構(gòu)造函數(shù) WebSocket

WebSocket對(duì)象作為一個(gè)構(gòu)造函數(shù),用于新建WebSocket實(shí)例。

var ws = new WebSocket('ws://localhost:8080');

執(zhí)行上面語句之后,客戶端就會(huì)與服務(wù)器進(jìn)行連接。

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 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;
}

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!');
});

webSocket.onclose

實(shí)例對(duì)象的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
});

webSocket.onmessage

實(shí)例對(duì)象的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對(duì)象或Arraybuffer對(duì)象)。

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");
  }
}

除了動(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);
};

webSocket.send()

實(shí)例對(duì)象的send()方法用于向服務(wù)器發(fā)送數(shù)據(jù)。

發(fā)送文本的例子。

ws.send('your message');

發(fā)送 Blob 對(duì)象的例子。

var file = document
  .querySelector('input[type="file"]')
  .files[0];
ws.send(file);

發(fā)送 ArrayBuffer 對(duì)象的例子。

// 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);

webSocket.bufferedAmount

實(shí)例對(duì)象的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é)束
}

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
});

WebSocket 服務(wù)器

WebSocket 協(xié)議需要服務(wù)器支持。各種服務(wù)器的實(shí)現(xiàn),可以查看維基百科的列表。

常用的 Node 實(shí)現(xiàn)有以下三種。

具體的用法請(qǐng)查看它們的文檔,本教程不詳細(xì)介紹了。

參考鏈接

以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)