Express 教程 4:路由和控制器

在本教程中,我们将为本地图书馆网站最终需要的所有资源端点设置具有“虚拟”处理器函数的路由(URL 处理代码)。完成后,我们就有了路由处理代码的模块化结构,可以在接下来的文章中使用真正的处理器函数对其进行扩展。此外,我们还将真正了解如何使用 Express 创建模块化路由!

前提: 回顾 Express/Node 入门。完成本教程之前小节(包括 Express 教程 3:使用数据库(Mongoose))。
学习目标: 理解简单路由的创建方法。设置示例中所有 URL 端点。

概览

上节定义了与数据库交互的 Mongoose 模型,并使用一个(独立)脚本创建了一些初始的图书馆记录。现在可以编写代码来向用户展示这些信息。我们首先要确定页面中应显示哪些信息,然后定义适当的 URL 来返回这些资源。随后要创建路由(URL 处理器)和视图(模板)来显示这些页面。

下图展示了 HTTP 请求/响应处理的主数据流和需要实现的行为。图中除视图(View)和路由(Route)外,还展示了控制器(Controller),即将路由请求的代码与实际处理请求的代码分离的函数。

因为我们已经创建好了模型,我们接下来需要创建的是:

  • “路由”:把需要支持的请求(以及请求 URL 中编码的任何信息)转发到适当的控制器函数。
  • 控制器函数:从模型中获取请求的数据,创建一个显示数据的 HTML 页面,并将页面返回给用户,以便在浏览器中查看。
  • 视图(模板):供控制器用来渲染数据。

MVC Express 服务器的主要数据流图:“路由”接收发送到 Express 服务器的 HTTP 请求,并将其转发给相应的“控制器”函数。控制器从模型中读取和写入数据。模型连接到数据库,为服务器提供数据访问。控制器使用“视图”(也称为模板)来呈现数据。控制器将 HTML HTTP 响应作为 HTTP 响应发送回客户端。

因此我们最终需要显示图书、图书种类、作者、图书副本的列表和详细信息的页面,还需要页面来创建、更新和删除记录。这些内容对于本节来说不算少,因此本节将主要集中在路由和控制器设置。本节编写的这些函数都只有框架,而会后续章节再扩展控制器方法以使用模型数据。

第一小节提供了 Express 的 Router 中间件的“入门”知识。后续设置本地图书馆的路由时我们将用到这些知识。

路由入门

路由是一段 Express 代码,它将 HTTP 动词(GETPOSTPUTDELETE 等)、URL 路径/模式和处理函数三者关联起来。

创建路由有多种方法。在本教程中,我们将使用 express.Router 中间件,因为它允许我们将网站特定部分的路由处理器分组在一起并使用共同的路由前缀访问它们。我们将把所有与图书馆相关的路由保存在“catalog”(目录)模块中,如果我们添加了用于处理用户账户或其他功能的路由,可以将它们单独分组。

备注:我们在 Express 简介 > 创建路由处理程序中简要讨论了 Express 应用的路由机制。使用 Router 可以保证更好的模块化(下文所述),且用法与直接在 Express 应用对象上定义路由非常类似。

本小节的剩余部分内容将介绍使用 Router 定义路由的方法。

定义和使用单独的路由模块

以下代码举例说明了如何创建路由模块,以及如何在 Express 应用中使用它。

首先,在 wiki.js 模块中创建一个维基路由。代码一开始导入 Express 应用对象,用它取得一个 Router 对象,然后用 get() 方法向其添加两个具体的路由。模块的最后导出该 Router 对象。

js
// wiki.js - 维基路由模块

const express = require("express");
const router = express.Router();

// 主页路由
router.get("/", (req, res) => {
  res.send("维基主页");
});

// “关于页面”路由
router.get("/about", (req, res) => {
  res.send("关于此维基");
});

module.exports = router;

备注:上面的路由处理回调直接定义在了路由函数中。本地图书馆的回调将定义在单独的控制器模块中。

要在主应用中使用该路由模块,首先应 require() 它(wiki.js),然后在 Express 应用对象上调用 use()(指定 URL 路径“wiki”),即可将其添加到中间件处理路径。

