Sonata Project EntityAudit Bundle 教程

Sonata Project EntityAudit Bundle 教程

EntityAuditBundleAudit for Doctrine Entities项目地址:https://gitcode.com/gh_mirrors/en/EntityAuditBundle

项目介绍

Sonata Project 的 EntityAudit Bundle 是一个基于 Doctrine 2 的扩展，其设计理念受到了 Hibernate Envers 的启发。这个工具提供了一个全面的实体版本控制功能，包括实体及其关联关系的完整历史记录。它通过为每个被审计的实体表创建一个镜像表（以 "_audit" 后缀），来实现这一目标。这些审计表包含了原实体的所有列以及两个额外字段：rev（记录修订版本）和相关修订的具体信息。

技术栈

• PHP
• Symfony Bundle
• Doctrine 2
• MIT 许可证

项目快速启动

要快速开始使用 EntityAudit Bundle，首先确保你的 Symfony 应用已经准备好了必要的依赖环境。

1. 安装依赖 在你的 Symfony 项目的根目录下，使用 Composer 添加此bundle：

   composer require sonata-project/entity-audit-bundle
   

2. 配置Bundle 接下来，在 config/bundles.php 文件中添加以下条目以启用该bundle：

   return [
       // ...
       Sonata\DashboardBundle\SonataDashboardBundle::class => ['all' => true],
       Sonata\AdminBundle\SonataAdminBundle::class => ['all' => true],
       Sonata\DoctrineORMAdminBundle\SonataDoctrineORMAdminBundle::class => ['all' => true],
       Sonata\MediaBundle\SonataMediaBundle::class => ['all' => true],
       Sonata\UserBundle\SonataUserBundle::class => ['all' => true],
       Sonata\Project\EntityAuditBundle\SonataProjectEntityAuditBundle::class => ['all' => true], // 新增这一行
   ];
   

3. 基础配置 在 config/packages/entity_audit.yaml 中，指定要审计的实体：

   simple_things_entity_audit:
     audited_entities:
       - App\Entity\YourAuditedEntity
       - App\Entity\AnotherAuditedEntity
   

4. 数据库迁移 根据新的配置生成并执行数据库迁移以创建审计表。

5. 启动应用 确保所有配置正确后，重启你的Symfony开发服务器，开始使用审计功能。

应用案例与最佳实践

在实际应用中，EntityAudit Bundle非常适合于金融系统、法律文档管理系统或任何需要追踪数据变更历史的场景。最佳实践建议：

• 使用全局忽略列（如自动时间戳created_at, updated_at）避免不必要的修订记录。
• 对敏感数据进行适当的处理，保证审计日志的安全性。
• 结合其他Sonata bundles如Admin Bundle，可以直观地查看审计记录。

典型生态项目

Sonata Project的EntityAudit Bundle通常与Sonata Admin Bundle一起使用，它允许开发者在一个友好的界面中浏览和管理审计信息。此外，结合Symfony生态系统中的其他组件，如 Doctrine ORM 和 security 组件，能够构建出强大的数据管理解决方案，确保数据透明度和可追溯性。

通过遵循上述步骤，您将能够有效地在您的Symfony应用中集成版本控制，利用EntityAudit Bundle的强大功能进行实体的全面审计。

EntityAuditBundleAudit for Doctrine Entities项目地址:https://gitcode.com/gh_mirrors/en/EntityAuditBundle