路由
路由是指如何定義應用程式的端點(URIs)以及如何回應客戶端的請求。
路由是由一個URI、HTTP 請求(GET、POST等)和若干個句柄組成,它的結構如下: app.METHOD(path, [callback...], callback),app 是express 物件的一個實例, METHOD 是一個HTTP 請求方法, path 是伺服器上的路徑, callback 是當路由匹配時要執行的函數。
以下是一個基本的路由範例:
var express = require('express'); var app = express(); // respond with "hello world" when a GET request is made to the homepage app.get('/', function(req, res) { res.send('hello world'); });
路由方法
路由方法源自於 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, move , merge, m-search, notify, subscribe, unsubscribe, patch, search, 和connect。
有些路由方法名稱不是合規的 JavaScript 變數名,此時使用括號記法,例如: app['m-search']('/', function ...
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 });
路由路徑
路由路徑和請求方法一起定義了請求的端點,它可以是字串、字串模式或正規表示式。
Express 使用 path-to-regexp 符合路由路徑,請參考文件查閱所有定義路由路徑的方法。 Express Route Tester 是測試基本 Express 路徑的好工具,但不支援模式匹配。
查詢字串不是路由路徑的一部分。
使用字串的路由路徑範例:
// 匹配根路径的请求 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)的方法向客戶端回傳回應,終結請求回應的循環。如果在路由句柄中一個方法也不調用,來自客戶端的請求會一直掛起。