HTML5 WebSocket
WebSocket是HTML5開始提供的一種在單個TCP 連接上進行全雙工通訊的協議。
在WebSocket API中,瀏覽器和服務器只需要做一個握手的動作,然後,瀏覽器和服務器之間就形成了一條快速通道。 兩者之間就直接可以數據互相傳送。
瀏覽器通過JavaScript 向服務器發出建立WebSocket 連接的請求,連接建立以後,客戶端和服務器端就可以通過TCP 連接直接交換數據。
當你獲取Web Socket連接後,你可以通過send()方法來向服務器發送數據,並通過onmessage事件來接收服務器返回的數據。
以下API 用於創建WebSocket 對象。
var Socket = new WebSocket(url, [protocal] );
以上代碼中的第一個參數url, 指定連接的URL。 第二個參數protocol 是可選的,指定了可接受的子協議。
WebSocket 屬性
以下是WebSocket 對象的屬性。 假定我們使用了以上代碼創建了Socket 對象:
屬性 | 描述 |
---|---|
Socket.readyState | 只讀屬性readyState表示連接狀態,可以是以下值:
|
Socket.bufferedAmount | 只讀屬性bufferedAmount已被send()放入正在隊列中等待傳輸,但是還沒有發出的UTF-8文本字節數。 |
WebSocket 事件
以下是WebSocket 對象的相關事件。 假定我們使用了以上代碼創建了Socket 對象:
事件 | 事件處理程序 | 描述 |
---|---|---|
open | Socket.onopen | 連接建立時觸發 |
message | Socket.onmessage | 客戶端接收服務端數據時觸發 |
error | Socket.onerror | 通信發生錯誤時觸發 |
close | Socket.onclose | 連接關閉時觸發 |
WebSocket 方法
以下是WebSocket 對象的相關方法。 假定我們使用了以上代碼創建了Socket 對象:
方法 | 描述 |
---|---|
Socket.send() | 使用連接發送數據 |
Socket.close() | 關閉連接 |
WebSocket 實例
WebSocket 協議本質上是一個基於TCP 的協議。
為了建立一個WebSocket 連接,客戶端瀏覽器首先要向服務器發起一個HTTP 請求,這個請求和通常的HTTP 請求不同,包含了一些附加頭信息,其中附加頭信息"Upgrade: WebSocket"表明這是一個申請協議升級的HTTP 請求,服務器端解析這些附加的頭信息然後產生應答信息返回給客戶端,客戶端和服務器端的WebSocket 連接就建立起來了,雙方就可以通過這個連接通道自由的傳遞信息,並且這個連接會持續存在直到客戶端或者服務器端的某一方主動的關閉連接。
客戶端的HTML 和JavaScript
目前大部分瀏覽器支持WebSocket() 接口,你可以在以下瀏覽器中嘗試實例: Chrome, Mozilla, Opera 和Safari。
w3big_websocket.html 文件內容
<!DOCTYPE HTML> <html> <head> <meta charset="utf-8"> <title>本教程(w3big.com)</title> <script type="text/javascript"> function WebSocketTest() { if ("WebSocket" in window) { alert("您的浏览器支持 WebSocket!"); // 打开一个 web socket var ws = new WebSocket("ws://localhost:9998/echo"); ws.onopen = function() { // Web Socket 已连接上,使用 send() 方法发送数据 ws.send("发送数据"); alert("数据发送中..."); }; ws.onmessage = function (evt) { var received_msg = evt.data; alert("数据已接收..."); }; ws.onclose = function() { // 关闭 websocket alert("连接已关闭..."); }; } else { // 浏览器不支持 WebSocket alert("您的浏览器不支持 WebSocket!"); } } </script> </head> <body> <div id="sse"> <a href="javascript:WebSocketTest()">运行 WebSocket</a> </div> </body> </html>
安裝pywebsocket
在執行以上程序前,我們需要創建一個支持WebSocket 的服務。 從pywebsocket下載mod_pywebsocket ,或者使用git命令下載:
git clone https://github.com/google/pywebsocket.git
mod_pywebsocket 需要python 環境支持
mod_pywebsocket 是一個Apache HTTP 的Web Socket擴展,安裝步驟如下:解壓下載的文件。
進入pywebsocket目錄。
執行命令:
$ python setup.py build $ sudo python setup.py install
查看文檔說明:
$ pydoc mod_pywebsocket
開啟服務
在pywebsocket/mod_pywebsocket目錄下執行以下命令:
$ sudo python standalone.py -p 9998 -w ../example/
以上命令會開啟一個端口號為9998 的服務,使用-w 來設置處理程序echo_wsh.py 所在的目錄。
現在我們可以在Chrome 瀏覽器打開前面創建的w3big_websocket.html 文件。 如果你的瀏覽器支持WebSocket(), 點擊"運行WebSocket",你就可以看到整個流程各個步驟彈出的窗口,流程Gif 演示:
在我們停止服務後,會彈出"連接已關閉..."。