使用 Mongoose 和 Express.js 构建 RESTful API 的最佳实践
在进行 web 应用程序开发时，构建一个功能强大，易于扩展和维护的 RESTful API 是非常重要的。在前端开发领域中，Node.js 和 Express.js 通常被用来构建后端服务，而 Mongoose 则是一个流行的 MongoDB 驱动程序，提供了许多有用的功能，如模型定义，验证，钩子功能以及查询生成器等。
在本篇文章中，我们将探讨如何使用 Mongoose 和 Express.js 构建一个 RESTful APIs 并采用最佳实践。同时，我们还将探讨许多有用的技术概念，如身份验证，身份验证错误处理，异常处理等。
我们将从建立架构开始，然后向您介绍如何定义模型，路由以及如何使用 Mongoose 进行查询操作。最后，我们将演示如何集成身份验证和异常处理，以及一些值得注意的最佳实践。
准备工作
为了按照本文所述操作，您需要安装几个必要的工具：
- Node.js 和 npm：您可以从这里下载和安装 Node.js 和 npm。
- Express.js：您可以通过 npm 安装 Express.js。
- MongoDB：您可以从官方网站下载和安装 MongoDB。
- Mongoose：您可以通过 npm 安装 Mongoose。
开发环境准备就绪后，我们可以开始构建 RESTful API。
建立框架
Express.js 是构建 web 应用程序的流行框架。构建 Express.js 应用程序的一般方法是初始化项目并设置其基本结构。让我们通过下面的命令创建新的 Express.js 项目：
$ npx express-generator
执行上面的命令后，它将提示您选择将要使用的应用程序类型和要使用的视图引擎。选择默认值（MVC 模式、Jade 模板引擎），然后按 Enter 键。
接下来，我们需要安装所有依赖项（即生成器安装的所有自定义模块）。作为最佳实践，我建议您将所有模块都安装在生产环境中，以防止将不必要的文件部署到生产环境中。
$ cd myapp $ npm install --production
定义模型
在构建 RESTful API 时，模型是将数据存储在数据库中的核心组成部分。对于 MongoDB 数据库， Mongoose 是非常受欢迎的选项，因为它提供了方便的模型定义，模型验证，钩子以及查询生成器等功能。
一个模型通常代表一条记录，并允许您执行一系列操作，如创建，读取，更新和删除。 在本文之后使用的示例模型将代表文章。
在项目的根目录下创建一个名为 models 的文件夹，并在其中创建一个名为 article.js 的文件。在 article.js 中，我们将使用以下代码定义 article 模型：
-- -------------------- ---- -------
----- -------- - --------------------
----- ------------- - --- -----------------
------ ------ ------- --------- ------
-------- ------ ------- --------- ------
---------- - ----- ----- -------- -------- -
---
----- ------- - ------------------------- ---------------
-------------- - --------上面的代码定义了 article 模型，其中包括三个属性：title，content 和 createdAt。在此示例中，每篇文章都需要一个标题和内容，并将自动在创建时间戳时生成一个日期时间戳。
创建路由
一旦创建了 article 模型，我们需要为其创建路由。在 Express.js 中，路由负责处理接收到的请求并发送响应。这使我们可以将请求发送到正确的处理程序并相应地处理它们。
在项目根目录下创建名为 routes 的文件夹，并在其中创建一个名为 articles.js 的文件。在其中，我们将使用以下代码创建路由：
-- -------------------- ---- -------
----- ------- - -------------------
----- ------ - -----------------
----- ------- - -----------------------------
-- --- --- --------
--------------- ----- ----- ---- -- -
--- -
----- -------- - ----- ---------------
-------------------
- ----- ----- -
---------------------- -------- ----------- ---
-
---
-- --- -- ------- -- --
------------------ ----------- ----- ---- -- -
----------------------
---
-- ------ - --- -------
---------------- ----- ----- ---- -- -
----- ------- - --- ---------
------ ---------------
-------- ----------------
---
--- -
----- ---------- - ----- ---------------
---------------------------------
- ----- ----- -
---------------------- -------- ----------- ---
-
---
-- ------ -- -------
-------------------- ----------- ----- ----- ---- -- -
-- --------------- -- ----- -
----------------- - ---------------
-
-- ----------------- -- ----- -
------------------- - -----------------
-
--- -
----- -------------- - ----- -------------------
-------------------------
- ----- ----- -
---------------------- -------- ----------- ---
-
---
-- ------ -- -------
--------------------- ----------- ----- ----- ---- -- -
--- -
----- ---------------------
---------- -------- -------- -------- ---
- ----- ----- -
---------------------- -------- ----------- ---
-
---
----- -------- --------------- ---- ----- -
--- --------
--- -
------- - ----- --------------------------------
-- -------- -- ----- -
------ ---------------------- -------- ------- ---- -------- ---
-
- ----- ----- -
------ ---------------------- -------- ----------- ---
-
----------- - --------
-------
-
-------------- - -------上述代码中，我们创建了 CRUD 路由：从数据库中获取文章列表、获取指定文章、创建新文章、更新和删除文章。同时，我们还为特定 article id 创建了中间件函数 getArticle。getArticle 函数负责在我们创建，更新和删除具有给定 id 的特定文章时，完成文章查找。
使用 Mongoose 操作
在除了 Defining Models 部分之外的代码中，您可能已经注意到我们在某些语句中使用了 await。在这里说一下，在使用 Mongoose 进行查询操作时，我们将遇到大量异步操作。 这些查询需要一定的等待时间，而使用异步操作就允许我们在等待这些查询操作时执行其他代码。
在最常见的查询操作中，我们使用了以下查询操作符：
- find（）：执行从集合中查找记录的查询。
- findById（）：执行在集合中查找特定记录的查询。
- save（）：执行用于在集合中创建或更新记录的查询操作。
授权
将授权逻辑集成到 RESTful API 中的重要性不能够被低估。在安全考虑方面，我们需要确保每个请求都是受控的，并且仅允许经过身份验证的用户访问某些请求。 让我们看看如何使用授权证书来保护我们的 RESTful API。
使用 Passport.js 是一个用于登录验证的流行选项。为了在 Express.js 应用程序中使用 Passport.js，我们需要添加一个 Passport 中间件。
Let’s go ahead and install the passport npm package, then create a new folder named config in our project’s root folder.
$ npm install passport $ mkdir config
In the config folder, let’s create a new file named passport.js. In this file, we’ll define an authentication strategy based on JWT tokens:
-- -------------------- ---- -------
----- ----------- - ---------------------------------
----- ---------- - -----------------------------------
----- -------- - --------------------
----- ---- - -----------------------
----- ---- - ------------------
----- ---- - ---
------------------- - -----------------------------------------
---------------- - -----------------
-------------- - ---------- -- -
---------------- ----------------- ------------- ----- -- -
-----------------------------
---------- -- -
-- ------ -
------ ---------- ------
-
------ ---------- -------
--
---------- -- ------------------
----
--上面的代码中，我们在 Passport.js 中定义了一个基于 JSON Web Tokens（JWT）的策略。该策略获取以 Bearer 认证方案提供的 JWT 令牌，验证令牌的签名，并使用匹配信息调用 done 回调函数。这样，我们就可以更好地保护我们的 RESTful API。
异常处理
在 RESTful API 中，遇到异常是常见的。这些异常可能是因为模型验证失败，权限被拒绝，数据库出了问题，或者是由于其他原因导致的。在这些情况下，我们的应用程序应该能够处理错误并向客户端显示有意义且易于理解的错误。
为了正确处理异常，我们需要在 Route 代码中添加 try-catch 块，以便能够捕获和处理任何异常情况。 让我们在路由代码中添加一个 catch 块，如下所示：
router.get('/', async (req, res) => {
try {
const articles = await Article.find();
res.json(articles);
} catch (err) {
res.status(500).json({ message: 'Internal server error' });
}
});此时，我们仅仅返回了一个内部服务器错误，这是一个非常笼统的错误对于客户端来说帮助不够。最好的方法是向客户端提供有意义的错误。 您可以添加一个简单的条件语句来返回有意义的错误，如下所示：
if (err.name === 'ValidationError') {
res.status(422).json({ errors: err.errors });
return;
}
res.status(500).json({ message: err.message });结论
在本文中，我们探讨了如何使用 Mongoose 和 Express.js 来构建 RESTful API 并应用最佳实践。我们学习了将 Mongoose 用于模型定义，路由和查询操作；使用 Passport.js 进行身份验证；以及如何适当地处理异常情况等。 通过将这些最佳实践应用到 RESTful API 中，您的应用程序将保持可靠，安全并且存在健壮性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6729f510ddd3a70eb6cecd6c