Spatie Laravel-Activitylog 高级用法：操作变更数组详解

Spatie Laravel-Activitylog 高级用法：操作变更数组详解

laravel-activitylog Log activity inside your Laravel app 项目地址: https://gitcode.com/gh_mirrors/la/laravel-activitylog

理解变更数组操作的重要性

在项目开发中，我们经常需要记录模型数据的变更历史。Spatie的Laravel-Activitylog包提供了强大的活动日志功能，其中变更数组(Changes Array)记录了模型属性修改前后的值对比。但在某些场景下，我们可能需要对默认记录的变更数组进行定制化处理。

管道模式简介

从v4版本开始，该包引入了管道(Pipeline)模式来处理变更数组。这种设计模式允许我们在日志记录过程中插入自定义处理逻辑，实现对变更数组的灵活控制。管道中的每个处理器都能对attributes和old数组进行增删改操作。

创建自定义管道

基本管道结构

每个管道需要实现LoggablePipe接口，并包含handle方法。下面是一个基础模板：

use Spatie\Activitylog\Contracts\LoggablePipe;
use Spatie\Activitylog\EventLogBag;
use Closure;

class CustomLogPipe implements LoggablePipe
{
    public function handle(EventLogBag $event, Closure $next): EventLogBag
    {
        // 在这里处理$event->changes
        
        return $next($event);
    }
}

实际应用示例

假设我们需要从日志中排除某些敏感字段（如密码），可以创建如下管道：

use Illuminate\Support\Arr;

class ExcludeSensitiveFieldsPipe implements LoggablePipe
{
    protected array $sensitiveFields = ['password', 'api_token'];
    
    public function handle(EventLogBag $event, Closure $next): EventLogBag
    {
        foreach ($this->sensitiveFields as $field) {
            Arr::forget($event->changes, ["attributes.{$field}", "old.{$field}"]);
        }
        
        return $next($event);
    }
}

管道的注册与使用

临时注册方式

在需要的地方临时添加管道：

User::addLogChange(new ExcludeSensitiveFieldsPipe());

// 后续操作将应用该管道
$user = User::create(['name' => 'John', 'password' => 'secret']);

全局注册方式

如果希望某个模型始终应用特定管道，可以在模型启动时注册：

class User extends Model
{
    protected static function booted(): void
    {
        static::addLogChange(new ExcludeSensitiveFieldsPipe());
    }
}

重要注意事项

1. 保持数据一致性：修改attributes数组时，必须同步修改对应的old数组，否则变更对比将失去意义。

2. 管道执行顺序：多个管道会按添加顺序依次执行，后添加的管道处理的是前一个管道处理后的结果。

3. 性能考虑：复杂的管道逻辑可能影响性能，特别是在高频变更的场景下。

高级应用场景

数据脱敏处理

除了完全排除字段，还可以对敏感信息进行脱敏：

class MaskSensitiveDataPipe implements LoggablePipe
{
    public function handle(EventLogBag $event, Closure $next): EventLogBag
    {
        if (isset($event->changes['attributes']['email'])) {
            $email = $event->changes['attributes']['email'];
            $event->changes['attributes']['email'] = $this->maskEmail($email);
        }
        
        if (isset($event->changes['old']['email'])) {
            $email = $event->changes['old']['email'];
            $event->changes['old']['email'] = $this->maskEmail($email);
        }
        
        return $next($event);
    }
    
    protected function maskEmail(string $email): string
    {
        // 实现邮箱脱敏逻辑
        return substr($email, 0, 3) . '***' . strstr($email, '@');
    }
}

自定义变更格式

可以修改变更数组的结构以满足特定需求：

class CustomFormatPipe implements LoggablePipe
{
    public function handle(EventLogBag $event, Closure $next): EventLogBag
    {
        $formattedChanges = [];
        
        foreach ($event->changes['attributes'] as $key => $value) {
            $formattedChanges[$key] = [
                'new' => $value,
                'old' => $event->changes['old'][$key] ?? null,
                'changed_at' => now()->toDateTimeString()
            ];
        }
        
        $event->changes = $formattedChanges;
        
        return $next($event);
    }
}

通过灵活运用管道模式，开发者可以完全掌控活动日志中记录的变更内容，满足各种业务场景的需求。

laravel-activitylog Log activity inside your Laravel app 项目地址: https://gitcode.com/gh_mirrors/la/laravel-activitylog