Mongoose 是 Node.js 的一个 ORM 框架，用于简化与 MongoDB 数据库的交互。Mongoose 提供了许多有用的功能，其中包含生命周期 hooks。在本文中，我们将介绍这些生命周期 hooks 并详细阐述它们在 Mongoose 中的使用方法。
什么是生命周期 hooks？
生命周期 hooks 是在 Mongoose 模型的操作期间调用的函数。这些函数允许开发人员对模型的不同操作进行重写、添加或拦截。Mongoose 生命周期 hooks 分为四种类型：
- Save Hooks：在保存文档之前或之后运行，这些 hooks 可以用于验证和修改文档。
- Query Hooks：在执行查询之前或之后运行，这些 hooks 可以用于修改查询参数或添加附加操作。
- Aggregate Hooks：在聚合操作之前或之后运行，这些 hooks 可以用于自定义聚合操作以及聚合结果。
- Document Hooks：在文档初始化、验证、保存、删除之前或之后运行，这些 hooks 可以用于添加自定义逻辑到文档操作中。
如何使用生命周期 hooks
在 Mongoose 中，可以通过在模型的 Schema 中定义 hooks 来使用生命周期 hooks。下面是一个简单的示例：
----- ---------- - --- -----------------
----- -------
------ -------
---
---------------------- -------- ------ -
------------------- ----------
-------
---
----- ---- - ---------------------- ------------
----- ---- - --- ------
----- ----- -----
------ ----------------
---
------------在这个示例中，我们定义了一个 User 模型，并通过 pre 方法向其添加了一个 save hook。在这个 hook 中，我们打印出一个日志信息并调用了 next 函数以继续执行操作。
当我们执行 user.save() 操作时，我们会在控制台中看到以下输出：
------ -------
生命周期 hooks 的详细说明
Save Hooks
Save Hooks 是一种用于在保存文档之前或之后运行的 Mongoose 生命周期 hooks。Save Hooks 可以在模型上执行两个操作：pre('save') 和 post('save')。
pre('save')
pre('save') hook 在保存文档之前执行。这个 hook 可以用于对文档进行验证或修改。如果 next(error) 被调用了，Mongoose 将在保存文档时抛出一个错误。
下面是一个示例，说明如何在保存文档之前对文档进行验证：
---------------------- -------- ------ -
-- ----------------------------- - -- ----------
-- ----------
------------------ -------- ----- ----- -
-- ----- -
------ ----------
-
-------------------------- ----- -------- ----- ----- -
-- ----- -
------ ----------
-
------------- - ----- -- ---------
-------
---
---
- ---- -
-------
-
---这个 hook 会在保存文档之前检查用户是否正在修改密码。如果是，则使用 bcrypt 将密码哈希化，并将哈希值保存为密码。
post('save')
post('save') hook 在保存文档之后执行。这个 hook 可以用于在保存后处理文档，也可以跟踪用户对文档的操作。
下面是一个示例，说明如何在保存文档之后跟踪用户对文档的操作：
----------------------- -------- ----- ----- -
-- ----------- - -- ---------
---------------- ---- ----------
- ---- -
----------------- ----------
-
-------
---这个 hook 会在保存文档之后打印出消息，以表示用户对文档的操作状态。如果文档是新创建的，就会打印出 "New user created"，否则就会打印出 "User updated"。
Query Hooks
Query Hooks 是一种用于在执行查询之前或之后运行的 Mongoose 生命周期 hooks。Query Hooks 可以在模型上执行四个操作：pre('find')、pre('findOne')、pre('update') 和 pre('remove')。
pre('find') 和 pre('findOne')
pre('find') 和 pre('findOne') hooks 在执行查询之前执行，并且可以用于修改查询参数。
下面是一个示例，说明如何在查询参数中引入一个附加过滤器：
---------------------- -------- -- -
------------ ---------- - ---- ---- - ---
---这个 hook 会在查询之前将 { isDeleted: { $ne: true } } 添加到查询条件中，从而排除已删除的用户。
pre('update')
pre('update') hook 在更新文档之前执行，并且可以用于修改更新操作的查询参数。
下面是一个示例，说明如何在更新文档之前将修改者信息添加到更新集合中：
------------------------ -------- -- -
---------- ---------- --- ------ --- -- ------
-- ------------------- - -- -- ---- -----
---------- --------------- -------------------- ---
---------- ----------------- ---------------------- ---
-
---这个 hook 在更新集合之前将 updatedAt 操作和 updatedBy 操作添加到集合中。如果使用了 $set 操作符，则会添加到 updatedBy 操作和 updatedAt 操作中。
pre('remove')
pre('remove') hook 在删除文档之前执行，并且可以用于在删除操作之前进行验证或拦截。
下面是一个示例，说明如何在删除文档之前进行验证：
------------------------ -------- ------ -
-- ------------------
------------- ------- --------- ------- - ---- ----------- - -- -------- ----- ------ -
-- ----- -
------ ----------
-
-- ------ - -- -
------ -------- ------------- ------ ---- ---- ------- ----------
- ---- -
-------
-
---
---这个 hook 在删除文档之前会检查用户是否有未完成的订单。如果有，则会抛出一个错误并阻止删除操作。如果没有，则可以继续进行删除操作。
Aggregate Hooks
Aggregate Hooks 是一种用于在执行聚合操作之前或之后运行的 Mongoose 生命周期 hooks。Aggregate Hooks 可以在模型上执行两个操作：pre('aggregate') 和 post('aggregate')。
pre('aggregate')
pre('aggregate') hook 在执行聚合操作之前执行，并且可以用于添加自定义聚合操作。
下面是一个示例，说明如何向聚合操作中添加附加操作：
--------------------------- -------- -- -
------------- ------- - --------- ---- - --- -- -- ------ ---
---这个 hook 在聚合操作之前添加了一个 $match 操作符，从而只返回已激活的用户。
post('aggregate')
post('aggregate') hook 在执行聚合操作之后执行，并且可以用于处理聚合结果。
下面是一个示例，说明如何在聚合操作之后处理结果：
---------------------------- -------- -------- -
-------------------- -- ------
---这个 hook 在聚合操作之后输出聚合结果。
Document Hooks
Document Hooks 是一种用于在文档初始化、验证、保存、删除之前或之后运行的 Mongoose 生命周期 hooks。Document Hooks 可以在模型上执行八个操作：pre('init')、post('init')、pre('validate')、post('validate')、pre('save')、post('save')、pre('remove') 和 post('remove')。
pre('init') 和 post('init')
pre('init') 和 post('init') hooks 在初始化文档之前和之后执行，可以用于对文档进行设置。在这些 hooks 中，无法更改模型的验证规则。
下面是一个示例，说明如何在初始化文档之前添加自定义属性到文档中：
---------------------- -------- -- -
------------- - ------------------ ------------------
---
----------------------- -------- ----- -
---------------- ---- ------------ ------------------
---这个 hook 添加了一个 fullName 属性到文档中，并在初始化之后打印出消息。
pre('validate') 和 post('validate')
pre('validate') 和 post('validate') hooks 在完成对文档的非自定义验证之前和之后执行。
下面是一个示例，说明如何在验证文档之前和之后添加自定义验证：
-------------------------- -------- -- -
-- ------------ -
---------- - -------------------------
-
---
--------------------------- -------- ----- -
-- -------- - --- -
------- - ---
-
---这个 hook 在验证文档之前将电子邮件地址转换为小写，并在验证之后将未满 18 岁的用户的年龄强制设为 18 岁。
pre('save') 和 post('save')
pre('save') 和 post('save') hooks 在保存文档之前和之后执行，并可以用于在文档被保存之前和之后进行后期处理。
下面是一个示例，说明如何在保存文档之前和之后添加自定义逻辑：
---------------------- -------- ------ -
-- --------------- -
------------ - --- ------- -- -----------------------
-
-------
---
----------------------- -------- ----- -
----------------- ------ -------------
---这个 hook 在保存文档之前检查文档是否已经创建，并在保存之后打印出消息。
pre('remove') 和 post('remove')
pre('remove') 和 post('remove') hooks 在删除文档之前和之后执行，并可以用于在文档被删除之前和之后进行后期处理。
下面是一个示例，说明如何在删除文档之前和之后添加自定义逻辑：
------------------------ -------- ------ -
------------------ ------- -------- -- -------- ----- - -- ------------
-- ----- -
------ ----------
-
-------
---
---
------------------------- -------- ----- -
----------------- -------- -------------
---这个 hook 在删除文档之前删除与当前用户关联的订单，并在删除之后打印出消息。
结论
在 Mongoose 中使用生命周期 hooks 使开发人员能够在文档的操作期间重写、添加或拦截逻辑。在本文中，我们介绍了四种类型的 hooks，包含它们在 Mongoose 中的使用方法以及示例代码。使用生命周期 hooks，开发人员可以将定制处理逻辑集成到 Mongoose 模型中，从而提高代码的可重用性和可维护性。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/67063f51d91dce0dc85a8811