路由

路由(Routing)是指应用程序的端点(URI)如何响应客户端请求。有关路由的介绍,请参阅基本路由

您可以使用 Express app 对象中对应 HTTP 方法的方法来定义路由;例如,使用 app.get() 处理 GET 请求,使用 app.post 处理 POST 请求。有关完整列表,请参阅app.METHOD。您还可以使用app.all() 处理所有 HTTP 方法,并使用app.use() 指定中间件作为回调函数(详见使用中间件)。

这些路由方法指定了一个回调函数(有时称为“处理函数”),当应用程序接收到对指定路由(端点)和 HTTP 方法的请求时,会调用该函数。换句话说,应用程序“侦听”与指定路由和方法匹配的请求,当检测到匹配时,它会调用指定的回调函数。

实际上,路由方法可以有多个回调函数作为参数。当有多个回调函数时,重要的是将 next 作为参数提供给回调函数,然后在函数体中调用 next(),以便将控制权传递给下一个回调。

以下代码是一个非常基本的路由示例。

const express = require('express')
const app = express()

// respond with "hello world" when a GET request is made to the homepage
app.get('/', (req, res) => {
  res.send('hello world')
})

路由方法

路由方法源自 HTTP 方法之一,并附加到 express 类的一个实例上。

以下代码是为应用程序根目录的 GETPOST 方法定义的路由示例。

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

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

Express 支持与所有 HTTP 请求方法对应的方法:getpost 等。有关完整列表,请参阅app.METHOD

有一个特殊的路由方法 app.all(),用于在某个路径上为所有 HTTP 请求方法加载中间件函数。例如,以下处理程序将为路由 "/secret" 的请求执行,无论使用的是 GETPOSTPUTDELETE,还是 http 模块中支持的任何其他 HTTP 请求方法。

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

路由路径

路由路径与请求方法结合使用,定义了可以发出请求的端点。路由路径可以是字符串、字符串模式或正则表达式。

注意

在 Express 5 中,字符 ?+*[]() 的处理方式与版本 4 不同,请查阅迁移指南获取更多信息。

注意

在 Express 4 中,正则表达式字符(如 $)需要用 \ 进行转义。

注意

Express 使用 path-to-regexp 来匹配路由路径;请查阅 path-to-regexp 文档了解定义路由路径的所有可能性。Express Playground Router 是一个用于测试基本 Express 路由的实用工具,尽管它不支持模式匹配。

警告

查询字符串不属于路由路径的一部分。

基于字符串的路由路径

此路由路径将匹配对根路由 / 的请求。

app.get('/', (req, res) => {
  res.send('root')
})

此路由路径将匹配对 /about 的请求。

app.get('/about', (req, res) => {
  res.send('about')
})

此路由路径将匹配对 /random.text 的请求。

app.get('/random.text', (req, res) => {
  res.send('random.text')
})

基于字符串模式的路由路径

注意

Express 5 中的字符串模式不再起作用。请参阅迁移指南获取更多信息。

此路由路径将匹配 acdabcd

app.get('/ab?cd', (req, res) => {
  res.send('ab?cd')
})

此路由路径将匹配 abcdabbcdabbbcd 等。

app.get('/ab+cd', (req, res) => {
  res.send('ab+cd')
})

此路由路径将匹配 abcdabxcdabRANDOMcdab123cd 等。

app.get('/ab*cd', (req, res) => {
  res.send('ab*cd')
})

此路由路径将匹配 /abe/abcde

app.get('/ab(cd)?e', (req, res) => {
  res.send('ab(cd)?e')
})

基于正则表达式的路由路径

此路由路径将匹配包含“a”的任何内容。

app.get(/a/, (req, res) => {
  res.send('/a/')
})

此路由路径将匹配 butterflydragonfly,但不匹配 butterflymandragonflyman 等。

app.get(/.*fly$/, (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', (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" }

注意

在 Express 5 中,路由路径不支持正则表达式字符,更多信息请参阅迁移指南

为了更好地控制路由参数可以匹配的精确字符串,您可以在括号 (()) 中附加一个正则表达式。

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', (req, res) => {
  res.send('Hello from A!')
})

多个回调函数可以处理一个路由(请确保指定 next 对象)。例如

app.get('/example/b', (req, res, next) => {
  console.log('the response will be sent by the next function ...')
  next()
}, (req, res) => {
  res.send('Hello from B!')
})

回调函数数组可以处理一个路由。例如

const cb0 = function (req, res, next) {
  console.log('CB0')
  next()
}

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

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

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

独立函数和函数数组的组合可以处理一个路由。例如

const cb0 = function (req, res, next) {
  console.log('CB0')
  next()
}

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

app.get('/example/d', [cb0, cb1], (req, res, next) => {
  console.log('the response will be sent by the next function ...')
  next()
}, (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((req, res) => {
    res.send('Get a random book')
  })
  .post((req, res) => {
    res.send('Add a book')
  })
  .put((req, res) => {
    res.send('Update the book')
  })

express.Router

使用 express.Router 类创建模块化、可挂载的路由处理程序。Router 实例是一个完整的中间件和路由系统;因此,它通常被称为“迷你应用程序”。

以下示例创建了一个路由作为模块,在其内加载了一个中间件函数,定义了一些路由,并将该路由模块挂载到主应用程序的一个路径上。

在 app 目录中创建一个名为 birds.js 的路由文件,内容如下:

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

// middleware that is specific to this router
const timeLog = (req, res, next) => {
  console.log('Time: ', Date.now())
  next()
}
router.use(timeLog)

// define the home page route
router.get('/', (req, res) => {
  res.send('Birds home page')
})
// define the about route
router.get('/about', (req, res) => {
  res.send('About birds')
})

module.exports = router

然后,在应用程序中加载该路由模块

const birds = require('./birds')

// ...

app.use('/birds', birds)

现在,应用程序将能够处理对 /birds/birds/about 的请求,并调用特定于该路由的 timeLog 中间件函数。

但是,如果父路由 /birds 包含路径参数,则默认情况下子路由将无法访问这些参数。要使其可访问,您需要将 mergeParams 选项传递给 Router 构造函数,请参阅参考

const router = express.Router({ mergeParams: true })
编辑此页