js
const wiki = require("./wiki.js");
// …
app.use("/wiki", wiki);

这时 wiki 模块中定义的两个路由就可以从 /wiki//wiki/about/ 访问了。

路由函数

上述模块定义了两个典型的路由函数。Router.get() 方法定义的“about”路由(下方重现的)仅响应 HTTP GET 请求。第一个参数是 URL 路径,第二个参数是一个回调,在收到带有路径的 HTTP GET 请求将调用之。

js
router.get("/about", (req, res) => {
  res.send("关于此维基");
});

该回调有三个参数(通常命名为:reqresnext),分别是:HTTP 请求对象、HTTP 响应、中间件链中的下一个函数。

备注:路由函数就是 Express 中间件,这意味着它们要么(通过响应)结束请求,要么调用链中的 next 函数。在上述示例中,我们使用 send() 完成了请求,因而没有用上 next 参数(参数表中将其省略)。

上述路由函数只需要一个回调。我们可以根据需要指定任意数量的回调参数或一个回调函数数组。每个函数都将加入中间件链,并且将按添加顺序调用(若有回调完成请求则中止当前周期)。

此处的回调对响应对象调用 send(),当收到带有路径(/about)的 GET 请求时将返回字符串“关于此维基”。还有许多其他可以结束请求/响应周期响应方法,例如,可调用 res.json() 来发送 JSON 响应,或调用 res.sendFile() 来发送文件。构建本地图书馆最常使用的响应方法是 render(),它使用模板和数据创建并返回 HTML 文件。我们将在后续章节进一步讨论。

HTTP 动词

上面的示例使用 Router.get() 方法来响应特定路径的 HTTP GET 请求。

Router 还为所有其他 HTTP 动词提供路由方法,大都用法相同:post()put()delete()options()trace()copy()lock()mkcol()move()purge()propfind()proppatch()unlock()report()mkactivity()checkout()merge()m-search()notify()subscribe()unsubscribe()patch()search()connect()

比如下方代码与上方 /about 路由行为一致,但只响应 HTTP POST 请求。

js
router.post("/about", (req, res) => {
  res.send("关于此维基");
});

路由路径

路由路径用于定义可请求的端点。之前示例中路径都是字符串,并且必须精确写作:“/”、“/about”、“/book”诸如此类。

路由路径也可以是字符串模式(string pattern)。字符串模式使用正则表达式语法来定义将匹配的端点模式。语法如下所示(注意,连字符(-)和点(.)在基于字符串的路径中被解释为字面量):

  • ?:问号之前的一个字符只能出现零次或一次。例如,路由路径 '/ab?cd' 路径匹配端点 acdabcd
  • +:加号之前的一个字符至少出现一次。例如,路径路径 '/ab+cd' 匹配端点 abcdabbcdabbbcd,等。
  • *:星号可以替换为任意字符串。例如,路由路径 '/ab*cd' 匹配端点 abcdabXcdabSOMErandomTEXTcd,等。
  • ():将一个字符串视为一体以执行 ?+* 操作。例如。 '/ab(cd)?e' 将对 (cd) 进行匹配,将匹配到 abeabcde

路由路径也可以是 JavaScript 正则表达式。例如,下面的路由路径将匹配 catfishdogfish,但不会匹配 catflapcatfishhead 等。注意,正则表达式路径不再用引号 "..." 括起来,而是正则表达式语法 /.../

js
app.get(/.*fish$/, (req, res) => {
  ...
});

备注:本地图书馆的大部分路由都只用到字符串,很少用字符串模式和正则表达式。接下来我们将讨论“路由参数”。

路由参数

路径参数是具名 URL 片段,用于捕获在 URL 中的位置指定的值。具名段以冒号为前缀并紧接着名称(如 /:your_parameter_name/)。捕获的值保存在 req.params 对象中,其中参数名对应对象的键(例如 req.params.your_parameter_name)。

比如,我们考虑一个包含用户和图书信息的 URL:http://localhost:3000/users/34/books/8989。我们可以这样提取信息(使用 userIdbookId 路径参数):

