1. 程式人生 > >nodejs+mongodb系列教程之(3/5)--理解路由和中介軟體

nodejs+mongodb系列教程之(3/5)--理解路由和中介軟體

   

一、路由

路由是指如何定義應用的端點(URIs)以及如何響應客戶端的請求。

路由是由一個 URI、HTTP 請求(GET、POST等)和若干個控制代碼組成,它的結構如下: app.METHOD(path, [callback...], callback)appexpress 物件的一個例項, METHOD 是一個HTTP請求方法,path 是伺服器上的路徑,callback 是當路由匹配時要執行的函式。路由的使用一般有兩種方式,第一種就是直接將路由掛載在app上如下面的示例:

var express = require('express');
var app = express();

app.get('/', function(req, res) {
  res.send('hello world');
});

還有一種就是將路由掛載到路由中介軟體上,然後將路由中介軟體掛載到app上。用express.Router 類建立模組化、可掛載的路由控制代碼。Router 例項是一個完整的中介軟體和路由系統,因此常稱其為一個 “mini-app”。

下面的例項程式建立了一個路由模組,並載入了一箇中間件,定義了一些路由,並且將它們掛載至應用的路徑上。

在 app 目錄下建立名為 status.js 的檔案,內容如下:

var express = require('express'
); var router = express.Router(); // 定義網站主頁的路由 router.get('/', function(req, res) { res.send('status home page'); }); // 定義 about 頁面的路由 router.get('/about', function(req, res) { res.send('About status'); }); module.exports = router;
然後在應用中載入路由模組:
var birds = require('./status');
app.use('/status', status
);

應用即可處理髮自 /status/status/about 的請求,一般我個人喜歡用第二種方式。

路由方法

路由方法源於 HTTP 請求方法,和 express 例項相關聯。

下面這個例子展示了為應用跟路徑定義的 GET 和 POST 請求:

// GET method route
app.get('/', function (req, res) {
  res.send('GET request to the homepage');
});

// POST method route
app.post('/', function (req, res) {
  res.send('POST request to the homepage');
});

Express 定義瞭如下和 HTTP 請求對應的路由方法: get, post, put,head,delete, options, trace,copy, lock, mkcol, move, purge, propfind,proppatch, unlock,report, mkactivity,checkout, merge,m-search, notify,subscribe, unsubscribe,patch, search, 和connect

app.all() 是一個特殊的路由方法,沒有任何 HTTP 方法與其對應,它的作用是對於一個路徑上的所有請求載入中介軟體。

在下面的例子中,來自 “/secret” 的請求,不管使用 GET、POST、PUT、DELETE 或其他任何 http模組支援的 HTTP 請求,控制代碼都會得到執行。

app.all('/secret', function (req, res, next) {
  console.log('Accessing the secret section ...');
  next(); // pass control to the next handler
});

路由路徑

路由路徑和請求方法一起定義了請求的端點,它可以是字串、字串模式或者正則表示式。
使用字串的路由路徑示例:
// 匹配根路徑的請求
app.get('/', function (req, res) {
  res.send('root');
});

// 匹配 /about 路徑的請求
app.get('/about', function (req, res) {
  res.send('about');
});

// 匹配 /random.text 路徑的請求
app.get('/random.text', function (req, res) {
  res.send('random.text');
});

使用字串模式的路由路徑示例:
// 匹配 acd 和 abcd
app.get('/ab?cd', function(req, res) {
  res.send('ab?cd');
});

// 匹配 abcd、abbcd、abbbcd等
app.get('/ab+cd', function(req, res) {
  res.send('ab+cd');
});

// 匹配 abcd、abxcd、abRABDOMcd、ab123cd等
app.get('/ab*cd', function(req, res) {
  res.send('ab*cd');
});

// 匹配 /abe 和 /abcde
app.get('/ab(cd)?e', function(req, res) {
 res.send('ab(cd)?e');
});

使用正則表示式(符 ?、+、* 和 () 是正則表示式的子集,- 和 . 在基於字串的路徑中按照字面值解釋。)的路由路徑示例:
// 匹配任何路徑中含有 a 的路徑:
app.get(/a/, function(req, res) {
  res.send('/a/');
});

// 匹配 butterfly、dragonfly,不匹配 butterflyman、dragonfly man等
app.get(/.*fly$/, function(req, res) {
  res.send('/.*fly$/');
});

路由控制代碼

可以為請求處理提供多個回撥函式,其行為類似中介軟體。唯一的區別是這些回撥函式有可能呼叫 next('route') 方法而略過其他路由回撥函式。可以利用該機制為路由定義前提條件,如果在現有路徑上繼續執行沒有意義,則可將控制權交給剩下的路徑。

路由控制代碼有多種形式,可以是一個函式、一個函式陣列,或者是兩者混合,如下所示.

使用一個回撥函式處理路由:


app.get('/example/a', function (req, res) {
  res.send('Hello from A!');
});

使用多個回撥函式處理路由(記得指定 next 物件):
app.get('/example/b', function (req, res, next) {
  console.log('response will be sent by the next function ...');
  next();
}, function (req, res) {
  res.send('Hello from B!');
});

使用回撥函式陣列處理路由:
var cb0 = function (req, res, next) {
  console.log('CB0');
  next();
}

var cb1 = function (req, res, next) {
  console.log('CB1');
  next();
}

var cb2 = function (req, res) {
  res.send('Hello from C!');
}

app.get('/example/c', [cb0, cb1, cb2]);

混合使用函式和函式陣列處理路由:
var cb0 = function (req, res, next) {
  console.log('CB0');
  next();
}

