ORM Observer 使用小结(坑点预警)

前言

最近开发新的项目不是基于完整的 laravel 框架,框架是基于 laravel ORM 的简单MVC模式。随着项目的成熟和业务需求,需要引入事件机制。简单地浏览了一下 symfony、laravel 的事件机制,都是依赖于 container 的。感觉如果引入的话开销有点大,在寻觅更好解决方案过程中发现 ORM 居然自带事件机制,完全足够目前的业务需求,又不需要改动框架,简直不能太棒!这里简单的记录一下orm observe 的使用吧。

事件触发流程

由于 ORM 事件是针对 Model 的,所以本身结合 Model 封装了一些基础的事件。感觉基本上是够使用了,如果需要添加额外事件的话,ORM 也提供了 setObservableEvents()供使用。

public function getObservableEvents()
    {
        return array_merge(
            [
                'creating', 'created', 'updating', 'updated',
                'deleting', 'deleted', 'saving', 'saved',
                'restoring', 'restored',
            ],
            $this->observables
        );
    }

我们都知道 ORM 无论是 create 还是 update 本质是 save。因此分析一下 ORM save 时底层流程是:

public function save(array $options = [])
    {
        $query = $this->newQueryWithoutScopes();
        //触发 saving 事件
        if ($this->fireModelEvent('saving') === false) {
            return false;
        }
        if ($this->exists) {
            $saved = $this->performUpdate($query, $options);
        }
        else {
            $saved = $this->performInsert($query, $options);
        }

        if ($saved) {
            $this->finishSave($options);
        }
        return $saved;
    }

protected function performInsert(Builder $query, array $options = [])
    {
        //触发 creating 事件
        if ($this->fireModelEvent('creating') === false) {
            return false;
        }
        if ($this->timestamps && Arr::get($options, 'timestamps', true)) {
            $this->updateTimestamps();
        }
        $attributes = $this->attributes;
        if ($this->getIncrementing()) {
            $this->insertAndSetId($query, $attributes);
        }
     else {
            $query->insert($attributes);
        }
        $this->exists = true;
        $this->wasRecentlyCreated = true;
        //触发 created 事件
        $this->fireModelEvent('created', false);
        return true;
        }

protected function finishSave(array $options)
    {
        //触发 saved 事件
        $this->fireModelEvent('saved', false);
        $this->syncOriginal();
        if (Arr::get($options, 'touch', true)) {
            $this->touchOwners();
        }
    }

以上是阐述 creat 时事件触发流程,显而易见依次是 saving>creating>created>saved。

update 同理就不具体贴代码了, saving>updating>updated>saved。

而 delete 不涉及 save,因此依次只触发了 deleting 和deleted。 当 restore 软删除记录时触发了 restoring 和 restored 方法。

使用

只需在 model 添加 boot 方法,可以直接在 boot 方法中定义事件,也可以面向于 model 新建 modelObserver 集中处理对应的 model 事件。

 public static function boot()
    {
        parent::boot();
        static::setEventDispatcher(new \Illuminate\Events\Dispatcher());
        //static::saving(function($model){  });
        static::observe(new testObserver());
    }

class testObserve{
 public function saving($model)
    {
        $model->name=name.'test';
    }
}

大坑

不得不感叹这个事件真的既简单又实用,但是!当我在开发过程中有一处 update 怎么都不会触发事件,捉急的很啊。菜鸟一下看不出问题本质,只能打断点一点点排查。发现是因为该处代码前调用了belongsToMany()

  • 痛点1:dispatcher 与 container 共生死单例。
    多对多模型关联 boot 两个model,因此 boot model2 时,将 dispatcher 指向了 model2。

  • 痛点2:model 只 boot 一次
    bootIfNotBooted(),booted model 不会重新调用 boot 方法。

  • 结果:update model1 怎么都无法触发事件。

  • 解决:目前能想到的便是在调用 belongsToMany()时,调用 ORM 的 clearBootedModels()方法,清除 bootedModel,update model1 时再次 boot model1,强行将 dispatcher 指向 model1.

希望有更好解决方案的小伙伴不吝赐教哦~

本作品采用《CC 协议》,转载必须注明作者和本文链接

step by step

本帖由 Summer 于 2年前 加精
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
讨论数量: 9

写的挺好,学习了。

2年前 评论
阿文

学习,!!!

2年前 评论

事件触发后能做什么?有什么应用场景么?还是不怎么明白.

2年前 评论

@736713830 最简单的一个应用场景就是当数据库的字段发生改变了,比如新增了几个字段的话,平常是通过更改create和update方法来维护。但是如果很多地方都用到这张表就会导致漏加或者打量更改代码,如果使用事件的话就用一个saving的事件便可以很好的解决这个问题了。

2年前 评论
wanghan

写的真好

2年前 评论

强行将 dispatcher 指向 model1 这部分代码可否贴一下呢?比较有兴趣研究下,以前还真没在这种场景下用过.

2年前 评论

@jiyis 可能是我表达有误。我的意思是当存在多对多模型关联时,在触发事件前清除booted model,所以当在调用model1时必须得重新boot,这样便执行了boot中static::setEventDispatcher(new \Illuminate\Events\Dispatcher()),这样dispatcher便重新指向了model1

2年前 评论

update不触发事件是正常的,也本就不应该触发。文档里面说了很清楚了,批量更新的时候不会触发事件。
你是多对多关联,所以那样更新就是批量更新。

2年前 评论

@翁航 并不是批量更新的问题,根源是在事件的dispatcher在多对多关联时指向了第二个模型,所以之前一个模型的事件怎么都不会触发。(这里的多对多关联并不是在更新时关联而是在更新前一步的查询逻辑处关联的,所以更新和多对多关联没有联系)

2年前 评论

请勿发布不友善或者负能量的内容。与人为善,比聪明更重要!