Express 文檔（路由）

路由

路由是指應用程序的端點（URI）如何響應客戶端請求，有關路由的介紹，請參閱路由基礎。

使用與HTTP方法相對應的Express app對象的方法定義路由，例如，app.get()用於處理GET請求，app.post()用於處理POST請求，有關完整列表，請參閱app.METHOD。你還可使用app.all()來處理全部HTTP方法，並使用app.use()將中間件指定爲回調函數（有關詳細信息，請參閱使用中間件）。

這些路由方法指定當應用程序收到對指定路由（端點）和HTTP方法的請求時調用的回調函數（有時稱爲「處理函數」），換句話說，應用程序「監聽」與指定路由和方法匹配的請求，而且當它檢測到匹配時，它調用指定的回調函數。

實際上，路由方法能夠有多個回調函數做爲參數，使用多個回調函數時，重要的是提供next做爲回調函數的參數，而後在函數體內調用next()以將控制權交給下一個回調。

如下代碼是一個很是基礎的路由示例。

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等，有關完整列表，請參閱app.METHOD。

有一種特殊的路由方法app.all()，用於在路徑上爲全部HTTP請求方法加載中間件函數，例如，不管是使用GET、POST、PUT、DELETE仍是http模塊支持的任何其餘HTTP請求方法，都會對路由「/secret」的請求執行如下處理程序。

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

路由路徑

路由路徑與請求方法結合，定義能夠發出請求的端點，路由路徑能夠是字符串、字符串模式或正則表達式。

字符?、+、*和()是它們的正則表達式對應物的子集，連字符（-）和點（.）由字符串路徑按字面解釋。

若是你須要在路徑字符串中使用美圓字符（$），請將其包含在([和])中，例如，「/data/$book」處的請求的路徑字符串將是「/data/([\$])book」。

Express使用 path-to-regexp來匹配路由路徑，有關定義路由路徑的全部可能性，請參閱 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、abRANDOMcd、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、dragonflyman等相匹配。

app.get(/.*fly$/, function (req, res) {
  res.send('/.*fly$/')
})

路由參數

路由參數是命名的URL片斷，用於捕獲在URL中的位置指定的值，捕獲的值填充在req.params對象中，在路徑中指定的路由參數的名稱做爲其各自的鍵。

Route path: /users/:userId/books/:bookId
Request URL: http://localhost:3000/users/34/books/8989
req.params: { "userId": "34", "bookId": "8989" }

要使用路由參數定義路由，只需在路由路徑中指定路由參數，以下所示。

app.get('/users/:userId/books/:bookId', function (req, res) {
  res.send(req.params)
})

路由參數的名稱必須由「單詞字符」（[A-Za-z0-9_]）組成。

因爲連字符（-）和點（.）按字面解釋，所以它們能夠與路由參數一塊兒使用以用於有用的目的。

Route path: /flights/:from-:to
Request URL: http://localhost:3000/flights/LAX-SFO
req.params: { "from": "LAX", "to": "SFO" }

Route path: /plantae/:genus.:species
Request URL: http://localhost:3000/plantae/Prunus.persica
req.params: { "genus": "Prunus", "species": "persica" }

要更好地控制路由參數能夠匹配的確切字符串，能夠在括號（()）中附加正則表達式：

Route path: /user/:userId(\d+)
Request URL: http://localhost:3000/user/42
req.params: {"userId": "42"}

由於正則表達式一般是文字字符串的一部分，因此請務必使用額外的反斜槓轉義任何 \字符，例如 \\d+。

在Express 4.x中，正則表達式中的*字符不以一般的方式解釋，要解決此問題，請使用{0,}而不是*，這可能會在Express 5中修復。

路由處理程序

你能夠提供多個回調函數，其行爲相似於中間件來處理請求，惟一的例外是這些回調可能會調用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('the 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('the response will be sent by the next function ...')
  next()
}, function (req, res) {
  res.send('Hello from D!')
})

響應方法

下表中的響應對象（res）上的方法能夠向客戶端發送響應，並終止請求—響應週期，若是沒有從路由處理程序調用這些方法，則客戶端請求將保持掛起狀態。

方法	描述
res.download()	提示下載文件
res.end()	結束響應過程
res.json()	發送JSON響應
res.jsonp()	使用JSONP支持發送JSON響應
res.redirect()	重定向請求
res.render()	渲染視圖模板
res.send()	發送各類類型的響應
res.sendFile()	將文件做爲八位字節流發送
res.sendStatus()	設置響應狀態碼並將其字符串表示形式做爲響應體發送

app.route()

你可使用app.route()爲路由路徑建立可連接的路由處理程序，因爲路徑是在單個位置指定的，所以建立模塊化路由頗有幫助，同時減小冗餘和拼寫錯誤，有關路由的更多信息，請參閱：Router()文檔。

如下是使用app.route()定義的連接路由處理程序示例。

app.route('/book')
  .get(function (req, res) {
    res.send('Get a random book')
  })
  .post(function (req, res) {
    res.send('Add a book')
  })
  .put(function (req, res) {
    res.send('Update the book')
  })

express.Router

使用express.Router類建立模塊化、可裝載的路由處理程序，Router實例是一個完整的中間件和路由系統，所以，它一般被稱爲「迷你應用程序」。

如下示例將路由器建立爲模塊，在其中加載中間件功能，定義一些路由，並將路由器模塊裝載在主應用程序中的路徑上。

在應用程序目錄中建立名爲birds.js的路由器文件，其中包含如下內容：

var express = require('express')
var router = express.Router()

// middleware that is specific to this router
router.use(function timeLog (req, res, next) {
  console.log('Time: ', Date.now())
  next()
})
// define the home page route
router.get('/', function (req, res) {
  res.send('Birds home page')
})
// define the about route
router.get('/about', function (req, res) {
  res.send('About birds')
})

module.exports = router

而後，在應用程序中加載路由器模塊：

var birds = require('./birds')

// ...

app.use('/birds', birds)

該應用程序如今可以處理對/birds和/birds/about的請求，以及調用特定於該路由的timeLog中間件函數。

---

上一篇：常見問題

下一篇：編寫中間件