WebSocket · Web API 教程

# WebSocket WebSocket 是一種網絡通信協議，很多高級功能都需要它。初次接觸 WebSocket 的人，都會問同樣的問題：我們已經有了 HTTP 協議，為什么還需要另一個協議？它能帶來什么好處？答案很簡單，因為 HTTP 協議有一個缺陷：通信只能由客戶端發起。舉例來說，我們想了解今天的天氣，只能是客戶端向服務器發出請求，服務器返回查詢結果。HTTP 協議做不到服務器主動向客戶端推送信息。HTTP 協議的這種單向請求的特點，注定了如果服務器有連續的狀態變化，客戶端要獲知就非常麻煩。我們只能使用“輪詢”：每隔一段時候，就發出一個詢問，了解服務器有沒有新的信息。最典型的場景就是聊天室。輪詢的效率低，非常浪費資源（因為必須不停連接，或者 HTTP 連接始終打開）。因此，工程師們一直在思考，有沒有更好的方法。WebSocket 就是這樣發明的。 ## 簡介 WebSocket 協議在2008年誕生，2011年成為國際標準。所有瀏覽器都已經支持了。它的最大特點就是，服務器可以主動向客戶端推送信息，客戶端也可以主動向服務器發送信息，是真正的雙向平等對話，屬于服務器推送技術的一種。WebSocket 允許服務器端與客戶端進行全雙工（full-duplex）的通信。舉例來說，HTTP 協議有點像發電子郵件，發出后必須等待對方回信；WebSocket 則是像打電話，服務器端和客戶端可以同時向對方發送數據，它們之間存著一條持續打開的數據通道。其他特點包括：（1）建立在 TCP 協議之上，服務器端的實現比較容易。（2）與 HTTP 協議有著良好的兼容性。默認端口也是80和443，并且握手階段采用 HTTP 協議，因此握手時不容易屏蔽，能通過各種 HTTP 代理服務器。（3）數據格式比較輕量，性能開銷小，通信高效。（4）可以發送文本，也可以發送二進制數據。（5）沒有同源限制，客戶端可以與任意服務器通信，完全可以取代 Ajax。（6）協議標識符是`ws`（如果加密，則為`wss`，對應 HTTPS 協議），服務器網址就是 URL。 ```html ws://example.com:80/some/path ``` ## WebSocket 握手瀏覽器發出的 WebSocket 握手請求類似于下面的樣子： ```http GET / HTTP/1.1 Connection: Upgrade Upgrade: websocket Host: example.com Origin: null Sec-WebSocket-Key: sN9cRrP/n9NdMgdcy2VJFQ== Sec-WebSocket-Version: 13 ``` 上面的頭信息之中，有一個 HTTP 頭是`Upgrade`。HTTP1.1 協議規定，`Upgrade`字段表示將通信協議從`HTTP/1.1`轉向該字段指定的協議。`Connection`字段表示瀏覽器通知服務器，如果可以的話，就升級到 WebSocket 協議。`Origin`字段用于提供請求發出的域名，供服務器驗證是否許可的范圍內（服務器也可以不驗證）。`Sec-WebSocket-Key`則是用于握手協議的密鑰，是 Base64 編碼的16字節隨機字符串。服務器的 WebSocket 回應如下。 ```http HTTP/1.1 101 Switching Protocols Connection: Upgrade Upgrade: websocket Sec-WebSocket-Accept: fFBooB7FAkLlXgRSz0BT3v4hq5s= Sec-WebSocket-Origin: null Sec-WebSocket-Location: ws://example.com/ ``` 上面代碼中，服務器同樣用`Connection`字段通知瀏覽器，需要改變協議。`Sec-WebSocket-Accept`字段是服務器在瀏覽器提供的`Sec-WebSocket-Key`字符串后面，添加 [RFC6456](http://tools.ietf.org/html/rfc6455) 標準規定的“258EAFA5-E914-47DA-95CA-C5AB0DC85B11”字符串，然后再取 SHA-1 的哈希值。瀏覽器將對這個值進行驗證，以證明確實是目標服務器回應了 WebSocket 請求。`Sec-WebSocket-Location`字段表示進行通信的 WebSocket 網址。完成握手以后，WebSocket 協議就在 TCP 協議之上，開始傳送數據。 ## 客戶端的簡單示例 WebSocket 的用法相當簡單。下面是一個網頁腳本的例子，基本上一眼就能明白。 ```javascript 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 協議的處理，無非就是三件事。 - 建立連接和斷開連接 - 發送數據和接收數據 - 處理錯誤 ### 構造函數 WebSocket `WebSocket`對象作為一個構造函數，用于新建`WebSocket`實例。 ```javascript var ws = new WebSocket('ws://localhost:8080'); ``` 執行上面語句之后，客戶端就會與服務器進行連接。 ### webSocket.readyState `readyState`屬性返回實例對象的當前狀態，共有四種。 - CONNECTING：值為0，表示正在連接。 - OPEN：值為1，表示連接成功，可以通信了。 - CLOSING：值為2，表示連接正在關閉。 - CLOSED：值為3，表示連接已經關閉，或者打開連接失敗。下面是一個示例。 ```javascript 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 實例對象的`onopen`屬性，用于指定連接成功后的回調函數。 ```javascript ws.onopen = function () { ws.send('Hello Server!'); } ``` 如果要指定多個回調函數，可以使用`addEventListener`方法。 ```javascript ws.addEventListener('open', function (event) { ws.send('Hello Server!'); }); ``` ### webSocket.onclose 實例對象的`onclose`屬性，用于指定連接關閉后的回調函數。 ```javascript 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 實例對象的`onmessage`屬性，用于指定收到服務器數據后的回調函數。 ```javascript ws.onmessage = function(event) { var data = event.data; // 處理數據 }; ws.addEventListener("message", function(event) { var data = event.data; // 處理數據 }); ``` 注意，服務器數據可能是文本，也可能是二進制數據（`blob`對象或`Arraybuffer`對象）。 ```javascript 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"); } } ``` 除了動態判斷收到的數據類型，也可以使用`binaryType`屬性，顯式指定收到的二進制數據類型。 ```javascript // 收到的是 blob 數據 ws.binaryType = "blob"; ws.onmessage = function(e) { console.log(e.data.size); }; // 收到的是 ArrayBuffer 數據 ws.binaryType = "arraybuffer"; ws.onmessage = function(e) { console.log(e.data.byteLength); }; ``` ### webSocket.send() 實例對象的`send()`方法用于向服務器發送數據。發送文本的例子。 ```javascript ws.send('your message'); ``` 發送 Blob 對象的例子。 ```javascript var file = document .querySelector('input[type="file"]') .files[0]; ws.send(file); ``` 發送 ArrayBuffer 對象的例子。 ```javascript // 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 實例對象的`bufferedAmount`屬性，表示還有多少字節的二進制數據沒有發送出去。它可以用來判斷發送是否結束。 ```javascript var data = new ArrayBuffer(10000000); socket.send(data); if (socket.bufferedAmount === 0) { // 發送完畢 } else { // 發送還沒結束 } ``` ### webSocket.onerror 實例對象的`onerror`屬性，用于指定報錯時的回調函數。 ```javascript socket.onerror = function(event) { // handle error event }; socket.addEventListener("error", function(event) { // handle error event }); ``` ## WebSocket 服務器 WebSocket 協議需要服務器支持。各種服務器的實現，可以查看維基百科的[列表](https://en.wikipedia.org/wiki/Comparison_of_WebSocket_implementations)。常用的 Node 實現有以下三種。 - [μWebSockets](https://github.com/uWebSockets/uWebSockets) - [Socket.IO](http://socket.io/) - [WebSocket-Node](https://github.com/theturtle32/WebSocket-Node) 具體的用法請查看它們的文檔，本教程不詳細介紹了。 ## 參考鏈接 - Ryan Stewart, [Real-time data exchange in HTML5 with WebSockets](http://www.adobe.com/devnet/html5/articles/real-time-data-exchange-in-html5-with-websockets.html) - Malte Ubl & Eiji Kitamura，[Introducing WebSockets: Bringing Sockets to the Web](https://www.html5rocks.com/en/tutorials/websockets/basics/) - Jack Lawson, [WebSockets: A Guide](http://buildnewgames.com/websockets/) - Michael W., [Starting with Node and Web Sockets](http://codular.com/node-web-sockets) - Jesse Cravens, [Introduction to WebSockets](http://tech.pro/tutorial/1167/introduction-to-websockets) - Matt West, [An Introduction to WebSockets](http://blog.teamtreehouse.com/an-introduction-to-websockets) - Maciej Sopy?o, [Node.js: Better Performance With Socket.IO and doT](http://net.tutsplus.com/tutorials/javascript-ajax/node-js-better-performance-with-socket-io-and-dot/) - Jos Dirksen, [Capture Canvas and WebGL output as video using websockets](http://www.smartjava.org/content/capture-canvas-and-webgl-output-video-using-websockets) - Fionn Kellehe, [Understanding Socket.IO](https://nodesource.com/blog/understanding-socketio) - [How to Use WebSockets](http://cjihrig.com/blog/how-to-use-websockets/) - [WebSockets - Send & Receive Messages](https://www.tutorialspoint.com/websockets/websockets_send_receive_messages.htm)