资讯专栏INFORMATION COLUMN

Express 文档(路由)

VPointer / 2467人阅读

摘要:这些路由方法指定当应用程序收到对指定路由端点和方法的请求时调用的回调函数有时称为处理函数,换句话说,应用程序监听与指定路由和方法匹配的请求,并且当它检测到匹配时,它调用指定的回调函数。

路由

路由是指应用程序的端点(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请求方法相对应的方法:getpost等,有关完整列表,请参阅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")
})

以下是基于字符串模式的路由路径的一些示例。

此路由路径将匹配acdabcd

app.get("/ab?cd", function (req, res) {
  res.send("ab?cd")
})

此路由路径将匹配abcdabbcdabbbcd等。

app.get("/ab+cd", function (req, res) {
  res.send("ab+cd")
})

此路由路径将匹配abcdabxcdabRANDOMcdab123cd等。

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

这个路由路径将与butterflydragonfly相匹配,但不会与butterflymandragonflyman等相匹配。

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中间件函数。

上一篇:常见问题 下一篇:编写中间件

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/100459.html

相关文章

  • Express 文档(常见问题)

    摘要:常见问题我该如何构建我的应用程序这个问题没有明确的答案,答案取决于你的应用程序规模和所涉及的团队,为了尽可能灵活,在结构方面没有做出任何假设。请参阅,了解以模型为中心的基于的框架。 常见问题 我该如何构建我的应用程序? 这个问题没有明确的答案,答案取决于你的应用程序规模和所涉及的团队,为了尽可能灵活,Express在结构方面没有做出任何假设。 在你喜欢的任何目录结构中,路由和其他特定于...

    MyFaith 评论0 收藏0
  • Express 文档路由基础)

    摘要:路由基础路由是指确定应用程序如何响应对特定端点的客户端请求,该请求是或路径和特定请求方法,等。路由定义采用以下结构是的一个实例。是匹配到路由时执行的函数。 路由基础 路由是指确定应用程序如何响应对特定端点的客户端请求,该请求是URI(或路径)和特定HTTP请求方法(GET,POST等)。 每个路由都可以有一个或多个处理函数,这些函数在路由匹配时执行。 路由定义采用以下结构: app.M...

    hlcfan 评论0 收藏0
  • Express 文档(使用中间件)

    摘要:调用堆栈中的下一个中间件函数。此示例显示了一个中间件子堆栈,它处理对路径的请求。要从路由器中间件堆栈跳过其余的中间件函数,请调用将控制权传递给下一个路由,注意仅适用于使用或函数加载的中间件函数。 使用中间件 Express是一个路由和中间件Web框架,其本身的功能非常小:Express应用程序本质上是一系列中间件函数调用。 中间件函数是可以访问请求对象(req)、响应对象(res)以及...

    lieeps 评论0 收藏0
  • Express 介绍

    摘要:在向页面发送内容时,程序也不会往下执行我们也可以装在一组中间件路由级中间件路由级中间件和应用级中间件一样,只是它绑定的对象为。安装所需功能的模块,并在应用中加载,可以在应用级加载,也可以在路由级加载。 Express 框架 根据官方的介绍,Express 是一个基于 Node.js 平台的极简、灵活的 web 应用开发框架,可以轻松的创建各种 web 或者移动端应用 今天就来简单的了解...

    hot_pot_Leo 评论0 收藏0
  • Express 文档(编写中间件)

    摘要:编写中间件中间件函数是可以访问请求对象响应对象以及应用程序请求响应周期中的函数的函数,函数是路由器中的一个函数,当被调用时,它会在当前中间件之后执行中间件。结束请求响应周期。此外,根路径路由的回调函数使用中间件函数添加到请求对象的属性。 编写中间件 中间件函数是可以访问请求对象(req)、响应对象(res)以及应用程序请求—响应周期中的next函数的函数,next函数是Express路...

    nanchen2251 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<