Laravel模型事件實作步驟詳解

這次帶給大家Laravel模型事件實現步驟詳解，Laravel模型事件實現的注意事項有哪些，下面就是實戰案例，一起來看一下。

前言

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

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

1.如何使用模型事件

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

1.events屬性

直接上程式碼：

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

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

namespace App\Events;
use App\User;
class UserSaved {
 public $user;
 public function construct(User $user){
  $this->user = $user;
 }
}

namespace App\Listeners;
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 = [
  'App\Events\UserSaved' => [
   'App\Listeners\UserSavedListener',
  ]
 ];
 /**
  * Register any events for your application.
  *
  * @return void
  */
 public function boot()
 {
  parent::boot();
 }
}

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

2.觀察者

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

use App\User;
class UserObserver
{
 /**
  * 监听用户创建事件.
  *
  * @param User $user
  * @return void
  */
 public function created(User $user)
 {
  //
 }
 /**
  * 监听用户创建/更新事件.
  *
  * @param User $user
  * @return void
  */
 public function saved(User $user)
 {
  //
 }
}

接著在某個服務提供者的boot方法中註冊觀察者：

namespace App\Providers;
use App\User;
use App\Observers\UserObserver;
use Illuminate\Support\ServiceProvider;
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;
  }
  
  //TODO
   if ($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');
 }
}

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

2.模型事件實作原理

Laravel的模型事件所有的程式碼都在Illuminate\Database\Eloquent\Concerns\HasEvents這個trait下，先來看看Laravel是如何註冊這些事件的，其中的$dispatcher是一個事件的調度器Illuminate\Contracts\Events\Dispatcher實例，在Illuminate\Database\DatabaseServiceProvider的boot方法中註入。

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

這裡是Laravel事件註冊的地方，其中以eloquent.saved:App\User為事件名，$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而且为空的话，会再去触发通过观察者和静态方法定义的监听器，并且把监听器的返回值返回。
完。

相信看了本文案例你已经掌握了方法，更多精彩请关注php中文网其它相关文章！

推荐阅读：

phpStudy2018安装与配置步骤详解

ThinkPHP实现微信支付(jsapi支付)步骤详解

以上是Laravel模型事件實作步驟詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章！