`DamienHarper/auditor-bundle`安装与使用指南

DamienHarper/auditor-bundle安装与使用指南

auditor-bundleThe missing audit log library项目地址:https://gitcode.com/gh_mirrors/au/auditor-bundle

---

项目目录结构及介绍

auditor-bundle 是一个专为Symfony框架设计的审计日志集成库，旨在自动记录所有受监控实体的数据库变更。以下是典型的项目结构概述，基于该开源库的一般实践：

• src: 包含核心组件和类文件，如审计实体和事件监听器。
  • Auditor: 主要逻辑实现区域。
  • EventSubscriber: 监听并响应特定的Symfony事件，比如实体更新。
• Resources:
  • config: 提供预定义的配置文件示例，用于快速集成到你的应用中。
  • templates: 包含可能的视图模板，用于展示审计日志。
• tests: 单元测试和集成测试，确保代码质量。
• docs: 官方文档或额外说明，尽管主要文档位于在线仓库页面。
• composer.json: 管理依赖关系和版本控制的文件。
• .gitignore: 指定在Git版本控制中忽略的文件或目录。

---

项目的启动文件介绍

在auditor-bundle的上下文中，启动并不是通过单一的“启动文件”进行的，而是通过以下步骤集成到你的Symfony应用中：

1. Composer安装: 使用Composer添加依赖到你的项目中。

   composer require damienharper/auditor-bundle
   

2. 配置启用: 在你的Symfony应用的config/bundles.php文件中启用此bundle。

   return [
       // ...
       DamienHarper\Auditor\Bundle\AuditorBundle::class => ['all' => true],
       // ...
   ];
   

3. 服务配置: 更新你的应用程序的配置文件（通常是services.yaml），以配置审计功能，例如指定审计事件监听器和存储设置。

---

项目的配置文件介绍

配置auditor-bundle主要是通过修改Symfony的配置文件来完成的。通常涉及到以下几个关键步骤：

1. 基础配置: 在config/packages/auditor.yaml（如果你创建了这个文件）或者在你的主配置文件中加入审计相关配置。

   # config/packages/auditor.yaml
   damien_harper_auditor:
     enable: true
     metadata_driver: 'annotation' # 或者其他支持的驱动，如yaml, xml等
     # 根据需求配置更多的审计选项，例如被审计的实体列表等。
   

2. 审计实体标记: 在你的实体类上使用注解（如@Auditee）来标记哪些实体需要被审计。

3. 数据库表结构调整: 运行数据库迁移或更新命令，让bundle自动为新添加的可审计实体创建对应的审计日志表。

请注意，具体的配置细节和文件位置可能会根据实际使用的Symfony版本以及auditor-bundle的版本有所不同。务必参考其最新的官方文档来获取最精确的信息。

auditor-bundleThe missing audit log library项目地址:https://gitcode.com/gh_mirrors/au/auditor-bundle