前言
随着项目的不断扩大，数据库中的数据也变得越来越复杂，很多公司都在使用 ORM 框架来管理数据库。通过 ORM 框架，我们可以轻松创建、修改、查询和删除数据库中的数据，并且 ORM 框架也为我们提供了方便的数据验证、数据关联等功能。sequelize 作为 Node.js 中最受欢迎的 ORM 框架之一，其拥有强大而灵活的数据模型和查询 API，让我们更加轻松地管理数据库。
但是在某些时候，我们需要根据业务要求对数据库中的数据进行审计。例如在一个电商平台中，我们需要记录商品的上下架、价格的变动和订单状态的变化等信息。这时候，sequelize-audit 就会变得非常有用。
sequelize-audit 是 sequelize 的一个插件，它通过在数据模型中增加一些特殊字段（例如 created_by、updated_by、deleted_by、deleted_at 等）来记录数据的历史变化情况，以及对数据的审计记录。在本文中，我们将介绍如何在 sequelize 中使用 sequelize-audit 进行数据库审计。
安装 sequelize-audit
在开始使用 sequelize-audit 之前，我们需要先安装该插件。打开终端，进入项目目录，执行以下命令：
npm install --save sequelize-audit
安装完成后，我们可以在项目的 package.json 文件中看到 sequelize-audit 已经被添加到了依赖中。
使用 sequelize-audit
为了方便说明，我们假设已经有了一个名为 Product 的数据模型。下面，我们将展示如何使用 sequelize-audit 对 Product 进行审计。
添加 sequelize-audit
首先，在 Product 的定义文件 model/Product.js 中引入 sequelize-audit：
-- -------------------- ---- ------- ----- --------- - --------------------- ----- -------------- - --------------------------- ----- --------- - ------------------------ ----- ------- - --------------------------- - ----- ----------------- ------ ------------------ --------- ------------------ --- ------------------------
在这段代码中，我们通过调用 sequelizeAudit(Product) 把 sequelize-audit 添加到了 Product 模型中。运行上面的代码后，我们会发现在 Product 模型中多了几个字段，例如 created_by、updated_by、deleted_at 等。
监听 sequelize-audit 事件
在使用 sequelize-audit 时，我们可以监听 sequelize-audit 的事件来获取审计信息。sequelize-audit 提供了 4 个事件：
- beforeAudit：在将数据写入数据库前触发，此时 audit 数据还没有被添加到数据中。
- audit：在将数据写入数据库后触发，此时 audit 数据已经被添加到数据中。
- beforeRestore：在将数据从数据库中恢复时触发，此时 audit 数据还没有被恢复。
- restore：在将数据从数据库中恢复后触发，此时 audit 数据已经被恢复。
我们可以通过在模型中定义这些事件对 sequelize-audit 进行监听：
-- -------------------- ---- ------- ------------------------------ --------- ---------- -------- -- - ----------------- ------- ----- -------- ---------- --------- --- ------------------------ --------- ---------- -------- -- - --------------- ------- ------- -------- ---------- --------- --- -------------------------------- --------- -------- -- - ----------------- ------- ----- -------- --------- --- -------------------------- --------- -------- -- - --------------- ------- ------- -------- --------- ---
在上面的代码中，我们分别定义了 beforeAudit、audit、beforeRestore 和 restore 几个事件，并在每个事件中输出了相应的信息。运行以上代码，我们就可以在控制台中查看相应的信息了。
执行增删改查操作
使用 sequelize-audit 后，我们可以像平常一样对 Product 进行增删改查操作。例如，我们可以创建一个新的 Product：
Product.create({
name: 'Apple Watch',
price: 2599,
quantity: 10,
});在创建 Product 时，sequelize-audit 会自动添加 audit 数据到数据模型中。我们可以通过查询查看 Product 的审计信息：
Product.findAll({
where: {
name: 'Apple Watch',
},
});在查询时，sequelize-audit 会自动将与 Product 相关的 audit 数据查询出来，以便我们查看审计信息。
此外，sequelize-audit 还支持更新和删除操作，并可以记录审计信息。例如，我们可以更新一个 Product：
-- -------------------- ---- -------
---------------
-
------ -----
--
-
------ -
----- ------ -------
--
-
--在更新 Product 时，sequelize-audit 会自动记录审计信息。我们可以通过查询查看 Product 的审计信息：
-- -------------------- ---- -------
-----------------
------ -
----- ------ -------
--
-------- --
------ -------------------------------
--- --------
--
---在查询时，我们需要使用 include 属性把与 Product 相关的 audit 数据查询出来。
恢复数据
在有些情况下，我们可能需要恢复被删除的数据。sequelize-audit 也可以帮助我们完成这个操作。例如，我们可以删除一个 Product：
Product.destroy({
where: {
name: 'Apple Watch',
},
});在删除 Product 时，sequelize-audit 会自动记录审计信息。我们可以通过查询查看 Product 的审计信息：
-- -------------------- ---- -------
-----------------
------ -
----- ------ -------
--
--------- ------
-------- --
------ -------------------------------
--- --------
--
---在查询时，我们需要设置 paranoid 属性为 false，以便查询已经被删除的数据。此时，我们可以通过 audit 数据的 restore() 方法来恢复数据：
product.audit[0].restore();
在执行 restore() 方法后，sequelize-audit 会自动在数据库中恢复该条数据，并记录审计信息。
总结
sequelize-audit 是一个非常有用的 sequelize 插件，它可以帮助我们轻松地对数据库中的数据进行审计。在本文中，我们介绍了如何使用 sequelize-audit 对 sequelize 数据模型进行添加、更新、删除和查询操作，并且展示了如何通过监听 sequelize-audit 的事件来获取审计信息。sequelize-audit 不仅可以帮助我们实现数据审计的需求，同时也提供了学习和研究 sequelize 的良好案例。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005538681e8991b448d0b5b
