因緣際會下接觸到一個專案需求,於是深入研究 Node.js 搭配 WebSocket 的實作方式,而 socket.io 正是 Node.js 後端應用 WebSocket 時最廣泛採用的框架。本文就來動手做一個「多人同時在線、彼此能看到對方滑鼠游標移動」的小遊戲。
1. 安裝 socket.io,指令為 npm install socket.io。
2. 若使用 Windows 系統,需要具備 VC 編譯環境,因為安裝 socket.io 時會編譯一段 VC 程式碼。
整個小遊戲的運作邏輯可以拆解成五個步驟:
1. 伺服器持續監聽客戶端的連線。
2. 客戶端連線成功後,綁定頁面的滑鼠移動事件,在事件中把當前座標傳送給伺服器。
3. 伺服器維護一個全域座標物件,並以客戶端的唯一編號作為鍵值。
4. 當有新連線進來時,把現有座標廣播給其他所有客戶端。
5. 客戶端斷線時,伺服器刪除對應座標,並再次廣播通知其他人。
建立 socket.io 伺服器時必須依賴一個 HTTP 連線來處理協議升級,因此也要引入 http 模組:
var http = require('http'),
io = require('socket.io');
var app = http.createServer().listen(9091);
var ws = io.listen(app);
接著宣告一個全域座標物件:
var postions = {};
開始監聽客戶端連線,並自行定義廣播函式(其實也可以直接用 socket.io 內建的 io.sockets.broadcast.emit),核心程式碼如下:
ws.on('connection', function (client) {
// 廣播函式
var broadcast = function (msg, cl) {
for (var k in ws.sockets.sockets) {
if (ws.sockets.sockets.hasOwnProperty(k)) {
if (ws.sockets.sockets[k] && ws.sockets.sockets[k].id != cl.id) {
ws.sockets.sockets[k].emit('position.change', msg);
}
}
}
};
console.log('\033[92m有新的連線來:\033[39m', postions);
// 客戶端連線成功後,先送出其他客戶端目前的座標
client.emit('position.change', postions);
// 接收客戶端傳來的消息
client.on('position.change', function (msg) {
postions[client.id] = msg;
broadcast({
type: 'position',
postion: msg,
id: client.id
}, client);
});
// 接收客戶端關閉連線
client.on('close', function () {
console.log('close!');
delete postions[client.id];
broadcast({ type: 'disconnect', id: client.id }, client);
});
// 客戶端斷線
client.on('disconnect', function () {
console.log('disconnect!');
delete postions[client.id];
broadcast({ type: 'disconnect', id: client.id }, client);
});
// 客戶端異常處理
client.on('error', function (err) {
console.log('error->', err);
});
});
仔細分析這段程式碼,關鍵點在於:新客戶端連線時先補送既有座標、客戶端更新座標時通知其他人、客戶端斷線時通知其他人,而廣播的訊息類型則區分為「修改座標」與「移除座標」兩種。
由於 socket.io 屬於自訂框架,客戶端必須引入 socket.io.js。這個檔案可以在 socket.io 模組中找到,路徑通常為 node_modules\socket.io\node_modules\socket.io-client\dist,裡面有合併版與壓縮版,開發階段建議使用合併版方便除錯。
完整程式碼如下:
<!DOCTYPE html>
<html>
<head>
<title>socket.io 多人同時在線互動 例子</title>
<meta charset="utf-8">
</head>
<body>
<script type="text/javascript" src="socket.io.js"></script>
<script type="text/javascript">
var ws = io.connect('https://localhost:9091/');
var isfirst;
ws.on('connect', function () {
// 開始綁定 mousemove 事件
document.onmousemove = function (ev) {
if (ws.socket.transport.isOpen) {
ws.emit('position.change', { x: ev.clientX, y: ev.clientY });
}
}
})
ws.on('position.change', function (data) {
if (!isfirst) {
isfirst = true;
// 第一條訊息是其他所有客戶端的座標
for (var i in data) {
move(i, data[i]);
}
} else {
// 否則就是斷線或更新座標的訊息
if ('position' == data.type) {
move(data.id, data.postion);
} else {
remove(data.id);
}
}
})
ws.on('error', function () {
ws.disconnect();
})
function move(id, pos) {
var ele = document.querySelector('#cursor_' + id);
if (!ele) {
ele = document.createElement('img');
ele.id = 'cursor_' + id;
ele.src = 'img/cursor.png';
ele.style.position = 'absolute';
document.body.appendChild(ele);
}
ele.style.left = pos.x + 'px';
ele.style.top = pos.y + 'px';
}
function remove(id) {
var ele = document.querySelector('#cursor_' + id);
ele.parentNode.removeChild(ele);
}
</script>
</body>
</html>
畫面中的 img/cursor.png 是一張游標圖示,網路上能找到不少這類素材。前端邏輯其實相當單純,歸納如下:
1. 連線成功時綁定 mousemove 事件,負責送出新的座標訊息。
2. 收到訊息後依類型判斷,是更新其他客戶端座標,還是移除對應游標。
3. 定義新增與移除游標圖示的函式。
4. 處理異常訊息並主動斷線,讓伺服器得以清除該客戶端的座標。
1. 將伺服器程式存為 io_multigame.js。
2. 將客戶端程式存為 io_multigame.html。
3. 執行 node io_multigame.js 啟動伺服器。
4. 開啟多個 io_multigame.html 頁面,即可看到彼此游標同步移動的效果。
這篇寫得比較隨性,靈感參考自《了不起的 Node.js》一書,這是本相當不錯的好書,想深入了解 Node.js 的朋友不妨找來讀讀。