ORM Observer 使用小結（坑點預警）

半夏發表於2017-08-06
ORMServer

前言

最近開發新的專案不是基於完整的 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

相關文章