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而且为空的话，会再去触发通过观察者和静态方法定义的监听器，并且把监听器的返回值返回。
完。

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对的支持。