var cb1 = function (req, res, next) {
  console.log('CB1');
  next();
}

app.get('/example/d', [cb0, cb1], function (req, res, next) {
  console.log('response will be sent by the next function ...');
  next();
}, function (req, res) {
  res.send('Hello from D!');
});

響應方法

下表中響應物件(res)的方法向客戶端返回響應,終結請求響應的迴圈。如果在路由控制代碼中一個方法也不呼叫,來自客戶端的請求會一直掛起。


二、中介軟體



應用級中介軟體

應用級中介軟體繫結到 app 物件 使用 app.use() 和 app.METHOD(),其中, METHOD 是需要處理的 HTTP 請求的方法,例如 GET, PUT, POST 等等,全部小寫。例如:
var app = express();

// 沒有掛載路徑的中介軟體,應用的每個請求都會執行該中介軟體
app.use(function (req, res, next) {
  console.log('Time:', Date.now());
  next();
});

// 掛載至 /user/:id 的中介軟體,任何指向 /user/:id 的請求都會執行它
app.use('/user/:id', function (req, res, next) {
  console.log('Request Type:', req.method);
  next();
});

// 路由和控制代碼函式(中介軟體系統),處理指向 /user/:id 的 GET 請求
app.get('/user/:id', function (req, res, next) {
  res.send('USER');
});
下面這個例子展示了在一個掛載點裝載一組中介軟體。
// 一箇中間件棧,對任何指向 /user/:id 的 HTTP 請求打印出相關資訊
app.use('/user/:id', function(req, res, next) {
  console.log('Request URL:', req.originalUrl);
  next();
}, function (req, res, next) {
  console.log('Request Type:', req.method);
  next();
});

作為中介軟體系統的路由控制代碼,使得為路徑定義多個路由成為可能。在下面的例子中,為指向 /user/:id 的 GET 請求定義了兩個路由。第二個路由雖然不會帶來任何問題,但卻永遠不會被呼叫,因為第一個路由已經終止了請求-響應迴圈。


// 一箇中間件棧,處理指向 /user/:id 的 GET 請求
app.get('/user/:id', function (req, res, next) {
  console.log('ID:', req.params.id);
  next();
}, function (req, res, next) {
  res.send('User Info');
});

// 處理 /user/:id, 打印出使用者 id
app.get('/user/:id', function (req, res, next) {
  res.end(req.params.id);
});

如果需要在中介軟體棧中跳過剩餘中介軟體,呼叫 next('route') 方法將控制權交給下一個路由。注意: next('route') 只對使用 app.VERB() 或 router.VERB() 載入的中介軟體有效。
// 一箇中間件棧,處理指向 /user/:id 的 GET 請求
app.get('/user/:id', function (req, res, next) {
  // 如果 user id 為 0, 跳到下一個路由
  if (req.params.id == 0) next('route');
  // 否則將控制權交給棧中下一個中介軟體
  else next(); //
}, function (req, res, next) {
  // 渲染常規頁面
  res.render('regular');
});

// 處理 /user/:id, 渲染一個特殊頁面
app.get('/user/:id', function (req, res, next) {
  res.render('special');
});

路由級中介軟體

路由級中介軟體和應用級中介軟體一樣,只是它繫結的物件為 express.Router()
var router = express.Router();

路由級使用 router.use() 或 router.VERB() 載入。

上述在應用級建立的中介軟體系統,可通過如下程式碼改寫為路由級:


var app = express();
var router = express.Router();

// 沒有掛載路徑的中介軟體,通過該路由的每個請求都會執行該中介軟體
router.use(function (req, res, next) {
  console.log('Time:', Date.now());
  next();
});

// 一箇中間件棧,顯示任何指向 /user/:id 的 HTTP 請求的資訊
router.use('/user/:id', function(req, res, next) {
  console.log('Request URL:', req.originalUrl);
  next();
}, function (req, res, next) {
  console.log('Request Type:', req.method);
  next();
});

// 一箇中間件棧,處理指向 /user/:id 的 GET 請求
router.get('/user/:id', function (req, res, next) {
  // 如果 user id 為 0, 跳到下一個路由
  if (req.params.id == 0) next('route');
  // 負責將控制權交給棧中下一個中介軟體
  else next(); //
}, function (req, res, next) {
  // 渲染常規頁面
  res.render('regular');
});

// 處理 /user/:id, 渲染一個特殊頁面
router.get('/user/:id', function (req, res, next) {
  console.log(req.params.id);
  res.render('special');
});

// 將路由掛載至應用
app.use('/', router);

錯誤處理中介軟體

錯誤處理中介軟體有 4 個引數,定義錯誤處理中介軟體時必須使用這 4 個引數。即使不需要 next 物件,也必須在簽名中宣告它,否則中介軟體會被識別為一個常規中介軟體,不能處理錯誤。
錯誤處理中介軟體和其他中介軟體定義類似,只是要使用 4 個引數,而不是 3 個,其簽名如下: (err, req, res, next)
app.use(function(err, req, res, next) {
  console.error(err.stack);
  res.status(500).send('Something broke!');
});

第三方中介軟體

通過使用第三方中介軟體從而為 Express 應用增加更多功能。

安裝所需功能的 node 模組,並在應用中載入,可以在應用級載入,也可以在路由級載入。

下面的例子安裝並載入了一個解析 cookie 的中介軟體: cookie-parser


$ npm install cookie-parser
var express = require('express');
var app = express();
var cookieParser = require('cookie-parser');

// 載入用於解析 cookie 的中介軟體
app.use(cookieParser());