這一層是整个專案的基礎,負責提供 html、css、gif、jpg、png、javascript、json、純文字等靜態資源的存取,其中需要一份 MIME 類型的對應表。
mime.js
/** * mime類型的 map * @ author Cheng Liufeng * @ date 2014/8/30 * 當請求靜態服務器文件的類型 html, css, gif, jpg, png, javascript, json, plain text, 我們會在此文件進行映射 */ exports.types = { "css": "text/css", "gif": "image/gif", "html": "text/html", "ico": "image/x-icon", "jpeg": "image/jpeg", "jpg": "image/jpeg", "js": "text/javascript", "json": "application/json", "pdf": "application/pdf", "png": "image/png", "svg": "image/svg+xml", "swf": "application/x-shockwave-flash", "tiff": "image/tiff", "txt": "text/plain", "wav": "audio/x-wav", "wma": "audio/x-ms-wma", "wmv": "video/x-ms-wmv", "xml": "text/xml" };
先釐清從輸入網址到頁面出現之間發生什麼事。使用者在網址列輸入 URL 後,一連串程序隨即展開:先是 DNS 解析把網域名稱轉為 IP 位址,接著瀏覽器與遠端 Web 伺服器透過 TCP 三次握手建立連線——一個同步訊號、一個同步-應答訊號、一個應答訊號,由用戶端發起、伺服器應答接受、用戶端再確認。連線建立後,瀏覽器透過它送出 HTTP GET 請求。
伺服器找到資源後以 HTTP 回應傳回,狀態碼 200 代表正常。用戶端開始下載,內容包含 HTML、CSS、JavaScript 與圖片檔,期間會建立渲染樹與 DOM 樹,並出現 CSS 阻斷與 JS 阻斷。整個流程背後需要一個靜態伺服器支撐,而這裡刻意不用 Express,改以原生方式自行實作。
每一次資源請求本質上就是一次 GET。請求抵達伺服器後,我們可以從中解析出對應的資源路徑,再用檔案讀寫的方式取得內容並回傳。
Node 的檔案讀寫 API 有 readFile 與 readFileSync,但更好的選擇是串流(stream)。用串流的好處是可以搭配快取與 gzip 壓縮。
快取的做法是這樣:用戶端第一次請求時,伺服器讀檔並回傳;第二次請求同一檔案時仍會發出請求,但伺服器會依 Expires、Cache-Control、If-Modified-Since 等 HTTP 標頭判斷資源是否已被快取,若有則不必再存取實體檔案,直接回傳快取內容(或回 304)。
server.js
/** * 聊天室服務端 * 功能:實現了Node版的靜態服務器 * 實現了緩存,gzip壓縮等 * @ author Cheng Liufeng * @ date 2014/8/30 */ // 設置端口號 var PORT = 3000; // 引入模塊 var http = require('http'); var url = require('url'); var fs = require('fs'); var path = require('path'); var zlib = require('zlib'); // 引入文件 var mime = require('./mime').types; var config = require('./config'); var chatServer = require('./utils/chat_server'); var server = http.createServer(function (req, res) { res.setHeader("Server","Node/V8"); // 獲取文件路徑 var pathName = url.parse(req.url).pathname; if(pathName.slice(-1) === "/"){ pathName = pathName + "index.html"; //默認取當前默認下的index.html } // 安全處理(當使用Linux 的 curl命令訪問時,存在安全隱患) var realPath = path.join("client", path.normalize(pathName.replace(/\.\./g, ""))); // 檢查文件路徑是否存在 path.exists(realPath, function(exists) { // 當文件不存在時的情況, 輸出一個404錯誤 if (!exists) { res.writeHead(404, "Not Found", {'Content-Type': 'text/plain'}); res.write("The request url" + pathName +" is not found!"); res.end(); } else { // 當文件存在時的處理邏輯 fs.stat(realPath, function(err, stat) { // 獲取文件擴展名 var ext = path.extname(realPath); ext = ext ? ext.slice(1) : "unknown"; var contentType = mime[ext] || "text/plain"; // 設置 Content-Type res.setHeader("Content-Type", contentType); var lastModified = stat.mtime.toUTCString(); var ifModifiedSince = "If-Modified-Since".toLowerCase(); res.setHeader("Last-Modified", lastModified); if (ext.match(config.Expires.fileMatch)) { var expires = new Date(); expires.setTime(expires.getTime() + config.Expires.maxAge * 1000); res.setHeader("Expires", expires.toUTCString()); res.setHeader("Cache-Control", "max-age=" + config.Expires.maxAge); } if (req.headers[ifModifiedSince] && lastModified == req.headers[ifModifiedSince]) { res.writeHead(304, "Not Modified"); res.end(); } else { // 使用流的方式去讀取文件 var raw = fs.createReadStream(realPath); var acceptEncoding = req.headers['accept-encoding'] || ""; var matched = ext.match(config.Compress.match); if (matched && acceptEncoding.match(/\bgzip\b/)) { res.writeHead(200, "Ok", {'Content-Encoding': 'gzip'}); raw.pipe(zlib.createGzip()).pipe(res); } else if (matched && acceptEncoding.match(/\bdeflate\b/)) { res.writeHead(200, "Ok", {'Content-Encoding': 'deflate'}); raw.pipe(zlib.createDeflate()).pipe(res); } else { res.writeHead(200, "Ok"); raw.pipe(res);
下面是註解掉的傳統讀檔寫法,可讀性較高但不支援串流,故不建議使用:
// fs.readFile(realPath, "binary", function(err, data) { // if(err) { // // file exists, but have some error while read // res.writeHead(500, {'Content-Type': 'text/plain'}); // res.end(err); // } else { // // file exists, can success return // res.writeHead(200, {'Content-Type': contentType}); // res.write(data, "binary"); // res.end(); // } // }); } }); } }); });
監聽 3000 埠:
server.listen(PORT, function() { console.log("Server is listening on port " + PORT + "!"); });
讓 socket.io 與 HTTP 伺服器共用同一個埠:
chatServer.listen(server);
為什麼選 WebSocket?傳統聊天室多以 Ajax 輪詢實作:用戶端每隔一段時間就發一次請求,問伺服器有沒有新訊息,有就回傳。這個模式在空閒時段完全是白跑。
WebSocket 走的是完全不同的路。它基於長連線,一旦建立就持續存在,屬於全雙工通訊,機制上接近發布—訂閱:用戶端訂閱事件,伺服器有新資料就主動推送。
WebSocket 使用 ws 協定而非 http/https。另一個好處是流量大幅降低——如前文所述,傳統每次資源請求都要三次握手,且請求標頭佔用空間不小;而 WebSocket 的溝通標頭很小,大約只有 2 Bytes。
/** * 聊天服務。 */ var socketio = require('socket.io'); var io; var guestNumber = 1; //初始用戶名編號 var nickNames = {}; // 昵稱列表 var namesUsed = []; //使用過的用戶名 var currentRoom = {}; //當前聊天室 function assignGuestName(socket, guestNumber, nickNames, namesUsed) { var name = 'Guest' + guestNumber; nickNames[socket.id] = name; socket.emit('nameResult', { success: true, name: name }); namesUsed.push(name); return guestNumber + 1; } function joinRoom(socket, room) { socket.join(room); currentRoom[socket.id] = room; socket.emit('joinResult', {room: room}); socket.broadcast.to(room).emit('message', { text: nickNames[socket.id] + 'has joined ' + room + '.' }); } function handleMessageBroadcasting(socket) { socket.on('message', function(message) { socket.broadcast.to(message.room).emit('message', { text: nickNames[socket.id] + ':' + message.text }); }); } exports.listen = function(server) { io = socketio.listen(server); io.set('log level', 1); // 定義每個用戶的連接處理 io.sockets.on('connection', function(socket) { // 分配一個用戶名 guestNumber = assignGuestName(socket, guestNumber, nickNames, namesUsed); // 將用戶加入聊天室Lobby裡 joinRoom(socket, 'Lobby'); //處理聊天信息 handleMessageBroadcasting(socket, nickNames); //handleNameChangeAttempts(socket, nickNames, namesUsed); //handleRoomJoining(socket); //handleClientDisconnection(socket, nickNames, namesUsed); }); };
這裡有幾個設計值得留意:assignGuestName 為每條連線配發 Guest1、Guest2…的流水號暱稱;joinRoom 用 socket.join(room) 加入房間,並以 socket.broadcast.to(room) 向同房的「其他人」廣播進場通知;handleMessageBroadcasting 則把訊息轉發給同房其他人。程式中被註解掉的三個函式對應改名、換房與斷線處理,是留給讀者的練習題。
為什麼選 Angular?作為前端 MVC 框架,Angular.js 的模組化、雙向資料綁定、指令系統與依賴注入都相當有吸引力,而且內建 jQuery Lite,熟悉 jQuery 語法的人很容易上手。個人在建構單頁應用(SPA)與 CRUD 專案時,Angular 的優勢尤其明顯,這個聊天室正是以 SPA 為目標。
index.html
<!DOCTYPE html> <html ng-app="chatApp"> <head> <meta name="viewport" content="width=device-width, user-scalable=no"> </head> <body ng-controller="InitCtrl"> <div ng-view></div> <script src="lib/angular.js"></script> <script src="lib/angular-route.js"></script> <script src="lib/socket.io.js"></script> <script src="app.js"></script> <script src="controllers/InitCtrl.js"></script> </body> </html>
單頁應用的原理是什麼?所謂「單頁」並不是全頁面都不刷新。打開 Chrome 開發者工具的 console 就會看到,Angular 內部仍以 Ajax 非同步請求資源,只是更新範圍被限制在局部。但相比過去那種直接刪除、改寫 DOM 節點的做法,這已經是很大的進步。
實作上需要借助 angular-route.js,這個子專案負責定義路由與對應的邏輯處理控制器。
app.js
/** * 客戶端(目前只支持浏覽器,將來會擴展到移動端)程序入口文件 * 創建一個模塊,並且命名為chatApp * 配置路由,實現單頁應用(single page application) */ var chatApp = angular.module("chatApp", ['ngRoute']); // 路由配置 chatApp.config(function($routeProvider) { $routeProvider.when('/', { templateUrl : 'views/init.html', controller: 'InitCtrl' }) .when('/init', { templateUrl : 'views/init.html', controller: 'InitCtrl' }); });
InitCtrl.js
/** * # InitCtrl */ angular.module('chatApp').controller('InitCtrl', function($scope) { var socket = io.connect('https://127.0.0.1:3000'); socket.on('nameResult', function(result) { var message; if (result.success) { message = 'you are now known as ' + result.name + '.'; console.log('message=', message); document.getElementById('guestname').innerHTML = message; } else { message = result.message; } }); socket.on('joinResult', function(result) { document.getElementById('room').innerHTML = result.room; }); $scope.sendMessage = function() { var message = { room: 'Lobby', text: document.getElementById('user_input').value }; socket.emit('message', message); }; socket.on('message', function(message) { var p = document.createElement('p'); p.innerHTML = message.text; document.getElementById('message').appendChild(p); }); });
剛接觸 node.js 時想動手做點東西練功,網上的資料多而雜,繞了不少路,光是除錯就花了一整天。參考他人的文章後重寫了部分程式碼——原本的例子基於 node-websocket-server 框架,這裡則完全不用框架,只靠 socket.io。
基本功能
1、使用者隨意輸入暱稱即可登入。
2、登入成功後:對新進使用者,列出所有在線使用者與最近的歷史聊天紀錄;對已登入使用者,通知有新成員進入並更新在線名單。
3、支援直接登出;有人離開時,其他在線使用者會收到通知並同步更新名單。
4、聊天即廣播,把訊息送給所有連線中的使用者。
5、對系統邏輯錯誤、網路異常等情況做了簡單的錯誤提示。
已知問題:功能尚不完整,仍有 bug(使用者登出後,新使用者重新登入仍會沿用舊名),待後續修正。
技術說明
socket.io(官網:https://socket.io/)是一套跨平台、能自動在多種連線方式間切換的函式庫,做即時通訊開發相當方便,也能與 Express 提供的傳統請求方式良好整合——也就是說,可以在同一個網域、同一個埠同時提供 request/response 與 websocket(flashsocket、ajax 等)兩種連線方式。
延伸參考:socket.io 使用詳解 https://www.jb51.net/article/71361.htm 、《用 node.js 和 Websocket 做個多人聊天室吧》https://www.html5china.com/HTML5features/WebSocket/20111206_3096.html
(1)客戶端載入 socket.io.js
寫成這樣可能載入失敗(這裡卡了我不少時間):
<script src="/socket.io/socket.io.js"></script>
可改為明確指定位址:
<script src="https://ip:port/socket.io/socket.io.js"></script>
其中 ip 與 port 換成實際的伺服器位址,例如 localhost 與 80。
(2)廣播寫法無效
照官網範例寫卻不起作用:
var io = require('socket.io').listen(80); io.sockets.on('connection', function (socket) { socket.broadcast.emit('user connected'); socket.broadcast.json.send({ a: 'message' }); });
參考 Stack Overflow 上的討論(https://stackoverflow.com/questions/7352164/update-all-clients-using-socket-io)後,改成下面這樣才正常:
io.sockets.emit('users_count', clients);




在命令列執行:
node main.js
然後在瀏覽器中開啟 index.html。若瀏覽器(Firefox、Chrome)不支援,請升級到支援 WebSocket 的版本。開發工具方面推薦 WebStorm。
最後補充一點:本文程式碼寫於 2014 年,其中的 path.exists() 已被 fs.exists() 取代並在後續版本標記為過時,io.set('log level', 1)、socketio.listen(server) 等 API 在 socket.io 1.x 之後也已改寫。若要在現今環境運行,建議改用 Express 或原生 http 搭配 fs.stat 的非同步判斷,並以 socket.io 4.x 的 new Server(server, options) 寫法取代。