0

0

在 Laravel/Lumen 事件监听器中保留模型原始状态

聖光之護

聖光之護

发布时间:2025-11-01 12:57:16

|

198人浏览过

|

来源于php中文网

原创

在 Laravel/Lumen 事件监听器中保留模型原始状态

本文探讨了在 laravel/lumen 应用中,当模型在事件派发前被修改并保存后,如何在事件监听器中访问其原始状态的问题。通过详细的代码示例,我们展示了由于 save() 操作导致 getoriginal() 失效的原因,并提供了一种简单有效的解决方案:在模型修改前捕获所需原始数据,并将其作为附加参数传递给事件,确保监听器能够获取到正确的历史数据。

理解模型状态的瞬时性

在 Laravel/Lumen 框架中,使用事件(Events)和监听器(Listeners)模式是扩展模型功能、保持代码整洁的常见做法。然而,当模型在事件派发之前经历修改并保存操作时,监听器可能会面临无法访问模型原始状态的挑战。

考虑一个模型具有 reset 方法,用于将其某些属性设置为 null 并保存:

// 原始的 reset 方法
public function reset()
{
    $this->association_id = null;
    $this->associated_at = null;
    $this->save(); // 模型状态在此处被持久化
}

为了在 reset 操作后添加新的功能,我们引入了事件派发:

// 引入事件派发后的 reset 方法
public function reset()
{
    $this->association_id = null;
    $this->associated_at = null;
    $this->save(); // 此时模型已保存,其属性 association_id 已变为 null

    event(new ResetEvent($this)); // 派发事件,传递的是更新后的模型实例
}

对应的事件和监听器定义如下:

// ResetEvent 类
class ResetEvent
{
    public $myModel;

    public function __construct($myModel)
    {
        $this->myModel = $myModel;
    }
}

// ResetListener 类
class ResetListener
{
    public function handle(ResetEvent $event)
    {
        // 尝试获取 association_id
        $associationId = $event->myModel->association_id; // 此时为 null
        // 尝试获取原始 association_id
        $originalAssociationId = $event->myModel->getOriginal('association_id'); // 此时也为 null

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

核心挑战在于: 当 event(new ResetEvent($this)) 被调用时,$this 指向的模型实例已经通过 save() 方法更新并持久化到数据库。这意味着模型的 association_id 属性已经变为 null。更重要的是,getOriginal() 方法在 save() 调用后也会被重置,其记录的“原始”状态也变成了当前保存后的状态。因此,在监听器中无论是直接访问属性还是使用 getOriginal(),都无法获取到 reset 操作发生之前的 association_id 值。

小羊标书
小羊标书

一键生成百页标书,让投标更简单高效

下载

解决方案:显式传递原始数据

解决此问题的最直接和有效的方法是,在模型属性被修改和保存 之前,显式地捕获监听器可能需要的原始值,并将其作为事件的额外参数传递。

以下是修改后的 reset 方法、ResetEvent 和 ResetListener:

// 修改后的 reset 方法
public function reset()
{
    // 在修改和保存之前,捕获 association_id 的原始值
    $lastAssociation = $this->association_id;

    $this->association_id = null;
    $this->associated_at = null;
    $this->save(); // 模型状态在此处更新

    // 将更新后的模型实例和捕获到的原始值一同传递给事件
    event(new ResetEvent($this, $lastAssociation));
}
// 修改后的 ResetEvent 类
class ResetEvent
{
    public $myModel;
    public $lastAssociationId; // 新增属性,用于存储原始 association_id

    public function __construct($myModel, $lastAssociationId)
    {
        $this->myModel = $myModel;
        $this->lastAssociationId = $lastAssociationId;
    }
}
// 修改后的 ResetListener 类
class ResetListener
{
    public function handle(ResetEvent $event)
    {
        // 现在可以安全地访问原始的 association_id
        $originalAssociationId = $event->lastAssociationId;

        // 同时也可以访问更新后的模型状态
        $currentAssociationId = $event->myModel->association_id; // 此时为 null

        // ... 基于原始和当前数据执行业务逻辑 ...
        echo "模型原始 association_id: " . $originalAssociationId . "\n";
        echo "模型当前 association_id: " . $currentAssociationId . "\n";
    }
}

通过这种方式,$event->lastAssociationId 将始终包含 reset 方法执行前 association_id 的值,而 $event->myModel 则包含 reset 方法执行后(即 save() 之后)的模型最新状态。这使得监听器能够同时访问模型的历史和当前状态,满足了业务逻辑的需求。

注意事项与最佳实践

  1. 选择性传递: 只传递监听器真正需要的原始数据。避免将整个模型克隆或传递过多不必要的原始属性,这可能会增加内存消耗和事件对象的序列化/反序列化开销(尤其是在使用队列时)。
  2. 数据传输对象 (DTO): 如果需要传递的原始状态数据较为复杂或包含多个相关属性,可以考虑创建一个专门的 DTO(Data Transfer Object)来封装这些原始数据,而不是直接在事件中添加多个散列参数。这能提高代码的可读性和维护性。
  3. 事件命名与时机:
    • 如果事件的语义是“即将发生”(例如 UserDeletingEvent),那么在模型修改或保存 之前 派发事件,此时传递的模型实例将是其原始状态。
    • 如果事件的语义是“已发生”(例如 UserDeletedEvent 或本例的 ResetEvent),则通常在模型操作(如 save() 或 delete()) 之后 派发。在这种情况下,显式传递原始数据是获取历史状态的有效手段。
  4. 同步与异步: 本方案适用于同步和异步事件。对于异步事件,传递的原始数据会安全地序列化并传递给队列中的监听器,确保数据完整性。

总结

在 Laravel/Lumen 事件监听器中获取模型原始状态的关键在于理解模型生命周期和 save() 方法对 getOriginal() 的影响。当模型在事件派发前被修改并保存时,模型实例的状态会更新,getOriginal() 也会随之重置。通过在模型属性修改前显式捕获所需原始值,并将其作为附加参数传递给事件,我们可以确保监听器能够准确无误地访问模型的历史数据。这种方法简单、直接且高效,是处理此类场景的推荐实践。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

341

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

295

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

795

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

386

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

146

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

85

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

84

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

696

2026.03.04

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

69

2026.03.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.7万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

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

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