Composer在线学习地址：学习地址
救星登场：Sonata Entity Audit Bundle
经过一番调研，我们找到了一个完美的解决方案：sonata-project/entity-audit-bundle。这个强大的 Doctrine 扩展包，灵感来源于 Hibernate Envers，能够为你的 Doctrine 实体及其关联关系提供完整的版本控制和审计功能。它的核心思想是，每当一个被审计的实体发生插入、更新或删除操作时，都会自动记录下当前实体的完整状态，并关联一个全局的修订版本号。
Sonata Entity Audit Bundle 的工作原理
这个 Bundle 的巧妙之处在于它的实现方式：
-
审计表（
_audit表）：对于每一个你选择进行审计的实体，它都会在数据库中创建一个对应的“镜像”表，命名规则通常是[原始表名]_audit。这个审计表会包含原始实体表的所有字段，并额外增加两个关键字段：-
rev：一个全局的修订版本号，来源于一个独立的revisions表。 -
revtype：表示本次变更的类型，可以是'INS'(插入),'UPD'(更新) 或'DEL'(删除)。
-
-
修订表（
revisions表）：这个表记录了每一次修订的元数据，包括一个唯一的id(即rev字段的值),timestamp(变更发生的时间),username(执行变更的用户) 和comment(可选的变更备注)。 - SchemaTool 集成：该 Bundle 会钩入 Doctrine 的 SchemaTool 生成过程，因此在更新数据库 Schema 时，它会自动为被审计的实体创建所需的审计表和修订表，无需手动编写 DDL 语句。
通过这种机制，我们不仅可以知道实体在某个时间点的完整状态，还能追溯到是谁、在什么时候、做了什么类型的修改。
如何使用 Composer 轻松集成
集成 sonata-project/entity-audit-bundle 到你的 Symfony 项目中非常简单，Composer 再次发挥了其包管理器的强大作用。
1. 安装 Bundle
首先，使用 Composer 安装该 Bundle：
composer require sonata-project/entity-audit-bundle
2. 启用 Bundle
在 config/bundles.php 文件中启用该 Bundle：
// config/bundles.php
return [
// ...
SimpleThings\EntityAudit\SimpleThingsEntityAuditBundle::class => ['all' => true],
// ...
];3. 配置审计实体
在 config/packages/entity_audit.yaml 文件中，指定你需要审计的实体类：
# config/packages/entity_audit.yaml
simple_things_entity_audit:
audited_entities:
- App\Entity\Product # 替换为你的实体类
- App\Entity\Order # 替换为你的实体类
# 可选：全局忽略某些字段，例如创建时间、更新时间，避免不必要的修订记录
global_ignore_columns:
- created_at
- updated_at
# 可选：如果你使用非默认的 Doctrine 连接或实体管理器
# connection: custom_connection_name
# entity_manager: custom_entity_manager_name4. 更新数据库 Schema
运行 Doctrine 命令来生成并执行新的数据库 Schema 变更，这将创建所有必要的 _audit 表和 revisions 表：
php bin/console doctrine:schema:update --force # 或者先查看SQL再执行 # php bin/console doctrine:schema:update --dump-sql
至此，你的实体审计功能就已配置完毕！
实际应用：查询与查看审计数据
配置完成后，当你的 Product 或 Order 实体发生任何修改时，_audit 表都会自动记录下这些变更。那么，我们如何查询这些历史数据呢？
1. 使用 AuditReader 查询
你可以通过 AuditReader 服务来获取审计信息：
findRevisions(Product::class, $id);
$history = [];
foreach ($revisions as $revision) {
// 获取该产品在特定修订版本时的状态
$productAtRevision = $auditReader->find(Product::class, $id, $revision->getRev());
$history[] = [
'revision_id' => $revision->getRev(),
'timestamp' => $revision->getTimestamp()->format('Y-m-d H:i:s'),
'username' => $revision->getUsername() ?: '未知',
'revtype' => $productAtRevision->getRevType(), // Bundle会在审计实体中添加这个方法
'price' => $productAtRevision->getPrice(),
'name' => $productAtRevision->getName(),
// ... 其他你关心的字段
];
}
return $this->render('audit/product_history.html.twig', [
'product_id' => $id,
'history' => $history,
]);
}
}2. 内置的审计界面
sonata-project/entity-audit-bundle 还提供了一个开箱即用的 Web 界面，让你无需编写任何前端代码即可查看审计数据。你只需要在 config/routes.yaml 中导入它的路由：
# config/routes.yaml
simple_things_entity_audit:
resource: "@SimpleThingsEntityAuditBundle/Resources/config/routing/audit.xml"
prefix: /audit # 审计界面的访问前缀，记得要对其进行安全保护！导入后，访问 /audit 路径，你就能看到一个功能完善的审计管理界面，包括：
- 修订列表：查看所有修订记录，包括时间、操作用户。
- 修订详情：查看某个修订中所有被修改的实体。
- 实体历史：查看某个特定实体的所有历史版本。
- 版本对比：比较同一个实体在两个不同修订版本之间的差异。
这个界面极大地提升了审计数据的可读性和管理效率。
总结与优势
通过 sonata-project/entity-audit-bundle，我们彻底解决了数据变更追溯的难题，带来了以下显著优势：
- 数据可追溯性：轻松了解任何关键实体在历史上的每一个变更，包括变更内容、时间、操作人。
- 增强数据完整性：为数据异常提供快速诊断依据，必要时可以根据历史数据进行恢复。
- 提升合规性：对于需要满足审计要求的业务场景，提供了自动化的历史记录，简化了合规流程。
- 简化开发：无需手动编写复杂的日志逻辑，Bundle 自动处理所有审计细节。
- 开箱即用：内置的 Web 界面和强大的查询 API，让审计数据的使用变得异常简单。
借助 Composer 的便捷安装，以及 sonata-project/entity-audit-bundle 的强大功能，我们的项目在数据管理和问题排查方面都取得了质的飞跃。如果你也正被实体数据变更的迷雾所困扰，不妨尝试一下这个优秀的 Bundle，它一定会成为你项目中的得力助手！
