0

0

Laravel 模型观察器与事件系统:精细化控制模型行为与用户活动日志

霞舞

霞舞

发布时间:2025-12-03 11:50:24

|

1000人浏览过

|

来源于php中文网

原创

laravel 模型观察器与事件系统:精细化控制模型行为与用户活动日志

本教程深入探讨 Laravel 模型观察器的 `retrieved` 事件行为,并提供两种解决方案:使用 `Model::withoutEvents()` 精确禁用事件以避免不必要的日志记录,以及利用 Laravel 事件系统高效、解耦地记录用户 IP、User Agent 等活动数据到独立模型,从而实现更灵活、可维护的应用程序逻辑。

1. Laravel 模型观察器 (Observers) 概述

Laravel 的模型观察器(Observers)提供了一种优雅的方式来监听和响应 Eloquent 模型的生命周期事件,例如 created、updated、deleted 和 retrieved 等。它们将模型事件的处理逻辑集中管理,有助于保持模型本身的简洁性,并将相关业务逻辑从控制器或服务中解耦。

在提供的示例中,DictionaryObserver 监听了 Dictionary 模型的多个事件:

// app/Observers/DictionaryObserver.php
class 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)
    {
        // 处理模型删除事件
    }
}

为了使观察器生效,需要在 App\Providers\AppServiceProvider 的 boot 方法中注册它:

// app/Providers/AppServiceProvider.php
use App\Models\Dictionary;
use App\Observers\DictionaryObserver;
use Illuminate\Pagination\Paginator; // 示例中包含

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()

千问APP
千问APP

阿里最强大模型官方AI助手

下载

以下示例展示了如何在 DictionaryController 的 index 方法中利用 withoutEvents() 来避免批量加载时触发 retrieved 事件,同时确保在 show 方法中单独加载时事件正常触发。

// app/Http/Controllers/DictionaryController.php
model = $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

获取用户活动信息:

  • IP 地址: request()->ip() 或 $request->ip()
  • User Agent: request()->userAgent() 或 $request->userAgent()
  • 当前登录用户 ID: auth()->id() 或 Auth::id() (需引入 use Illuminate\Support\Facades\Auth;)

实现方案:使用 Laravel 事件系统 (推荐) 为了实现业务逻辑的解耦和提高代码的可维护性,推荐使用 Laravel 的事件(Events)和监听器(Listeners)系统来记录用户活动。这种模式允许我们将日志记录逻辑从核心业务流程中分离出来。

步骤:

  1. 定义事件 (Event):UserActionLogged 创建一个事件类来封装需要记录的用户活动数据。

    php artisan make:event UserActionLogged
    // app/Events/UserActionLogged.php
    userId = $userId;
            $this->ipAddress = $ipAddress;
            $this->userAgent = $userAgent;
            $this->description = $description;
            $this->companyId = $companyId;
        }
    }
  2. 定义监听器 (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,这样日志操作将在后台队列中异步执行,避免阻塞用户请求。
  3. 注册事件和监听器app/Providers/EventServiceProvider.php 文件的 $listen 属性中,将 UserActionLogged 事件与 LogUserAction 监听器关联起来。

    // app/Providers/EventServiceProvider.php
    

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2677

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1658

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1515

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1419

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1235

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1488

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

PHP WebSocket 实时通信开发
PHP WebSocket 实时通信开发

本专题系统讲解 PHP 在实时通信与长连接场景中的应用实践,涵盖 WebSocket 协议原理、服务端连接管理、消息推送机制、心跳检测、断线重连以及与前端的实时交互实现。通过聊天系统、实时通知等案例,帮助开发者掌握 使用 PHP 构建实时通信与推送服务的完整开发流程,适用于即时消息与高互动性应用场景。

3

2026.01.19

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.9万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 8.2万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号