信息发布→ 登录 注册 退出

laravel如何使用Spatie/laravel-activitylog记录用户活动_Laravel Spatie活动日志记录用户操作教程

发布时间:2025-10-12

点击量:
安装 laravel-activitylog 包并发布配置文件和迁移;2. 通过 LogsActivity trait 自动记录模型变更,如 User 模型的 name 和 email 字段变化;3. 使用 activity() 辅助函数手动记录用户操作,支持指定操作人、对象和附加属性;4. 查询 Activity 模型获取日志,展示操作描述、操作人及时间等信息。

在 Laravel 项目中,记录用户操作日志对审计、调试和安全监控非常有用。Spatie 提供的 laravel-activitylog 是一个功能强大且易于集成的包,可以帮助你轻松记录模型变更、用户行为等操作。下面是一个完整的使用教程,带你快速上手。

安装 laravel-activitylog 包

在你的 Laravel 项目根目录下运行以下命令来安装 Spatie 的活动日志包:

composer require spatie/laravel-activitylog

安装完成后,发布配置文件和迁移文件:

php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider"

这会生成配置文件 config/activitylog.php 和数据库迁移文件。接着运行迁移命令创建 activity_log 表:

php artisan migrate

基本用法:记录模型变更

要自动记录某个模型的创建、更新、删除等操作,只需在模型类中使用 LogsActivity trait,并设置日志属性。

例如,在 User 模型中添加日志记录:

logOnly(['name', 'email']) // 只记录指定字段
            ->setDescriptionForEvent(fn(string $eventName) => "用户被 {$eventName}");
    }
}

这样,当 User 模型的 name 或 email 字段发生变化时,系统会自动写入 activity_log 表。

可选配置说明:

  • logOnly():仅记录指定字段
  • logOnlyDirty():只记录修改过的字段
  • dontLog():排除某些字段不记录
  • setDescriptionForEvent():自定义事件描述

手动记录用户操作

除了自动记录模型变化,你还可以在控制器或服务中手动记录用户行为,比如登录、导出数据、修改设置等。

使用 activity() 辅助函数:

use Illuminate\Http\Request;

public function updateProfile(Request $request)
{
    $user = auth()->user();

    activity()
        ->causedBy($user)
        ->performedOn($user)
        ->withProperties(['ip' => $request->ip()])
        ->log('更新了个人资料');

    // 其他业务逻辑...
}

说明:

  • causedBy():指定操作人(通常是当前用户)
  • performedOn():指定被操作的对象(如模型实例)
  • withProperties():附加额外信息,如 IP、请求参数等
  • log():写入日志消息

查询和展示日志记录

你可以通过 Activity 模型查询所有日志记录:

use Spatie\Activitylog\Models\Activity;

$activities = Activity::with('causer')->latest()->get();

foreach ($activities as $activity) {
    echo $activity->description;         // 如:用户被更新
    echo $activity->causer->name;        // 操作人姓名
    echo $activity->subject_type;        // 被操作的模型名
    print_r($activity->properties);      // 包含旧值、新值等
}

如果启用了 logOnlyDirty(),在 properties 中还能看到 changes 字段,包含 old 和 new 值。

在 Blade 模板中可以这样展示:

@foreach($activities as $log)
    
        {{ $log->causer?->name }}
        {{ $log->description }}
        ({{ $log->created_at->format('Y-m-d H:i') }})
    
@endforeach
基本上就这些。结合模型监听和手动日志,你可以全面掌握用户在系统中的关键操作。
标签:# 数据库  # 带你  # 可选  # 自定义  # 你还  # 只需  # 被操  # 还能  # 你可以  # 是一个  # php  # 事件  # 对象  # 并发  # 配置文件  # ai  # app  # composer  # go  # laravel  
在线客服
服务热线

服务热线

4008888355

微信咨询
二维码
返回顶部
×二维码

截屏,微信识别二维码

打开微信

微信号已复制,请打开微信添加咨询详情!