上一篇介紹了 Socket.IO 的基本用法並做了一個聊天室範例,本篇在入門的基礎上繼續往下走,從配置、房間、事件、授權四個角度整理一些實用 API 與容易忽略的細節。
Socket.IO 提供四個配置 API:io.configure、io.set、io.enable、io.disable。其中 io.set 針對單項設定,io.enable 與 io.disable 專門設定布林型配置,而 io.configure 讓你能為不同執行環境(development、test 等)套用不同參數:
var io = require('socket.io').listen(80);
io.configure('development', function () {
io.enable('browser client etag');
io.set('log level', 1);
});
io.configure('release', function () {
io.set('transports', ['websocket']);
});
幾個常用配置項:
1. transports(預設 ['websocket', 'htmlfile', 'xhr-polling', 'jsonp-polling']):可通訊方式的陣列。Socket.IO 支援多種即時通信實作,這項讓你自行決定備援順序
2. log level(預設 3):日誌輸出的最低層級,0 為 error、1 為 warn、2 為 info、3 為 debug,預設輸出全部
3. heartbeat interval(預設 25 秒):心跳包發送間隔,客戶端需在此時間內回應心跳才能維持連線
更完整的參數請查閱官方 WIKI。
房間是 Socket.IO 相當好用的一個功能,相當於為特定客戶端提供了一個命名空間,房間內的廣播與通信完全不影響房間外的客戶端。
進房與離房分別是 socket.join('room name') 與 socket.leave('room name')。進入房間後,可用兩種方式在房間內廣播:
// 1. 向 my room 廣播,發送者會被排除(收不到訊息)
// 注意:這是從客戶端的角度送出事件
io.sockets.on('connection', function (socket) {
socket.broadcast.to('my room').emit('event_name', data);
});
// 2. 向 another room 廣播,房間內所有客戶端都會收到
// 注意:這是從伺服器的角度送出事件
io.sockets.in('another room').emit('event_name', data);
// 向所有客戶端廣播
io.sockets.emit('event_name', data);
除了廣播,也能查詢房間資訊:
// 取得所有房間資訊,key 為房間名,value 為該房間的 socket ID 陣列
io.sockets.manager.rooms
// 取得指定房間內的客戶端,回傳該房間所有 socket 實例
io.sockets.clients('particular room')
// 透過 socket.id 取得該 socket 所在的房間
io.sockets.manager.roomClients[socket.id]
Socket.IO 內建了一批預設事件,設計自訂事件時應避開這些名稱,同時也要善用它們。
伺服器端事件:
1. io.sockets.on('connection', function(socket) {}):連線成功後觸發,通常用於初始化
2. socket.on('message', function(message, callback) {}):客戶端透過 socket.send 送訊息時觸發,callback 是收到後要執行的回調
3. socket.on('anything', function(data) {}):收到任何事件時觸發
4. socket.on('disconnect', function() {}):連線中斷時觸發(關閉瀏覽器、主動斷線、網路掉落等情況都算)
客戶端事件:
1. connect:連線成功
2. connecting:正在連線
3. disconnect:已斷線
4. connect_failed:連線失敗
5. error:發生錯誤且無法被其他事件類型處理
6. message:同伺服器端 message
7. anything:同伺服器端 anything
8. reconnect_failed:重連失敗
9. reconnect:重連成功
10. reconnecting:正在重連
特別說明客戶端的觸發順序:首次連線為 connecting → connect;失去連線後為 disconnect → reconnecting(可能多次)→ connecting → reconnect → connect。掌握這個順序,才能正確處理 loading 狀態與重試邏輯。
// 1. 向所有客戶端廣播
socket.broadcast.emit('broadcast message');
// 2. 進入房間
socket.join('your room name');
// 3. 向房間廣播(發送者收不到)
socket.broadcast.to('your room name').emit('broadcast room message');
// 4. 向房間廣播(含發送者,此 API 屬於 io.sockets)
io.sockets.in('another room name').emit('broadcast room message');
// 5. 強制使用 WebSocket:客戶端 socket.send('hi'),伺服器以 socket.on('message', ...) 接收
Socket.IO 的進階用法大致就是這些。日常開發中這些 API 已經足夠,也正好體現了它極簡易用的設計哲學。本文只是拋磚引玉,實務上遇到文件裡沒寫的問題時,直接翻官方 WIKI 會更有效率。