用輪詢做聊天總是有延遲,真正的即時通訊要靠 WebSocket——一條長連線建立之後,伺服器可以主動推送訊息給客戶端,不必再反覆詢問「有沒有新東西」。
nodejs-websocket 是一個用 Node.js 實作 WebSocket 協議的函式庫,專案網址:https://github.com/sitegui/nodejs-websocket 。
安裝:在專案目錄下執行
npm install nodejs-websocket
建立伺服器:
// 引入 nodejs-websocket
var ws = require("nodejs-websocket");
// createServer 的回呼參數 conn 就是 connection 實例
var server = ws.createServer(function (conn) {
console.log("New connection");
// text 事件:每當收到文字型資料時觸發,參數為字串
conn.on("text", function (str) {
console.log("Received " + str);
});
// close 事件:連線中斷時觸發
conn.on("close", function (code, reason) {
console.log("Connection closed");
});
}).listen(8888);
瀏覽器端不需要任何函式庫,先建立一個 WebSocket 物件:
ws = new WebSocket("ws://localhost:5000");
URL 的格式是 ws:// 加上位址,就像 http 前面的 https:// 一樣(若頁面走 HTTPS,則要改用 wss://)。四個主要事件:
・onopen:連線建立完成
・onmessage:收到伺服器推送的資料
・onclose:連線關閉
・onerror:連線發生錯誤
客戶端:
oConnect.onclick = function () {
ws = new WebSocket('ws://localhost:5000');
ws.onopen = function () {
oUl.innerHTML += "<li>客戶端已連接</li>";
};
ws.onmessage = function (evt) {
oUl.innerHTML += "<li>" + evt.data + "</li>";
};
ws.onclose = function () {
oUl.innerHTML += "<li>客戶端已斷開連接</li>";
};
ws.onerror = function (evt) {
oUl.innerHTML += "<li>" + evt.data + "</li>";
};
};
oSend.onclick = function () {
if (ws) {
ws.send(oInput.value);
}
};
伺服器端:
/* WebSocket 支援兩種資料傳輸型別:text 與 binary,
二進位資料是以串流模式傳送與讀取的 */
var app = require('http').createServer(handler); // 用來提供 HTML 頁面
var ws = require('nodejs-websocket');
var fs = require('fs');
app.listen(8888);
// 對 8888 端口的請求回應 index.html
function handler(req, res) {
// __dirname 回傳目前檔案所在目錄
fs.readFile(__dirname + '/index.html', function (err, data) {
if (err) {
res.writeHead(500);
return res.end('error');
}
res.writeHead(200);
res.end(data);
});
}
// WebSocket 服務監聽在 5000 端口,與網頁伺服器分開
var server = ws.createServer(function (conn) {
console.log('new connection');
conn.on("text", function (str) {
broadcast(server, str);
});
conn.on("close", function (code, reason) {
console.log('connection closed');
});
}).listen(5000);
// 群播:把訊息送給每一個已連線的客戶端
function broadcast(server, msg) {
// server.connections 是包含所有連線的陣列
server.connections.forEach(function (conn) {
conn.sendText(msg);
});
}
這個範例刻意用了兩個埠:8888 負責提供網頁,5000 負責 WebSocket 連線。實務上兩者可以合併到同一個 HTTP 伺服器上(WebSocket 的握手本身就是一次 HTTP Upgrade 請求),但分開寫更容易看出各自的職責。
另外要留意,範例中的 oUl.innerHTML += 直接把訊息內容插入 HTML,這存在 XSS 風險。正式環境請改用 textContent,或先對內容做轉義處理。
最後,訊息廣播的機制是「伺服器收到任何訊息就送給所有人」。若要實作私聊或房間,就需要在連線物件上附加使用者資訊,並在 broadcast 時依條件篩選對象。