模型事件在 Laravel 的世界中，你對 Eloquent 大多數操作都會或多或少的觸發一些模型事件，下面這篇文章主要給大家介紹了關于Laravel模型事件的實現原理，文中通過示例代碼介紹的非常詳細，需要的朋友可以參考借鑒。

前言

Laravel的ORM模型在一些特定的情況下，會觸發一系列的事件，目前支持的事件有這些：creating, created, updating, updated, saving, saved, deleting, deleted, restoring, restored，那么在底層是如何實現這個功能的呢？

下面話不多說了，來一起看看詳細的介紹吧。

一.如何使用模型事件

先來看看如何使用模型事件，文檔里面寫了兩種方法，實際上總共有三種方式可以定義一個模型事件，這里以saved事件來做例子，其他事件都一樣。

1.events屬性

直接上代碼：

class User extends Authenticatable {use Notifiable;protected $events = ['saved' => UserSaved::class,]; }

這個比較難以理解，而且文檔并沒有詳細說明，剛開始以為saved被觸發后會調用UserSaved里面的handle方法，實際上并不是。這個數組只是對事件做的一個映射，它定義了在模型的saved的時候會觸發UserSaved這個事件，我們還要定義該事件以及其監聽器才可以：

namespace AppEvents; use AppUser; class UserSaved {public $user;public function __construct(User $user){$this->user = $user;} } namespace AppListeners; class UserSavedListener {public function handle(UserSaved $userSaved){dd($userSaved);} }

然后還要到EventServiceProvider中去注冊該事件和監聽器：

class EventServiceProvider extends ServiceProvider {/*** The event listener mappings for the application.** @var array*/protected $listen = ['AppEventsUserSaved' => ['AppListenersUserSavedListener',]];/*** Register any events for your application.** @return void*/public function boot(){parent::boot();} }

這樣在saved節點的時候，UserSaved事件會被觸發，其監聽器UserSavedListener的handle方法會被調用。

2.觀察者

這是文檔比較推崇的一個模型事件定義方法，也比較好理解，先定義一個觀察者：