js
app.get("/users/:userId/books/:bookId", (req, res) => {
  // 通过 req.params.userId 访问 userId
  // 通过 req.params.bookId 访问 bookId
  res.send(req.params);
});

路由参数名必须由“单词字符”(A-Z、a-z、0-9 以及 _)组成。

备注:URL /book/create 会匹配 /book/:bookId 这样的路由(因为 :bookId任意字符串的占位符,会匹配 create)。第一个与传入 URL 相匹配的路由会被使用,因此 /book/create 的路由处理器必须定义在 /book/:bookId 路由之前,才能专门处理这个路由。

以上就是使用路由所有的预备知识。Express 文档中还能找到更多信息:基础路由路由指南。以下是本地图书馆路由和控制器的设置过程。

处理路由函数中的错误

前面显示的路由函数都有参数 reqres,分别代表请求和响应。路由函数还可以使用第三个参数 next,该参数可用于将错误传递给 Express 中间件链。

下面的代码展示了它是如何工作的,使用一个数据库查询的示例,该查询采用回调函数并返回错误 err 或一些结果。如果返回 err,就将 err 传入 next 方法,(最终错误会传播到我们的全局错误处理代码)。如果成功,将返回所需的数据并将在响应中使用。

js
router.get("/about", (req, res, next) => {
  About.find({}).exec((err, queryResults) => {
    if (err) {
      return next(err);
    }
    // 成功了,那么就渲染吧
    res.render("about_view", { title: "About", list: queryResults });
  });
});

处理路由函数中的异常

上一节展示了 Express 期望路由函数返回错误的方式。该框架设计用于异步函数,这些函数采用回调函数(带有错误和结果参数),该函数在操作完成时调用。这是一个问题,因为稍后我们将使用基于 Promise 的 API 进行 Mongoose 数据库查询,并且可能会在路由函数中抛出异常(而不是在回调中返回错误)。

为了使框架正确处理异常,这些异常必须被捕获,然后将其作为错误转发,如上一节所示。

备注:目前处于测试阶段的 Express 5 有望能原生处理 JavaScript 异常。

在上一节中的简单示例中,About.find().exec() 是返回 Promise 的数据库查询,我们可以在 try...catch 块内编写路由函数,如下所示:

js
exports.get("/about", async function (req, res, next) {
  try {
    const successfulResult = await About.find({}).exec();
    res.render("about_view", { title: "About", list: successfulResult });
  } catch (error) {
    return next(error);
  }
});

每个函数都需要添加大量的样板代码。在本教程中,我们将使用 express-async-handler 模块。它定义了一个包装器函数,隐藏了 try...catch 块和用于转发错误的代码。现在,相同的示例将变得非常简单,因为我们只需要为假设成功的情况编写代码:

js
// 导入模块
const asyncHandler = require("express-async-handler");

exports.get(
  "/about",
  asyncHandler(async (req, res, next) => {
    const successfulResult = await About.find({}).exec();
    res.render("about_view", { title: "About", list: successfulResult });
  }),
);

本地图书馆所需的路由

