Laravel模型事件的实现原理详解
前言Laravel的ORM模型在一些特定的情况下,会触发一系列的事件,目前支持的事件有这些:creating,created,updating,updated,saving,saved,deleting,deleted,restoring,restored,那么在底层是如何实现这个功能的呢? 下面话不多说了,来一起看看详细的介绍吧。 1.如何使用模型事件先来看看如何使用模型事件,文档里面写了两种方法,实际上总共有三种方式可以定义一个模型事件,这里以saved事件来做例子,其他事件都一样。 1.events属性直接上代码: protected $events = [
'saved' => UserSaved::class,]; } 这个比较难以理解,而且文档并没有详细说明,刚开始以为saved被触发后会调用UserSaved里面的handle方法,实际上并不是。这个数组只是对事件做的一个映射,它定义了在模型的saved的时候会触发UserSaved这个事件,我们还要定义该事件以及其监听器才可以: user = $user;
}
}
然后还要到EventServiceProvider中去注册该事件和监听器: [
'AppListenersUserSavedListener',]
];
/**
这样在saved节点的时候,UserSaved事件会被触发,其监听器UserSavedListener的handle方法会被调用。 2.观察者这是文档比较推崇的一个模型事件定义方法,也比较好理解,先定义一个观察者: */ public function created(User $user) { // } /**
然后在某个服务提供者的boot方法中注册观察者: */ public function boot() { User::observe(UserObserver::class); } /**
这样在模型事件触发的时候,UserObserver的相应方法就会被调用。其实,在使用观察者的时候,除了一些系统自带的,我们还可以定义一些自己的事件: 然后在观察者里面定义同名方法: */ public function saved(User $user) { // } public function customing(User $user){ public function customed(User $user){ 由于是我们自己定义的事件,所以触发的时候也必须手动触发,在需要触发的地方调用模型里面的一个fireModelEvent方法即可。不过由于该方法是protected的,所以只能在自己定义的模型方法里面,当然如果通过反射来调用,或许可以直接在$user对象上触发也说不定,这个我没试,大家可以自行测试下。 public function custom(){
if ($this->fireModelEvent('customing') === false) { return false; } //TODO 3.静态方法定义我们还可以通过模型上的对应静态方法来定义一个事件,在EventServiceProvider的boot方法里面定义: 通过静态方法定义的时候,可以直接传递进入一个闭包,也可以定义为某个类的方法,事件触发时候传递进入的参数就是该模型实例。 2.模型事件实现原理Laravel的模型事件所有的代码都在IlluminateDatabaseEloquentConcernsHasEvents这个trait下,先来看看Laravel是如何注册这些事件的,其中的$dispatcher是一个事件的调度器IlluminateContractsEventsDispatcher实例,在IlluminateDatabaseDatabaseServiceProvider的boot方法中注入。 listen("eloquent.{$event}: {$name}",$callback);
}
}
这里是Laravel事件注册的地方,其中以eloquent.saved:AppUser为事件名,$callback作为处理器来注册。这个注册事件的方法,只会注册以观察者和静态方法定义的。假如你定义为模型的$events属性的话,Laravel是不会注册的,会在触发事件的时候同步触发,接下来会分析。 然后在HasEvents中定义了一堆的方法如下,这些就是我们上面通过静态方法来定义事件监听器的原理,不多说一看就懂。 public static function saved($callback){
static::registerModelEvent('saved',$callback); } 那么如何通过观察者的形式来定义事件监听器呢?看源码: foreach ($instance->getObservableEvents() as $event) {
if (method_exists($class,$event)) { static::registerModelEvent($event,$className.'@'.$event); } } } public function getObservableEvents() 先获取到observer的类名,然后判断是否存在事件名对应的方法,存在则调用registerModelEvent注册,这里事件名还包括我们自己定义在observables数组中的。 事件以及监听器都定义好后,就是如何触发了,前面说到有一个方法fireModelEvent,来看看源码: $method = $halt ? 'until' : 'fire';
$result = $this->filterModelEventResults( if ($result === false) { return ! empty($result) ? $result : static::$dispatcher->{$method}( 其中比较关键的一个方法是fireCustomModelEvent,它接受一个事件名以及触发方式。顺带一提,filterModelEventResults这个方法的作用就是把监听器的返回值为null的过滤掉。 看看fireCustomModelEvent的源码: events[$event])) {
return;
}
$result = static::$dispatcher->$method(new $this->events$event); 这个就是用来触发我们通过$events定义的事件了,假如我们这么定义: UserSaved::class
]
}
那这里的触发就是: fire(new UserSaved($this));
顺带一提,Laravel中触发事件的方法有两个,一个是常用的fire,还有一个是util,这两个的差别就是fire会把监听器的返回值返回,而util永远返回null 然后接下来就是会去触发通过观察者和静态方法定义的监听器了,这一段代码: return ! empty($result) ? $result : static::$dispatcher->{$method}(
"eloquent.{$event}: ".static::class,$this ); 这里会先判断$events定义的监听器是否返回false以及返回值是否为空,如果为false则直接结束事件,如果返回不为false而且为空的话,会再去触发通过观察者和静态方法定义的监听器,并且把监听器的返回值返回。 完。 总结以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对编程之家的支持。 (编辑:李大同) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |