本教程深入探讨 Laravel 模型观察器的 `retrieved` 事件行为，并提供两种解决方案：使用 `Model::withoutEvents()` 精确禁用事件以避免不必要的日志记录，以及利用 Laravel 事件系统高效、解耦地记录用户 IP、User Agent 等活动数据到独立模型，从而实现更灵活、可维护的应用程序逻辑。
1. Laravel 模型观察器 (Observers) 概述
Laravel 的模型观察器（Observers）提供了一种优雅的方式来监听和响应 Eloquent 模型的生命周期事件，例如 created、updated、deleted 和 retrieved 等。它们将模型事件的处理逻辑集中管理，有助于保持模型本身的简洁性，并将相关业务逻辑从控制器或服务中解耦。
在提供的示例中，DictionaryObserver 监听了 Dictionary 模型的多个事件：
// app/Observers/DictionaryObserver.phpclass DictionaryObserver{ public function created(Dictionary $dictionary) { Log::info('yyyyyyyyy'); // 示例：创建时记录日志 } public function retrieved(Dictionary $dictionary) { Log::info('xxxxxxxxxx'.$dictionary); // 示例：检索时记录日志 } public function updated(Dictionary $dictionary) { // 处理模型更新事件 } public function deleted(Dictionary $dictionary) { // 处理模型删除事件 }}
为了使观察器生效，需要在 AppProvidersAppServiceProvider 的 boot 方法中注册它：
// app/Providers/AppServiceProvider.phpuse AppModelsDictionary;use AppObserversDictionaryObserver;use IlluminatePaginationPaginator; // 示例中包含public function boot(){ Paginator::useBootstrap(); // 示例中包含 Dictionary::observe(DictionaryObserver::class);}
2. 理解 retrieved 事件的行为与选择性禁用
retrieved 事件会在模型实例从数据库中被检索出来时触发。这意味着无论是通过 find() 获取单个模型，还是通过 get()、paginate() 获取模型集合，retrieved 事件都会为每一个被加载的模型实例触发一次。
问题描述：用户希望 DictionaryObserver 中的 retrieved 方法只在编辑或查看单个字典记录时触发（例如，记录用户查看了某个具体记录的行为），但在列表页（index 方法）批量加载字典记录时禁用它，以避免不必要的日志记录或性能开销。
解决方案：使用 Model::withoutEvents()Laravel 提供了一个静态方法 Model::withoutEvents()，它允许你在一个回调函数内部执行 Eloquent 操作，而不会触发任何与该模型相关的事件（包括观察器和事件监听器）。这正是解决批量加载时禁用 retrieved 事件的理想方法。
示例代码：在控制器中应用 withoutEvents()
以下示例展示了如何在 DictionaryController 的 index 方法中利用 withoutEvents() 来避免批量加载时触发 retrieved 事件，同时确保在 show 方法中单独加载时事件正常触发。
// app/Http/Controllers/DictionaryController.phpmodel = $model; } public function index(Request $request) { // 使用 withoutEvents() 包装查询，确保在批量获取时不会触发 retrieved 事件 $dictionaries = Dictionary::withoutEvents(function () use ($request) { $query = $this->model ->orderBy($request->column ?? 'created_at', $request->order ?? 'desc'); if ($request->search) { $query->where(function ($q) use ($request) { $q->where('name', 'like', '%' . $request->search . '%') ->orWhere('id', 'like', '%' . $request->search . '%'); }); } return $query->paginate($request->per_page); }); return DictionaryResource::collection($dictionaries); } // 对于单条记录的编辑或查看，例如 show 方法，则无需使用 withoutEvents() // 这样 retrieved 事件会正常触发，达到记录单条访问的目的。 public function show(Dictionary $dictionary) { // 此处 $dictionary 会触发 retrieved 事件，因为没有使用 withoutEvents() // DictionaryObserver 的 retrieved 方法会在此处被调用 Log::info('用户查看了字典条目：' . $dictionary->id . ' - ' . $dictionary->name); return new DictionaryResource($dictionary); } // ... 其他方法如 create, store 等}
工作原理：withoutEvents() 方法接受一个闭包作为参数。在该闭包内部执行的所有 Eloquent 操作，对于 Dictionary 模型而言，都不会触发其注册的观察器或事件监听器。一旦闭包执行完毕，事件系统将恢复正常，后续的 Eloquent 操作会继续触发事件。通过这种方式，我们可以精确控制 retrieved 事件的触发时机，使其仅在需要记录单个记录访问的场景下生效。
3. 记录用户活动数据 (IP, User Agent 等)
需求：将用户 IP 地址、User Agent、当前登录用户 ID 和操作描述等信息保存到 Action 模型中，用于记录用户行为日志。
// app/Models/Action.php<?phpnamespace AppModels;use IlluminateDatabaseEloquentModel;use IlluminateDatabaseEloquentSoftDeletes;class Action extends Model{ use SoftDeletes; // 假设有 ScopeActiveTrait，此处简化 protected $guarded = ['id']; protected $fillable = [ 'company_id', 'user_id', 'ip', 'user_agent', 'description' ]; protected $dates = [ 'deleted_at', 'created_at', 'updated_at' ];}
获取用户活动信息：
IP 地址： request()->ip() 或 $request->ip()User Agent： request()->userAgent() 或 $request->userAgent()当前登录用户 ID： auth()->id() 或 Auth::id() (需引入 use IlluminateSupportFacadesAuth;)
实现方案：使用 Laravel 事件系统 (推荐)为了实现业务逻辑的解耦和提高代码的可维护性，推荐使用 Laravel 的事件（Events）和监听器（Listeners）系统来记录用户活动。这种模式允许我们将日志记录逻辑从核心业务流程中分离出来。
步骤：
定义事件 (Event)：UserActionLogged创建一个事件类来封装需要记录的用户活动数据。
php artisan make:event UserActionLogged
// app/Events/UserActionLogged.phpuserId = $userId; $this->ipAddress = $ipAddress; $this->userAgent = $userAgent; $this->description = $description; $this->companyId = $companyId; }}
定义监听器 (Listener)：LogUserAction创建一个监听器类来处理 UserActionLogged 事件，并将数据保存到 Action 模型。
php artisan make:listener LogUserAction --event=UserActionLogged
// app/Listeners/LogUserAction.php $event->companyId, // 根据实际情况传递或获取 'user_id' => $event->userId, 'ip' => $event->ipAddress, 'user_agent' => $event->userAgent, 'description' => $event->description, ]); }}
异步处理提示： 如果日志记录操作可能耗时（例如涉及大量数据写入或外部服务调用），可以将监听器实现 ShouldQueue 接口，并使用 InteractsWithQueue trait，这样日志操作将在后台队列中异步执行，避免阻塞用户请求。
注册事件和监听器在 app/Providers/EventServiceProvider.php 文件的 $listen 属性中，将 UserActionLogged 事件与 LogUserAction 监听器关联起来。
// app/Providers/EventServiceProvider.php<?phpnamespace AppProviders;use IlluminateAuthEventsRegistered;use IlluminateAuthListenersSendEmailVerificationNotification;use IlluminateFoundationSupportProvidersEventServiceProvider as ServiceProvider;use IlluminateSupportFacadesEvent;
以上就是Laravel 模型观察器与事件系统：精细化控制模型行为与用户活动日志的详细内容，更多请关注php中文网其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1340271.html
微信扫一扫 
支付宝扫一扫 