以下是站点页面的完整 URL 列表,其中 object 是模型名称(bookbookinstancegenreauthor),objects 是一组模型,id 是每个 Mongoose 模型实例默认的标识字段(_id)。

  • catalog/:主页。
  • catalog/<objects>/:模型(图书、图书副本、图书种类、作者)的完整列表(例如 /catalog/books//catalog/genres/ 等)
  • catalog/<object>/<id>:具有 _id 字段值的特定模型的详细信息页面(例如 /catalog/book/584493c1f4887f06c0e67d37)。
  • catalog/<object>/create:添加新模型的表单(例如 /catalog/book/create)。
  • catalog/<object>/<id>/update:更新具有 _id 字段值的特定模型的表单(例如 /catalog/book/584493c1f4887f06c0e67d37/update)。
  • catalog/<object>/<id>/delete:删除具有 _id 字段值的特定模型的表单(例如 /catalog/book/584493c1f4887f06c0e67d37/delete)。

首页和列表页面没有包含任何额外信息。因此它们返回的结果只取决于模型类型和数据库内容,获取信息的查询操作是恒定不变的(类似地,创建对象的代码也没有较大改动)。

与之相反,其他 URL 是用于处理特定文档/模型实例的,它们会将项目的标识嵌入 URL(上文的 <id>)。可以用路径参数来提取嵌入的信息,并传递给路由处理器(后续章节中用于动态获取数据库中的信息)。通过在 URL 中嵌入信息,使得每种类型的所有资源只需要一个路由(例如,所有图书副本的显示操作只需要一个路由)。

备注:Express 可以通过任何方式构造 URL,可以在 URL 正文中嵌入信息(如上文),或使用 URL GET 参数(例如 /book/?id=6)。无论哪种方法,URL 都应保持整洁、合理且易读(另请参阅 W3C 相关建议)。

下面我们为上述所有 URL 创建路由处理器回调函数和路由代码。

创建路由处理器回调函数

在定义路由之前,我们首先要创建它们将调用的所有虚拟/骨架回调函数。这些回调函数将分别存储在 BookBookInstanceGenreAuthor 的“控制器”模块中(你可以使用任何文件/模块结构,但我们这样做会更好贴切项目本身)。

首先在项目根目录下为控制器创建一个文件夹(/controllers),然后为处理每个模型创建单独的控制器文件/模块:

/express-locallibrary-tutorial  // 项目根目录
  /controllers
    authorController.js
    bookController.js
    bookinstanceController.js
    genreController.js

控制器将使用 express-async-handler 模块,因此在继续之前,请使用 npm 将其安装到程序库中:

bash
npm install express-async-handler

Author 控制器

以下是 /controllers/authorController.js 文件的内容:

js
const Author = require("../models/author");
const asyncHandler = require("express-async-handler");

// 显示完整的作者列表
exports.author_list = (req, res) => {
  res.send("未实现:作者列表");
};

// 为每位作者显示详细信息的页面
exports.author_detail = asyncHandler(async (req, res, next) => {
  res.send("未实现:作者详细信息:" + req.params.id);
};

// 由 GET 显示创建作者的表单
exports.author_create_get = asyncHandler(async (req, res, next) => {
  res.send("未实现:创建作者的 GET");
};

// 由 POST 处理作者创建操作
exports.author_create_post = asyncHandler(async (req, res, next) => {
  res.send("未实现:创建作者的 POST");
};

// 由 GET 显示删除作者的表单
exports.author_delete_get = asyncHandler(async (req, res, next) => {
  res.send("未实现:删除作者的 GET");
};

// 由 POST 处理作者删除操作
exports.author_delete_post = asyncHandler(async (req, res, next) => {
  res.send("未实现:删除作者的 POST");
};

// 由 GET 显示更新作者的表单
exports.author_update_get = asyncHandler(async (req, res, next) => {
  res.send("未实现:更新作者的 GET");
};

// 由 POST 处理作者更新操作
exports.author_update_post = asyncHandler(async (req, res, next) => {
  res.send("未实现:更新作者的 POST");
};

该模块首先需要 Author 模型(我们稍后将使用该模型访问和更新数据)和 asyncHandler 包装器(我们将使用该封装器捕获路由处理函数中抛出的任何异常)。然后,它为我们希望处理的每个 URL 输出函数。请注意,创建、更新和删除操作使用的是表单,因此还需要额外的方法来处理表单发布请求。我们将在后面的“表单”一文中讨论这些方法。

这些函数都使用了上文处理路由函数中的异常中描述的封装函数,其参数包括请求、响应和下一步。函数会响应一个字符串,表示相关页面尚未创建。如果控制器函数预计会接收路径参数,则会在消息字符串中输出这些参数(参见上文的 req.params.id)。

请注意,某些路由函数在实现后可能不包含任何可抛出异常的代码。我们可以在使用时将它们改回“正常”的路由处理器函数。

BookInstance 控制器

打开 /controllers/bookinstanceController.js 文件,复制以下代码(与 Author 控制器模块的模式相同):

js
const BookInstance = require("../models/bookinstance");
const asyncHandler = require("express-async-handler");

// 显示所有的 BookInstances
exports.bookinstance_list = asyncHandler(async (req, res, next) => {
  res.send("未实现:BookInstance 列表");
});

// 显示特定 BookInstance 的详情页
exports.bookinstance_detail = asyncHandler(async (req, res, next) => {
  res.send(`未实现:BookInstance 详情页面:${req.params.id}`);
});

// 由 GET 显示创建 BookInstance 的表单
exports.bookinstance_create_get = asyncHandler(async (req, res, next) => {
  res.send("未实现:BookInstance 创建 GET");
});

// 由 POST 处理创建 BookInstance
exports.bookinstance_create_post = asyncHandler(async (req, res, next) => {
  res.send("未实现:BookInstance 创建 POST");
});

// 由 GET 显示删除 BookInstance 的表单
exports.bookinstance_delete_get = asyncHandler(async (req, res, next) => {
  res.send("未实现:BookInstance 删除 GET");
});

// 由 POST 删除 BookInstance
exports.bookinstance_delete_post = asyncHandler(async (req, res, next) => {
  res.send("未实现:BookInstance 删除 POST");
});

// 由 GET 显示更新 BookInstance 的表单
exports.bookinstance_update_get = asyncHandler(async (req, res, next) => {
  res.send("未实现:BookInstance 更新 GET");
});

// 由 POST 处理更新 BookInstance
exports.bookinstance_update_post = asyncHandler(async (req, res, next) => {
  res.send("未实现:BookInstance 更新 POST");
});

Genre 控制器

打开 /controllers/genreController.js 文件,复制以下文本(与 AuthorBookInstance 文件的模式相同):

js
const genre = require("../models/genre");
const asyncHandler = require("express-async-handler");

// 显示所有的流派。
exports.genre_list = asyncHandler(async (req, res, next) => {
  res.send("未实现:流派列表");
});

// 显示特定流派的详情页。
exports.genre_detail = asyncHandler(async (req, res, next) => {
  res.send(`未实现:流派详情页:${req.params.id}`);
});

// 通过 GET 显示创建流派。
exports.genre_create_get = asyncHandler(async (req, res, next) => {
  res.send("未实现:流派创建 GET");
});

// 以 POST 方式处理创建流派。
exports.genre_create_post = asyncHandler(async (req, res, next) => {
  res.send("未实现:流派创建 POST");
});

// 通过 GET 显示流派删除表单。
exports.genre_delete_get = asyncHandler(async (req, res, next) => {
  res.send("未实现:流派删除 GET");
});

// 处理 POST 时的流派删除。
exports.genre_delete_post = asyncHandler(async (req, res, next) => {
  res.send("未实现:流派删除 POST");
});

// 通过 GET 显示流派更新表单。
exports.genre_update_get = asyncHandler(async (req, res, next) => {
  res.send("未实现:流派更新 GET");
});

// 处理 POST 上的流派更新。
exports.genre_update_post = asyncHandler(async (req, res, next) => {
  res.send("未实现:流派更新 POST");
});

Book 控制器

打开 /controllers/bookController.js 文件,复制以下代码。该代码与其他控制器模块的模式相同,但增加了一个用于显示网站欢迎页面的 index() 函数:

js
const Book = require("../models/book");
const asyncHandler = require("express-async-handler");

exports.index = asyncHandler(async (req, res, next) => {
  res.send("未实现:网站主页");
});

// 显示所有的图书
exports.book_list = asyncHandler(async (req, res, next) => {
  res.send("未实现:图书列表");
});

// 显示特定图书的详情页面。
exports.book_detail = asyncHandler(async (req, res, next) => {
  res.send(`未实现:图书详情页面:${req.params.id}`);
});

// 通过 GET 显示创建图书。
exports.book_create_get = asyncHandler(async (req, res, next) => {
  res.send("未实现:创建图书 GET");
});

// 以 POST 方式处理创建图书。
exports.book_create_post = asyncHandler(async (req, res, next) => {
  res.send("未实现:Book 创建 POST");
});

// 通过 GET 显示删除图书。
exports.book_delete_get = asyncHandler(async (req, res, next) => {
  res.send("未实现:删除 GET");
});

// 以 POST 方式处理删除图书。
exports.book_delete_post = asyncHandler(async (req, res, next) => {
  res.send("未实现:删除 POST");
});

// 通过 GET 显示更新图书。
exports.book_update_get = asyncHandler(async (req, res, next) => {
  res.send("未实现:更新图书 GET");
});

// 处理 POST 时的更新图书。
exports.book_update_post = asyncHandler(async (req, res, next) => {
  res.send("未实现:更新图书 POST");
});

创建 catalog 路由模块

定义好控制器后,我们来为本地图书馆网站创建完整的 URL 路由。

站点骨架中有一个 ./routes 文件夹,其中包含两个路由文件:indexusers,在这里新建一个 catalog.js 路由文件,如下所示:

/express-locallibrary-tutorial   // 项目根目录
  /routes
    index.js
    users.js
    catalog.js

打开 /routes/catalog.js 并拷贝如下代码到其中:

js
const express = require("express");
const router = express.Router();

// 导入控制器模块
const book_controller = require("../controllers/bookController");
const author_controller = require("../controllers/authorController");
const genre_controller = require("../controllers/genreController");
const book_instance_controller = require("../controllers/bookinstanceController");

/// 图书路由 ///

// GET 获取图书编目主页
router.get("/", book_controller.index);

// GET 请求添加新的图书。注意此项必须位于显示图书的路由(使用了 id)之前。
router.get("/book/create", book_controller.book_create_get);

// POST 请求添加新的图书
router.post("/book/create", book_controller.book_create_post);

// GET 请求删除图书
router.get("/book/:id/delete", book_controller.book_delete_get);

// POST 请求删除图书
router.post("/book/:id/delete", book_controller.book_delete_post);

// GET 请求更新图书
router.get("/book/:id/update", book_controller.book_update_get);

// POST 请求更新图书
router.post("/book/:id/update", book_controller.book_update_post);

// GET 请求图书
router.get("/book/:id", book_controller.book_detail);

// GET 请求完整图书列表
router.get("/books", book_controller.book_list);

/// 作者路由 ///

// 用于创建作者的 GET 请求。注意这必须在 id 的路由之前(比如说显示作者)
router.get("/author/create", author_controller.author_create_get);

// 创建作者的 POST 请求。
router.post("/author/create", author_controller.author_create_post);

// 删除作者的 GET 请求。
router.get("/author/:id/delete", author_controller.author_delete_get);

// POST 请求删除作者。
router.post("/author/:id/delete", author_controller.author_delete_post);

// 更新作者的 GET 请求。
router.get("/author/:id/update", author_controller.author_update_get);

// POST 请求更新作者。
router.post("/author/:id/update", author_controller.author_update_post);

// 获取一个作者的 GET 请求。
router.get("/author/:id", author_controller.author_detail);

// 获取所有作者列表的 GET 请求。
router.get("/authors", author_controller.author_list);

/// 流派路由 ///

// 用于创建流派的 GET 请求。注意:这必须在显示流派的路由之前(使用 id 的路由)。
router.get("/genre/create", genre_controller.genre_create_get);

// POST 请求创建 Genre。
router.post("/genre/create", genre_controller.genre_create_post);

// 删除流派的 GET 请求。
router.get("/genre/:id/delete", genre_controller.genre_delete_get);

// POST 请求删除 Genre。
router.post("/genre/:id/delete", genre_controller.genre_delete_post);

// 更新流派的 GET 请求。
router.get("/genre/:id/update", genre_controller.genre_update_get);

// 更新流派的 POST 请求。
router.post("/genre/:id/update", genre_controller.genre_update_post);

// 获取一个流派的 GET 请求。
router.get("/genre/:id", genre_controller.genre_detail);

// 获取所有流派列表的 GET 请求
router.get("/genres", genre_controller.genre_list);

/// BOOKINSTANCE 路由 ///

// 用于创建 BookInstance 的 GET 请求。注意:这必须在显示 BookInstance 的路由之前(使用 id 的路由)。
router.get(
  "/bookinstance/create",
  book_instance_controller.bookinstance_create_get,
);

// 创建 BookInstance 的 POST 请求。
router.post(
  "/bookinstance/create",
  book_instance_controller.bookinstance_create_post,
);

// 删除 BookInstance 的 GET 请求。
router.post(
  "/bookinstance/:id/delete",
  book_instance_controller.bookinstance_delete_get,
);

// POST 请求删除 BookInstance。
router.post(
  "/bookinstance/:id/delete",
  book_instance_controller.bookinstance_delete_post,
);

// 更新 BookInstance 的 GET 请求。
router.get(
  "/bookinstance/:id/delete",
  book_instance_controller.bookinstance_update_get,
);

// 更新 BookInstance 的 POST 请求。
router.post(
  "/bookinstance/:id/update",
  book_instance_controller.bookinstance_update_post,
);

// 一个 BookInstance 的 GET 请求。
router.get("/bookinstance/:id", book_instance_controller.bookinstance_detail);

// GET 请求获取所有 BookInstance 的列表。
router.get("/bookinstances", book_instance_controller.bookinstance_list);

module.exports = router;

该模块导入了 express 并创建了一个 Router 对象 router。所有路由都设置在 router 上,最后将其导出。

router 对象调用 .get().post() 函数即可定义路由。这里所有路径都使用字符串定义(而不用字符串模式或正则表达式)。某些特定资源(如图书)的路由使用路径参数从 URL 中获取对象标识。

处理函数均导入自上文的控制器模块。

更新索引路由模块

我们已经设置了所有新路径,但仍有一条路径指向原始页面。让我们把它重定向到我们在“/catalog”路径下创建的新索引页面。

/routes/index.js 中的中间件修改一下:

js
// GET 请求主页
router.get("/", (req, res) => {
  res.redirect("/catalog");
});

备注:这是我们第一次使用 redirect() 响应方法。它会使路由重定向到指定的页面,默认发送 HTTP 状态代码“302 Found”。可以根据需要更改返回的状态代码、设置绝对或相对路径。

更新 app.js

最后一步是在 app.js 中将路由添加到中间件链。

打开 app.js,在 indexusers 路由下方添加 catalog 路由:

js
const indexRouter = require("./routes/index");
const usersRouter = require("./routes/users");
const catalogRouter = require("./routes/catalog"); // 导入 catalog 路由

然后在已定义的路由下方将目录路由添加进中间件栈:

js
app.use("/", indexRouter);
app.use("/users", usersRouter);
app.use("/catalog", catalogRouter); // 将 catalog 路由添加进中间件链

备注:我们将图书编目模块添加到了 '/catalog' 路径,该路径是 catalog 模块中所有路径的前缀。例如,访问图书列表 的 URL 为:/catalog/books/

大功告成。本地图书馆网站所需的所有 URL 的路由和框架函数都已准备完毕。

测试路由

要测试路由,先要启动网站

  • 默认方法

    bash
    # Windows
    SET DEBUG=express-locallibrary-tutorial:* & npm start
    
    # macOS 或 Linux
    DEBUG=express-locallibrary-tutorial:* npm start
    
  • 如果设置过 nodemon,则可以使用:

    bash
    DEBUG=express-locallibrary-tutorial:* npm run devstart
    

接下来浏览上面一些 URL,确保不会收到错误页面(HTTP 404)。可以尝试以下示例:

  • http://localhost:3000/
  • http://localhost:3000/catalog
  • http://localhost:3000/catalog/books
  • http://localhost:3000/catalog/bookinstances/
  • http://localhost:3000/catalog/authors/
  • http://localhost:3000/catalog/genres/
  • http://localhost:3000/catalog/book/5846437593935e2f8c2aa226
  • http://localhost:3000/catalog/book/create

小结

网站的路由已创建完毕,接下来的教程将把完整的实现填入控制器框架中。藉此来学习 Express 路由的基础知识,以及组织路由和控制器的一些方式。

下一节将使用视图(模板)和模型里的信息创建一个欢迎页面。

参见