DIV CSS 佈局教程網

Node.js + WebSocket 即時聊天室實作教學(socket.io)
編輯:JavaScript綜合知識     

手上的專案需要一個聊天功能,而且是即時的那種,於是想到了這幾年一直很紅的 WebSocket。折騰一天之後整理出以下流程。

WebSocket 是 HTML5 的通信協議,支援雙向即時溝通。本例使用 socket.io 這個框架,它把 WebSocket 與 xhr-polling(長輪詢)等多種通信方式整合在一起,並會依瀏覽器能力自動選擇可用方案。

1. 建立 Node 環境

到 Node 官網下載安裝檔(Windows 可選 msi 一鍵安裝)。安裝完成後,記得把 Node 的路徑加入系統環境變數 PATH,否則命令列找不到 node 與 npm。

2. 安裝 socket.io

npm install -g socket.io

或者從官網下載檔案,手動放進 node_modules 目錄。

3. 服務端:server.js

/* modules 引入 */
var express = require('express'),
    sio     = require('socket.io'),
    fs      = require('fs'),
    path    = require('path'),
    url     = require('url');

//========================= app 配置 =========================
var app = module.exports = express.createServer();

//================= 配置 socket.io =========================
var io = sio.listen(app);
io.configure(function () {
  // io.set("transports", ["websocket"]);
});

//=================== socket 連結監聽 ===================
io.sockets.on('connection', function (socket) {
  // 公共訊息
  socket.on('public message', function (msg, fn) {
    socket.broadcast.emit('public message', msg);
    fn(true);
  });

  // 掉線、斷開連結處理
  socket.on('disconnect', function () {
    socket.broadcast.emit('public message', '<span style="color: red;">斷開連接。。。</span>');
  });
});

app.listen(3000, function () {
  var addr = app.address();
  console.log('app listening on https://127.0.0.1:' + addr.port);
});

這裡有兩個重點:socket.broadcast.emit 會把訊息送給除自己以外的所有連線(這正是聊天室想要的行為),而 fn(true) 是透過 socket.io 的 acknowledgement 機制回報「伺服器已收到」,讓前端能同步顯示自己的訊息。

4. 客戶端:chat.html

<script type="text/javascript">
// <![CDATA[
$(function(){
  var socket = io.connect('https://localhost:3000'); // 開始連接服務器

  socket.on('connect', function(){
    $('#connecting').fadeOut();
    show('連接服務器成功');
  });

  // 接收 public message
  socket.on('public message', function(msg){
    show(msg);
  });

  $('#btn').click(function(){
    var msg = $('#content').val();
    // 發送公共訊息
    socket.emit('public message', msg, function(ok){
      if (ok) { show(msg); }
    });
  });
});

function show(msg){
  var htm = "<div class='message'>" + msg + "</div>";
  $('#main').append(htm);
}
// ]]>
</script>

<div id="main">
  <div id="connecting">正在連接服務器..</div>
</div>
<div id="send">
  <input id="content" type="text" />
  <button id="btn">發送</button>
</div>

5. 啟動與驗證

先啟動服務端:

node server.js

再由瀏覽器打開 chat.html(例如 https://localhost/.../chat.html),多開幾個視窗即可看到訊息同步。

從 Node 服務器端也能看到連線記錄:

當時 Firefox 對 WebSocket 支援度不如 Chrome,會退回 xhr-polling;Chrome 則走標準 WebSocket。這是 socket.io 自動降級的價值所在——你不必為每個瀏覽器寫不同的實作。

幾點必要提醒

1. 這份程式碼用的是非常早期的 API。express.createServer()、sio.listen(app)、io.configure() 都是 2011 年前後的寫法,在現今的 Express 4/5 與 socket.io v4 上完全跑不起來。現代寫法大致如下:

const express = require('express');
const http    = require('http');
const { Server } = require('socket.io');

const app = express();
const server = http.createServer(app);
const io = new Server(server);

io.on('connection', (socket) => {
  socket.on('public message', (msg, ack) => {
    socket.broadcast.emit('public message', msg);
    if (typeof ack === 'function') ack(true);
  });
  socket.on('disconnect', () => {
    socket.broadcast.emit('public message', '使用者已離線');
  });
});

server.listen(3000, () => console.log('https://localhost:3000'));

2. show() 用 innerHTML 拼接訊息會有 XSS 風險。聊天室是最容易被插入腳本的場景之一,使用者輸入 <img src=x onerror=...> 就會直接執行。請改用 textContent,或在插入前先做轉义。

3. 版本相容性已不再是問題。「那時不建議用 WebSocket」的結論是 2012 年的狀況;今天所有主流瀏覽器都完整支援,socket.io 也穩定在 v4,做即時功能是很正常的選擇。

4. 記得處理心跳與重連。socket.io 預設會自動重連,但連線斷 YOUR 期間的訊息不會補送。若聊天記錄不能遺漏,需要自己在服務端保存歷史,並在 connect 時補發。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved