安裝好 Node.js 之後,在機器上建立一個目錄,就能開始你的第一個 Express 應用程式了。
$ mkdir hello-world
在這個目錄中,你將定義應用程式的「套件」,這和任何 Node 套件沒有不同。透過 package.json 明確定義依賴項,你可以用 npm 取得 Express 的最新版本;建議指定 "3.x" 而非固定版本,以免遭遇未知變動:
{
"name": "hello-world",
"description": "hello world test app",
"version": "0.0.1",
"private": true,
"dependencies": {
"express": "3.x"
}
}
有了 package.json 後,即可用 npm 安裝依賴:
$ npm install
npm 完成後,你就會在 node_modules 目錄中擁有 Express 及其依賴。可用 npm ls 驗證這棵依賴樹。
建立應用程式
建立一個名為 app.js 或 server.js 的檔案,引入 express 並建立新的應用程式:
var express = require('express');
var app = express();
新的應用程式實例可透過 app.VERB() 開始定義路由。以下範例針對 GET /hello.txt 請求回應 Hello World。req 與 res 是 Node 原生物件,Express 在其基礎上提供了 res.send() 等更高層的介面,並會自動加上內容長度:
app.get('/hello.txt', function(req, res){
res.send('Hello World');
});
接著呼叫 app.listen() 綁定並監聽埠口:
var server = app.listen(3000, function() {
console.log('Listening on port %d', server.address().port);
});
使用 express 命令列工具產生應用程式
Express 團隊維護了一個專案產生器 express-generator。若用 npm 全域安裝,便能從任何地方呼叫:
$ npm install -g express-generator
這個工具能快速產生應用程式骨架(支援 ejs、hogan 等模板引擎與多種樣式表)。執行 express myapp 即可產生含 app.js、路由、視圖與靜態資源的完整結構,接著安裝依賴並啟動:
$ cd myapp && npm install $ npm start
要記住,Express 並不綁定特定的目錄結構,這些只是引導性的建議。
錯誤處理
錯誤處理中間件的定義方式與普通中間件類似,但必須有四個參數,函式簽名為 (err, req, res, next):
app.use(function(err, req, res, next){
console.error(err.stack);
res.send(500, 'Something broke!');
});
錯誤處理中間件通常定義在其它 app.use() 之後。回應內容完全自由——可以是 HTML 錯誤頁、簡單訊息、JSON 字串等。你也定義多個錯誤處理中間件來構建更有組織的框架。例如為 XHR 請求定義專屬的錯誤處理器:
var bodyParser = require('body-parser');
var methodOverride = require('method-override');
app.use(bodyParser());
app.use(methodOverride());
app.use(app.router);
app.use(logErrors);
app.use(clientErrorHandler);
app.use(errorHandler);
// 記錄錯誤到 stderr
function logErrors(err, req, res, next) {
console.error(err.stack);
next(err);
}
// 針對 XHR 請求回應錯誤
function clientErrorHandler(err, req, res, next) {
if (req.xhr) {
res.send(500, { error: 'Something blew up!' });
} else {
next(err);
}
}
// 全方位錯誤處理
function errorHandler(err, req, res, next) {
res.status(500);
res.render('error', { error: err });
}
線上人數計數範例
以下用 Redis 追蹤線上人數。首先在 package.json 中加入 redis 與 express 依賴,並確保已安裝 Redis 且透過 redis-server 運行:
{
"name": "app",
"version": "0.0.1",
"dependencies": {
"express": "3.x",
"redis": "*"
}
}
建立應用程式與 Redis 連線:
var express = require('express');
var redis = require('redis');
var db = redis.createClient();
var app = express();
接著用中間件追蹤線上使用者。這裡使用排序集(sorted set),以時間戳作為「在線標準」,讓查詢能在毫秒級完成(範例以 user-agent 字串代替使用者 id):
app.use(function(req, res, next){
var ua = req.headers['user-agent'];
db.zadd('online', Date.now(), ua, next);
});
下一個中間件用 zrevrangebyscore 取得最近 60 秒內的活躍使用者:
app.use(function(req, res, next){
var min = 60 * 1000;
var ago = Date.now() - min;
db.zrevrangebyscore('online', '+inf', ago, function(err, users){
if (err) return next(err);
req.online = users;
next();
});
});
最後透過一個路由使用它並綁定埠口:
app.get('/', function(req, res){
res.send(req.online.length + ' users online');
});
app.listen(3000);
反向代理與除錯
在 Varnish 或 Nginx 等反向代理背後使用 Express 時,可啟用「信任代理」設定 app.enable("trust proxy"),讓 Express 信任 X-Forwarded-* 標頭。啟用後,req.protocol 會反映 X-Forwarded-Proto(http 或 https),req.ip 與 req.ips 則會填入 X-Forwarded-For 的位址列表。
Express 內部使用 debug 模組記錄路由匹配等資訊。要查看這些訊息,只需把 debug 環境變數設為 express:*:
$ DEBUG=express:* node ./bin/www
運行後,你便能在控制台看到諸如路由定義的除錯訊息。此外,由產生器建立的程式也使用 debug 模組,預設作用域為 my-application,可用 $ DEBUG=my-application node ./bin/www 啟用。
掌握以上內容,你便能在實際專案中靈活運用 Express——從建立路由、錯誤處理,到整合 Redis 做即時統計、配置反向代理與除錯,都能得心應手。