Socket.IO 的官網相當簡潔(https://socket.io),甚至沒有完整的 API 文件,只留一個「How to use」——而它的使用方式確實如其官網一般簡單。
那它究竟是什麼?Socket.IO 是一個 WebSocket 函式庫,同時提供客戶端 JS 與伺服器端 Node.js 實作,目標是打造能在不同瀏覽器與行動裝置上運行的即時應用。它會依瀏覽器能力自動在 WebSocket、AJAX 長輪詢、Iframe 串流等方式中挑選最佳方案,既方便又貼心,且相容性極好,最低支援到 IE5.5。
npm install socket.io
express 是一個小巧的 Node.js Web 應用框架,建立 HTTP 伺服器時經常用到,因此直接以 Socket.IO 搭配 express 說明:
var express = require('express')
, app = express()
, server = require('http').createServer(app)
, io = require('socket.io').listen(server);
server.listen(3001);
若不使用 express,可參考官網的 how-to-use。
分為伺服器端與客戶端兩段,都很簡單。
// 接上面的程式碼
app.get('/', function (req, res) {
res.sendfile(__dirname + '/index.html');
});
io.sockets.on('connection', function (socket) {
socket.emit('news', { hello: 'world' });
socket.on('other event', function (data) {
console.log(data);
});
});
io.sockets.on 接受事件名稱 "connection",代表客戶端發起連線;連線成功後呼叫帶有 socket 參數的回調。使用 Socket.IO 時,絕大多數邏輯都寫在這個回調裡。
最關鍵的是 emit 與 on 兩個方法:emit 用於送出事件,第一個參數是自訂的事件名稱字串,緊接一個物件表示要傳送的內容;on 用於接收事件,第一個參數是事件名稱,緊接收到事件後要執行的回調,其中 data 即收到的資料。
上例中伺服器送出了 news、接收了 other event,那麼客戶端自然要做相反的動作,寫法幾乎鏡像對稱。
<script src="/socket.io/socket.io.js"></script>
<script>
var socket = io.connect('https://localhost');
socket.on('news', function (data) {
console.log(data);
socket.emit('other event', { my: 'data' });
});
</script>
兩點要留意:其一,socket.io.js 的路徑要寫對,這個檔案實際位於伺服器端的 node_modules 中,請求時會被重定向,所以別納悶「伺服器上明明沒這個檔案為何還能跑」;你也可以把它複製到本地作為客戶端檔案,省去每次向 Node 伺服器請求的往返,穩定性更好。其二,要用 var socket = io.connect('網站位址或 IP'); 取得 socket 物件,之後即可用它收發事件。
另外,Socket.IO 內建了一些預設事件名,例如 "disconnect" 表示客戶端斷線、"message" 表示收到訊息。自訂事件名盡量別與這些預設名稱重名,以免造成困擾。
// 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 做聊天室,大約五十行程式碼就能搞定,即時效果相當不錯。以下是關鍵部分。
// 連線字典:客戶端連上時會產生唯一 socketId,
// 此字典保存 socketId 到使用者資訊(暱稱等)的映射
var connectionList = {};
exports.startChat = function (io) {
io.sockets.on('connection', function (socket) {
// 客戶端連線時,記錄 socketId 與使用者名
var socketId = socket.id;
connectionList[socketId] = {
socket: socket
};
// 進入聊天室:向其他線上使用者廣播其暱稱
socket.on('join', function (data) {
socket.broadcast.emit('broadcast_join', data);
connectionList[socketId].username = data.username;
});
// 離開聊天室:向其他線上使用者廣播
socket.on('disconnect', function () {
if (connectionList[socketId].username) {
socket.broadcast.emit('broadcast_quit', {
username: connectionList[socketId].username
});
}
delete connectionList[socketId];
});
// 發言:向其他線上使用者廣播內容
socket.on('say', function (data) {
socket.broadcast.emit('broadcast_say', {
username: connectionList[socketId].username,
text: data.text
});
});
})
};
var socket = io.connect('https://localhost');
// 連線完成後,立刻送出 join 事件,把自己的暱稱告訴其他人
socket.emit('join', {
username: 'Username hehe'
});
// 收到有人加入的廣播
socket.on('broadcast_join', function (data) {
console.log(data.username + '加入了聊天室');
});
// 收到有人離開的廣播
socket.on('broadcast_quit', function (data) {
console.log(data.username + '離開了聊天室');
});
// 收到他人訊息
socket.on('broadcast_say', function (data) {
console.log(data.username + '說: ' + data.text);
});
// 假設頁面上有一個 textarea 與一個 .btn-send 按鈕,用 jQuery 綁定
$('.btn-send').click(function (e) {
var text = $('textarea').val();
socket.emit('say', {
username: 'Username hehe',
text: text
});
});
這就是一個可用的聊天室範例,後續可依需求自由擴充。Socket.IO 的核心思想其實非常單純:事件的送出與接收。