在线文档教程
首页 技术教程 开发文档 觅分类 ICON图标
技术教程 开发文档 觅分类 ICON图标

1.路由 | 1. Routing

路由

路由是指应用程序端点（URI）的定义以及它们如何响应客户端请求。有关路由的介绍，请参阅基本路由。

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

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，unlock，report，mkactivity，checkout，merge，m-search，notify，subscribe，unsubscribe，patch和search。

路由转换为无效JavaScript变量名称的方法，请使用括号表示法。例如，app['m-search']('/', function ...

有一种特殊的路由方法，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实例是一个完整的中间件和路由系统; 出于这个原因，它通常被称为“迷你应用程序”。

以下示例将路由器创建为模块，在其中加载中间件功能，定义一些路由并将路由器模块安装在主应用程序的路径中。

在app目录中创建一个birds.js，在app目录中命名路由器文件，其中包含以下内容：

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特定于该路线的中间件功能。

  • 黔ICP备2021005045号