Laravel Auditable 项目教程

Laravel Auditable 项目教程

laravel-auditable Basic Auditable package for Eloquent Model. 项目地址: https://gitcode.com/gh_mirrors/la/laravel-auditable

1. 项目介绍

Laravel Auditable 是一个简单的 Laravel 审计包，适用于 Eloquent 模型。该包能够自动在数据库表中插入和更新审计日志，记录谁创建和最后更新了记录。通过使用这个包，开发者可以轻松地跟踪模型的变更历史，确保数据的完整性和可追溯性。

2. 项目快速启动

安装

首先，通过 Composer 安装 Laravel Auditable 包：

composer require yajra/laravel-auditable:^11

发布配置文件

如果需要修改 withDefault 选项，可以发布配置文件：

php artisan vendor:publish --tag=auditable

使用

1. 更新模型迁移文件：

   在模型的迁移文件中，使用 auditable() 方法添加 created_by 和 updated_by 字段：

   Schema::create('users', function (Blueprint $table) {
       $table->increments('id');
       $table->string('name', 100);
       $table->auditable();
       $table->timestamps();
   });
   

2. 在模型中使用 AuditableTrait：

   在模型中使用 AuditableTrait：

   namespace App;
   
   use Yajra\Auditable\AuditableTrait;
   use Illuminate\Database\Eloquent\Model;
   
   class User extends Model
   {
       use AuditableTrait;
   }
   

3. 软删除：

   如果使用 Laravel 的软删除功能，可以使用 auditableWithDeletes() 方法：

   Schema::create('users', function (Blueprint $table) {
       $table->increments('id');
       $table->string('name', 100);
       $table->auditableWithDeletes();
       $table->timestamps();
       $table->softDeletes();
   });
   

   在模型中使用 AuditableWithDeletesTrait：

   namespace App;
   
   use Yajra\Auditable\AuditableWithDeletesTrait;
   use Illuminate\Database\Eloquent\Model;
   use Illuminate\Database\Eloquent\SoftDeletes;
   
   class User extends Model
   {
       use AuditableWithDeletesTrait, SoftDeletes;
   }
   

3. 应用案例和最佳实践

应用案例

假设你正在开发一个用户管理系统，需要记录每个用户的创建者和最后更新者。使用 Laravel Auditable 包，你可以轻松实现这一功能。

最佳实践

1. 统一审计日志：

   在多个模型中使用 AuditableTrait，确保所有重要数据的变更都能被记录下来。

2. 自定义审计字段：

   如果需要记录更多的审计信息，可以在模型中添加自定义字段，并在 auditable() 方法中进行配置。

3. 定期清理审计日志：

   对于历史数据，可以定期清理旧的审计日志，以减少数据库的存储压力。

4. 典型生态项目

Laravel Auditing

Laravel Auditing 是另一个流行的 Laravel 审计包，提供了更丰富的功能，如自定义审计字段、审计事件监听等。如果你需要更高级的审计功能，可以考虑使用 Laravel Auditing。

Laravel ActivityLog

Laravel ActivityLog 是一个用于记录用户活动的包，可以记录用户的操作历史，适用于需要详细记录用户行为的场景。

通过结合使用这些生态项目，可以构建一个功能强大的审计和日志系统，满足不同业务需求。

laravel-auditable Basic Auditable package for Eloquent Model. 项目地址: https://gitcode.com/gh_mirrors/la/laravel-auditable