在 HTML5 規範中,我最喜歡的 Web 技術就是正迅速流行的 WebSocket API。WebSocket 提供了一項受歡迎的技術,用來替代我們過去幾年一直在用的 Ajax。這個新 API 提供了一種方法,能讓客戶端用簡單的語法有效地把訊息推送到伺服器。接下來,我們來看看 HTML5 的 WebSocket API——它可用於客戶端與伺服器端,而且還有一個優秀的第三方 API,名為 Socket.IO。
WebSocket API 是下一代的客戶端—伺服器非同步通訊方法。它以單一 TCP 套接字為基礎,使用 ws 或 wss 協定,可用於任意的客戶端與伺服器程式。WebSocket 目前正由 W3C 進行標準化,已受到 Firefox 4、Chrome 4、Opera 10.70 及 Safari 5 等瀏覽器的支援。
WebSocket 最偉大之處在於:伺服器與客戶端可以在任意時刻相互推送訊息。它不像 Ajax(或 XHR)那樣只能由客戶端發起請求——WebSocket 讓伺服器與客戶端能彼此主動推送;而且 XHR 受限於同域,WebSocket 則允許跨域通訊。Ajax 很聰明的一點,是它並沒有規定必須怎麼用;而 WebSocket 從設計之初就明確指向雙向推送訊息這個目標。
由於每種伺服器端語言都有自己的 API,這裡只聚焦於客戶端。下面的程式碼示範了開啟連線、為連線建立事件監聽器、監聽訊息、發送訊息回伺服器,以及關閉連線:
// 建立一個 Socket 實例
var socket = new WebSocket('ws://localhost:8080');
// 開啟 Socket
socket.onopen = function(event){
// 發送一個初始化訊息
socket.send('I am the client and I\'m listening!');
// 監聽訊息
socket.onmessage = function(event){
console.log('Client received a message',event);
};
// 監聽 Socket 的關閉
socket.onclose = function(event){
console.log('Client notified socket has closed',event);
};
// 關閉 Socket....
//socket.close()
};
來看看上面的初始化片段:參數為 URL,ws 代表 WebSocket 協定。onopen、onclose 和 onmessage 方法把事件連接到 Socket 實例上,每個方法都提供了一個事件,用來表示 Socket 的狀態。onmessage 事件提供了一個 data 屬性,它可包含訊息的 Body 部分——Body 必須是一個字串,可以進行序列化/反序列化操作,以便傳遞更多資料。
WebSocket 的語法非常簡單,使用它易如反掌……除非客戶端不支援 WebSocket。IE 瀏覽器目前不支援 WebSocket 通訊。如果你的客戶端不支援,以下有幾個後備方案可供參考:
Flash 技術——Flash 可提供一個簡單的替換,最明顯的缺點是並非所有客戶端都安裝了 Flash,而且某些裝置(如 iPhone/iPad)根本不支援 Flash。
AJAX Long-Polling 技術——用 AJAX 的 long-polling 來模擬 WebSocket,在業界已有一段時間,它是可行的技術,但無法優化傳送的訊息,也就是說它是解決方案,卻不是最佳方案。
由於目前 IE 等瀏覽器不支援 WebSocket,若要在提供 WebSocket 事件處理、返回傳輸的同時,於伺服器端使用統一的 API,該怎麼辦?幸運的是,Guillermo Rauch 創造了 Socket.IO 這項技術。
Socket.IO 是 Guillermo Rauch 打造的 WebSocket API,他是 LearnBoost 公司的 CTO 兼 LearnBoost 實驗室的首席科學家。Socket.IO 使用功能偵測來判斷是建立 WebSocket 連線、AJAX long-polling 連線,還是 Flash 等,能快速建立即時應用程式。Socket.IO 還提供了一個 NodeJS API,看起來非常像客戶端 API。
建立客戶端 Socket.IO。Socket.IO 可從 GitHub 下載,把 socket.io.js 檔包含到頁面中:
<script src="https://cdn.socket.io/stable/socket.io.js"></script>
此時 Socket.IO 在此頁面上是有效的,是時候建立 Socket 了:
// 建立 Socket.IO 實例,建立連線
var socket = new io.Socket('localhost',{
port: 8080
});
socket.connect();
// 添加一個連線監聽器
socket.on('connect',function(){
console.log('Client has connected to the server!');
});
// 添加一個訊息監聽器
socket.on('message',function(data){
console.log('Received a message from the server!',data);
});
// 添加一個關閉連線的監聽器
socket.on('disconnect',function(){
console.log('The client has disconnected!');
});
// 透過 Socket 發送一條訊息到伺服器
function sendMessageToServer(message){
socket.send(message);
}
Socket.IO 簡化了 WebSocket API,統一了返回傳輸的 API,傳輸方式包括:WebSocket、Flash Socket、AJAX long-polling、AJAX multipart streaming、IFrame、JSONP polling。你還可以設定 Socket.IO 建構式的第二個選項,包括:port(待連線的埠)、transports(包含不同傳輸類型的陣列)、transportOptions(傳輸參數使用的物件,帶附加屬性)。Socket.IO 還提供了由本地 WebSocket API 提供的普通連線、斷開連線、訊息事件,Socket 也提供了封裝每個事件類型的方法。
Socket.IO 提供的伺服器端解決方案,允許客戶端與伺服器端使用統一的 API。使用 Node,你可以建立一個典型的 HTTP 伺服器,然後把伺服器實例傳遞給 Socket.IO,接著像客戶端一樣建立連線、斷開連線與訊息監聽器。一個簡單的伺服器端腳本如下:
// 需要 HTTP 模組來啟動伺服器與 Socket.IO
var http = require('http'), io = require('socket.io');
// 在 8080 埠啟動伺服器
var server = http.createServer(function(req, res){
// 發送 HTML 的 headers 和 message
res.writeHead(200,{'Content-Type': 'text/html' });
res.end('<h1>Hello Socket Lover!</h1>');
});
server.listen(8080);
// 建立一個 Socket.IO 實例,把它傳遞給伺服器
var socket = io.listen(server);
// 添加一個連線監聽器
socket.on('connection', function(client){
// 成功!現在開始監聽接收到的訊息
client.on('message',function(event){
console.log('Received message from client!',event);
});
client.on('disconnect',function(){
clearInterval(interval);
console.log('Server has disconnected');
});
});
假設已安裝 NodeJS,可從命令列執行伺服器部分:
node socket-server.js
現在客戶端與伺服器都能來回推送訊息了!在 NodeJS 腳本內,你可以用簡單的 JavaScript 建立一個定期訊息發送器:
// 建立一個定期(每 5 秒)發送訊息到客戶端的發送器
var interval = setInterval(function(){
client.send('This is a message from the server! ' + new Date().getTime());
},5000);
伺服器端將會每 5 秒推送訊息到客戶端。
Persevere 的創造者 Kris Zyp 建立了 dojox.Socket。dojox.Socket 以與 Dojo 函式庫一致的方式封裝了 WebSocket API,並在客戶端不支援 WebSocket 時,使用 long-polling 替代。以下是在客戶端使用 dojox.Socket、在伺服器端使用 Socket.IO 的例子:
var args, ws = typeof WebSocket != 'undefined';
var socket = dojox.socket(args = {
url: ws ? '/socket.io/websocket' : '/socket.io/xhr-polling',
headers:{
'Content-Type':'application/x-www-urlencoded'
},
transport: function(args, message){
args.content = message;// 使用 URL-encoding 發送訊息,而非原始 body
dojo.xhrPost(args);
}
});
var sessionId;
socket.on('message', function(){
if (!sessionId){
sessionId = message;
args.url += '/' + sessionId;
}else if(message.substr(0, 3) == '~h~'){
// a heartbeat
}
});
dojox.socket.Reconnect 還能在套接字失去連線時自動重連。期待包含 dojox.Socket 的 Dojo 1.6 版本早日發布。
WebSocket 有許多實際應用。對於大多數客戶端—伺服器的非同步通訊,WebSocket 都是理想的選擇,其中最突出的應用便是瀏覽器內的即時聊天。憑藉高效率,WebSocket 已被越來越多公司所採用。