use AppUser; class UserObserver {/*** 監聽用戶創建事件.** @param User $user* @return void*/public function created(User $user){//}/*** 監聽用戶創建/更新事件.** @param User $user* @return void*/public function saved(User $user){//} }

然后在某個服務提供者的boot方法中注冊觀察者：

namespace AppProviders; use AppUser; use AppObserversUserObserver; use IlluminateSupportServiceProvider; class AppServiceProvider extends ServiceProvider {/*** Bootstrap any application services.** @return void*/public function boot(){User::observe(UserObserver::class);}/*** Register the service provider.** @return void*/public function register(){//} }

這樣在模型事件觸發的時候，UserObserver的相應方法就會被調用。其實，在使用觀察者的時候，除了一些系統自帶的，我們還可以定義一些自己的事件：

class User extends Authenticatable {use Notifiable;protected $observables = ['customing', 'customed']; }

然后在觀察者里面定義同名方法：

class UserObserver {/*** 監聽用戶創建/更新事件.** @param User $user* @return void*/public function saved(User $user){//}public function customing(User $user){}public function customed(User $user){} }

由于是我們自己定義的事件，所以觸發的時候也必須手動觸發，在需要觸發的地方調用模型里面的一個fireModelEvent方法即可。不過由于該方法是protected的，所以只能在自己定義的模型方法里面，當然如果通過反射來調用，或許可以直接在$user對象上觸發也說不定，這個我沒試，大家可以自行測試下。

class User extends Authenticatable {use Notifiable;protected $observables = ['customing', 'awesoming'];public function custom(){if ($this->fireModelEvent('customing') === false) {return false;}//TODOif ($this->fireModelEvent('customed') === false) {return false;}} }

3.靜態方法定義

我們還可以通過模型上的對應靜態方法來定義一個事件，在EventServiceProvider的boot方法里面定義：

class EventServiceProvider extends ServiceProvider{/*** Register any events for your application.** @return void*/public function boot(){parent::boot();User::saved(function(User$user) {});User::saved('UserSavedListener@saved');} }

通過靜態方法定義的時候，可以直接傳遞進入一個閉包，也可以定義為某個類的方法，事件觸發時候傳遞進入的參數就是該模型實例。

二.模型事件實現原理

Laravel的模型事件所有的代碼都在IlluminateDatabaseEloquentConcernsHasEvents這個trait下，先來看看Laravel是如何注冊這些事件的，其中的$dispatcher是一個事件的調度器IlluminateContractsEventsDispatcher實例，在IlluminateDatabaseDatabaseServiceProvider的boot方法中注入。

protected static function registerModelEvent($event, $callback){if (isset(static::$dispatcher)) {$name = static::class;static::$dispatcher->listen("eloquent.{$event}: {$name}", $callback);}}

這里是Laravel事件注冊的地方，其中以eloquent.saved:AppUser為事件名，$callback作為處理器來注冊。這個注冊事件的方法，只會注冊以觀察者和靜態方法定義的。假如你定義為模型的$events屬性的話，Laravel是不會注冊的，會在觸發事件的時候同步觸發，接下來會分析。

然后在HasEvents中定義了一堆的方法如下，這些就是我們上面通過靜態方法來定義事件監聽器的原理，不多說一看就懂。

public static function saving($callback){static::registerModelEvent('saving', $callback); }public static function saved($callback){static::registerModelEvent('saved', $callback); }

那么如何通過觀察者的形式來定義事件監聽器呢？看源碼：

public static function observe($class){$instance = new static;$className = is_string($class) ? $class : get_class($class);foreach ($instance->getObservableEvents() as $event) {if (method_exists($class, $event)) {static::registerModelEvent($event, $className.'@'.$event);}} }public function getObservableEvents() {return array_merge(['creating', 'created', 'updating', 'updated','deleting', 'deleted', 'saving', 'saved','restoring', 'restored',],$this->observables); }

先獲取到observer的類名，然后判斷是否存在事件名對應的方法，存在則調用registerModelEvent注冊，這里事件名還包括我們自己定義在observables數組中的。

事件以及監聽器都定義好后，就是如何觸發了，前面說到有一個方法fireModelEvent，來看看源碼：

protected function fireModelEvent($event, $halt = true) {if (! isset(static::$dispatcher)) {return true;}$method = $halt ? 'until' : 'fire';$result = $this->filterModelEventResults($this->fireCustomModelEvent($event, $method));if ($result === false) {return false;}return ! empty($result) ? $result : static::$dispatcher->{$method}("eloquent.{$event}: ".static::class, $this); }

其中比較關鍵的一個方法是fireCustomModelEvent，它接受一個事件名以及觸發方式。順帶一提，filterModelEventResults這個方法的作用就是把監聽器的返回值為null的過濾掉。

看看fireCustomModelEvent的源碼：

protected function fireCustomModelEvent($event, $method) {if (! isset($this->events[$event])) {return;}$result = static::$dispatcher->$method(new $this->events[$event]($this));if (! is_null($result)) {return $result;} }

這個就是用來觸發我們通過$events定義的事件了，假如我們這么定義：

class User extends Model{protected $events = ['saved' => UserSaved::class] }

那這里的觸發就是：

$result = static::$dispatcher->fire(new UserSaved($this));

順帶一提，Laravel中觸發事件的方法有兩個，一個是常用的fire，還有一個是util，這兩個的差別就是fire會把監聽器的返回值返回，而util永遠返回null

然后接下來就是會去觸發通過觀察者和靜態方法定義的監聽器了，這一段代碼：

if ($result === false) {return false; }return ! empty($result) ? $result : static::$dispatcher->{$method}("eloquent.{$event}: ".static::class, $this );

這里會先判斷$events定義的監聽器是否返回false以及返回值是否為空，如果為false則直接結束事件，如果返回不為false而且為空的話，會再去觸發通過觀察者和靜態方法定義的監聽器，并且把監聽器的返回值返回。

以上內容希望幫助到大家，很多PHPer在進階的時候總會遇到一些問題和瓶頸，業務代碼寫多了沒有方向感，不知道該從那里入手去提升，對此我整理了一些資料，包括但不限于：分布式架構、高可擴展、高性能、高并發、服務器性能調優、TP6，laravel，YII2，Redis，Swoole、Swoft、Kafka、Mysql優化、shell腳本、Docker、微服務、Nginx等多個知識點高級進階干貨需要的可以免費分享給大家，需要戳這里PHP進階架構師>>>視頻、面試文檔免費獲取

或 者關注我每天分享技術文章

PHP架構師之路?www.zhihu.com 《新程序員》：云原生和全面數字化實踐50位技術專家共同創作，文字、視頻、音頻交互閱讀

總結

以上是生活随笔為你收集整理的安卓中radiobutton不进入监听事件_Laravel模型事件的实现原理详解的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。