当前位置：首页 > CMS教程 > 其它CMS > 列表

Laravel模型事件的实现原理详解

发布:smiling　来源: PHP粉丝网 　添加日期：2021-09-05 14:08:40　浏览: 评论：0　

模型事件在 Laravel 的世界中，你对 Eloquent 大多数操作都会或多或少的触发一些模型事件，下面这篇文章主要给大家介绍了关于Laravel模型事件的实现原理，文中通过示例代码介绍的非常详细，需要的朋友可以参考借鉴。

前言

Laravel的ORM模型在一些特定的情况下，会触发一系列的事件，目前支持的事件有这些：creating, created, updating, updated, saving, saved, deleting, deleted, restoring, restored，那么在底层是如何实现这个功能的呢？

下面话不多说了，来一起看看详细的介绍吧。

1.如何使用模型事件

先来看看如何使用模型事件，文档里面写了两种方法，实际上总共有三种方式可以定义一个模型事件，这里以saved事件来做例子，其他事件都一样。

1.events属性

直接上代码：

  1. class User extends Authenticatable { 
  2.  use Notifiable; 
  3.  
  4.  protected $events = [ 
  5.   'saved' => UserSaved::class, 
  6.  ]; 
  7. } 

这个比较难以理解，而且文档并没有详细说明，刚开始以为saved被触发后会调用UserSaved里面的handle方法，实际上并不是，这个数组只是对事件做的一个映射，它定义了在模型的saved的时候会触发UserSaved这个事件，我们还要定义该事件以及其监听器才可以：

  1. namespace App\Events; 
  2. use App\User; 
  3. class UserSaved { 
  4.  public $user; 
  5.  public function __construct(User $user){ 
  6.   $this->user = $user; 
  7.  } 
  8. } 
  9.  
  10. namespace App\Listeners; 
  11. class UserSavedListener { 
  12.  public function handle(UserSaved $userSaved){ 
  13.   dd($userSaved); 
  14.  } 
  15. } 

然后还要到EventServiceProvider中去注册该事件和监听器：

  1. class EventServiceProvider extends ServiceProvider 
  2. { 
  3.  /** 
  4.   * The event listener mappings for the application. 
  5.   * 
  6.   * @var array 
  7.   */ 
  8.  protected $listen = [ 
  9.   'App\Events\UserSaved' => [ 
  10.    'App\Listeners\UserSavedListener', 
  11.   ] 
  12.  ]; 
  13.  
  14.  /** 
  15.   * Register any events for your application. 
  16.   * 
  17.   * @return void 
  18.   */ 
  19.  public function boot() 
  20.  { 
  21.   parent::boot(); 
  22.  } 
  23. } 

这样在saved节点的时候，UserSaved事件会被触发，其监听器UserSavedListener的handle方法会被调用。

2.观察者

这是文档比较推崇的一个模型事件定义方法，也比较好理解，先定义一个观察者：

  1. use App\User; 
  2. class UserObserver 
  3. { 
  4.  /** 
  5.   * 监听用户创建事件. 
  6.   * 
  7.   * @param User $user 
  8.   * @return void 
  9.   */ 
  10.  public function created(User $user) 
  11.  { 
  12.   // 
  13.  } 
  14.  
  15.  /** 
  16.   * 监听用户创建/更新事件. 
  17.   * 
  18.   * @param User $user 
  19.   * @return void 
  20.   */ 
  21.  public function saved(User $user) 
  22.  { 
  23.   // 
  24.  } 
  25. } 

然后在某个服务提供者的boot方法中注册观察者：

  1. namespace App\Providers; 
  2. use App\User; 
  3. use App\Observers\UserObserver; 
  4. use Illuminate\Support\ServiceProvider; 
  5. class AppServiceProvider extends ServiceProvider 
  6. { 
  7.  /** 
  8.   * Bootstrap any application services. 
  9.   * 
  10.   * @return void 
  11.   */ 
  12.  public function boot() 
  13.  { 
  14.   User::observe(UserObserver::class); 
  15.  } 
  16.  
  17.  /** 
  18.   * Register the service provider. 
  19.   * 
  20.   * @return void 
  21.   */ 
  22.  public function register() 
  23.  { 
  24.   // 
  25.  } 
  26. } 

这样在模型事件触发的时候，UserObserver的相应方法就会被调用，其实，在使用观察者的时候，除了一些系统自带的，我们还可以定义一些自己的事件：

  1. class User extends Authenticatable { 
  2.  use Notifiable; 
  3.  protected $observables = [ 
  4.   'customing', 'customed' 
  5.  ]; 
  6. } 

然后在观察者里面定义同名方法：

  1. class UserObserver 
  2. { 
  3.  /** 
  4.   * 监听用户创建/更新事件. 
  5.   * 
  6.   * @param User $user 
  7.   * @return void 
  8.   */ 
  9.  public function saved(User $user) 
  10.  { 
  11.   // 
  12.  } 
  13.  
  14.  public function customing(User $user){ 
  15.  } 
  16.  
  17.   public function customed(User $user){ 
  18.  } 
  19. } 

由于是我们自己定义的事件，所以触发的时候也必须手动触发，在需要触发的地方调用模型里面的一个fireModelEvent方法即可。不过由于该方法是protected的，所以只能在自己定义的模型方法里面，当然如果通过反射来调用，或许可以直接在$user对象上触发也说不定，这个我没试，大家可以自行测试下。

  1. class User extends Authenticatable { 
  2.  use Notifiable; 
  3.  protected $observables = [ 
  4.   'customing', 'awesoming' 
  5.  ]; 
  6.    
  7.  public function custom(){ 
  8.   if ($this->fireModelEvent('customing') === false) { 
  9.    return false; 
  10.   } 
  11.     
  12.   //TODO 
  13.    if ($this->fireModelEvent('customed') === false) { 
  14.    return false; 
  15.   } 
  16.  } 
  17. } 

