(记录)关于nodeJs的Express中路由的用法

文档位置:http://www.expressjs.com.cn/en/guide/routing.html

路由

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

您可以使用对应于HTTP方法的Express应用程序对象的方法定义路由;例如,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')
})

路由路径

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

角色?、+、*和()是它们的正则表达式对应项的子集。连字符(-)和点(.)由基于字符串的路径逐字解释。

如果需要在路径字符串中使用美元字符( [ ] / d a t a / ),请将它括在([和])中。例如,“/data/ book”处请求的路径字符串将是“/data/([$])book”。

Express使用到regexp的路径来匹配路由路径;有关定义路由路径的所有可能性,请参阅regexp文档的路径。Express Route Tester是一个测试基本Express路由的简便工具,尽管它不支持模式匹配。

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

下面是一些基于字符串的路由路径示例。
此路由路径将与根路由的请求匹配,/。

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

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

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、ABBCD等匹配。

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/')
})

此路径将匹配蝴蝶和蜻蜓,但不匹配蝴蝶、蜻蜓等。

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_uux])组成。

由于连字符(-)和点(.)是逐字解释的,因此它们可以与路由参数一起使用,以达到有用的目的。

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,而不是。这可能会在5号快车上修正。

路由处理器

您可以提供多个回调函数,它们的行为类似于中间件来处理请求。唯一的例外是这些回调可能调用next(“route”)来绕过剩余的路由回调。您可以使用此机制对一个路由施加预先条件,然后在没有理由继续使用当前路由的情况下将控制权传递给后续路由。

路由处理程序可以是函数、函数数组或两者的组合形式,如以下示例所示。

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

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

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

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)上的方法可以向客户机发送响应,并终止请求响应周期。如果没有从路由处理程序调用这些方法,则客户端请求将保持挂起状态。

Method Description
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路由器

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

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

在app目录中创建名为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的请求,也可以调用特定于路由的时间日志中间件功能。

发布了56 篇原创文章 · 获赞 8 · 访问量 2万+

猜你喜欢

转载自blog.csdn.net/qq_44361433/article/details/90349658