3.静态方法定义

我们还可以通过模型上的对应静态方法来定义一个事件，在EventServiceProvider的boot方法里面定义：

  1. class EventServiceProvider extends ServiceProvider{ 
  2.  /** 
  3.   * Register any events for your application. 
  4.   * 
  5.   * @return void 
  6.   */ 
  7.  public function boot() 
  8.  { 
  9.   parent::boot(); 
  10.   User::saved(function(User$user) { 
  11.   }); 
  12.   User::saved('UserSavedListener@saved'); 
  13.  } 
  14. } 

通过静态方法定义的时候，可以直接传递进入一个闭包，也可以定义为某个类的方法，事件触发时候传递进入的参数就是该模型实例。

2.模型事件实现原理

Laravel的模型事件所有的代码都在Illuminate\Database\Eloquent\Concerns\HasEvents这个trait下，先来看看Laravel是如何注册这些事件的，其中的$dispatcher是一个事件的调度器Illuminate\Contracts\Events\Dispatcher实例，在Illuminate\Database\DatabaseServiceProvider的boot方法中注入。

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

这里是Laravel事件注册的地方，其中以eloquent.saved:App\User为事件名，$callback作为处理器来注册。这个注册事件的方法，只会注册以观察者和静态方法定义的。假如你定义为模型的$events属性的话，Laravel是不会注册的，会在触发事件的时候同步触发，接下来会分析。

然后在HasEvents中定义了一堆的方法如下，这些就是我们上面通过静态方法来定义事件监听器的原理，不多说一看就懂。

  1. public static function saving($callback){ 
  2.  static::registerModelEvent('saving', $callback); 
  3. } 
  4.  
  5. public static function saved($callback){ 
  6.  static::registerModelEvent('saved', $callback); 
  7. } 

那么如何通过观察者的形式来定义事件监听器呢？看源码：

  1. public static function observe($class){ 
  2.  $instance = new static; 
  3.  $className = is_string($class) ? $class : get_class($class); 
  4.  
  5.  foreach ($instance->getObservableEvents() as $event) { 
  6.   if (method_exists($class, $event)) { 
  7.    static::registerModelEvent($event, $className.'@'.$event); 
  8.   } 
  9.  } 
  10. } 
  11.  
  12. public function getObservableEvents() 
  13. { 
  14.  return array_merge( 
  15.   [ 
  16.    'creating', 'created', 'updating', 'updated', 
  17.    'deleting', 'deleted', 'saving', 'saved', 
  18.    'restoring', 'restored', 
  19.   ], 
  20.   $this->observables 
  21.  ); 
  22. } 

先获取到observer的类名，然后判断是否存在事件名对应的方法，存在则调用registerModelEvent注册，这里事件名还包括我们自己定义在observables数组中的。

事件以及监听器都定义好后，就是如何触发了，前面说到有一个方法fireModelEvent，来看看源码：

  1. protected function fireModelEvent($event, $halt = true) 
  2. { 
  3.  if (! isset(static::$dispatcher)) { 
  4.   return true; 
  5.  } 
  6.  
  7.  $method = $halt ? 'until' : 'fire'; 
  8.  
  9.  $result = $this->filterModelEventResults( 
  10.   $this->fireCustomModelEvent($event, $method) 
  11.  ); 
  12.  
  13.  if ($result === false) { 
  14.   return false; 
  15.  } 
  16.  
  17.  return ! emptyempty($result) ? $result : static::$dispatcher->{$method}( 
  18.   "eloquent.{$event}: ".static::class, $this 
  19.  ); 
  20. } 

其中比较关键的一个方法是fireCustomModelEvent，它接受一个事件名以及触发方式，顺带一提，filterModelEventResults这个方法的作用就是把监听器的返回值为null的过滤掉。

看看fireCustomModelEvent的源码：

  1. protected function fireCustomModelEvent($event, $method) 
  2. { 
  3.  if (! isset($this->events[$event])) { 
  4.   return; 
  5.  } 
  6.  
  7.  $result = static::$dispatcher->$method(new $this->events[$event]($this)); 
  8.  if (! is_null($result)) { 
  9.   return $result; 
  10.  } 
  11. } 

这个就是用来触发我们通过$events定义的事件了，假如我们这么定义：

  1. class User extends Model{ 
  2.  protected $events = [ 
  3.   'saved' => UserSaved::class 
  4.  ] 
  5. } 

那这里的触发就是：

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

顺带一提，Laravel中触发事件的方法有两个，一个是常用的fire，还有一个是util，这两个的差别就是fire会把监听器的返回值返回，而util永远返回null

然后接下来就是会去触发通过观察者和静态方法定义的监听器了，这一段代码：

  1. if ($result === false) { 
  2.  return false; 
  3. } 
  4.  
  5. return ! emptyempty($result) ? $result : static::$dispatcher->{$method}( 
  6.  "eloquent.{$event}: ".static::class, $this 
  7. ); 

这里会先判断$events定义的监听器是否返回false以及返回值是否为空，如果为false则直接结束事件，如果返回不为false而且为空的话，会再去触发通过观察者和静态方法定义的监听器，并且把监听器的返回值返回。

完。

Tags: Laravel模型事件

分享到：

推荐文章

热门文章

最新评论文章