• 售前

  • 售后

热门帖子
入门百科

Laravel模子变乱的实现原理详解

[复制链接]
13471756666 显示全部楼层 发表于 2021-10-25 19:12:19 |阅读模式 打印 上一主题 下一主题
媒介
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. protected $events = [
  4.   'saved' => UserSaved::class,
  5. ];
  6. }
复制代码
这个比力难以明白,而且文档并没有详细说明,刚开始以为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. }
复制代码
  1. namespace App\Listeners;
  2. class UserSavedListener {
  3. public function handle(UserSaved $userSaved){
  4.   dd($userSaved);
  5. }
  6. }
复制代码
然后还要到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.   * Register any events for your application.
  15.   *
  16.   * @return void
  17.   */
  18. public function boot()
  19. {
  20.   parent::boot();
  21. }
  22. }
复制代码
如许在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.   * @param User $user
  18.   * @return void
  19.   */
  20. public function saved(User $user)
  21. {
  22.   //
  23. }
  24. }
复制代码
然后在某个服务提供者的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.   * Register the service provider.
  18.   *
  19.   * @return void
  20.   */
  21. public function register()
  22. {
  23.   //
  24. }
  25. }
复制代码
如许在模型事件触发的时间,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. public function customing(User $user){
  14. }
  15.   public function customed(User $user){
  16. }
  17. }
复制代码
由于是我们自己定义的事件,所以触发的时间也必须手动触发,在需要触发的地方调用模型内里的一个fireModelEvent方法即可。不外由于该方法是protected的,所以只能在自己定义的模型方法内里,固然假如通过反射来调用,或许可以直接在$user对象上触发也说不定,这个我没试,各人可以自行测试下。
  1. class User extends Authenticatable {
  2. use Notifiable;
  3. protected $observables = [
  4.   'customing', 'awesoming'
  5. ];
  6. public function custom(){
  7.   if ($this->fireModelEvent('customing') === false) {
  8.    return false;
  9.   }
  10.   
  11.   //TODO
  12.    if ($this->fireModelEvent('customed') === false) {
  13.    return false;
  14.   }
  15. }
  16. }
复制代码
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. public static function saved($callback){
  5. static::registerModelEvent('saved', $callback);
  6. }
复制代码
那么怎样通过观察者的情势来定义事件监听器呢?看源码:
  1. public static function observe($class){
  2.   $instance = new static;
  3.   $className = is_string($class) ? $class : get_class($class);
  4.   foreach ($instance->getObservableEvents() as $event) {
  5.    if (method_exists($class, $event)) {
  6.     static::registerModelEvent($event, $className.'@'.$event);
  7.    }
  8.   }
  9. }
  10. public function getObservableEvents()
  11. {
  12.   return array_merge(
  13.    [
  14.     'creating', 'created', 'updating', 'updated',
  15.     'deleting', 'deleted', 'saving', 'saved',
  16.     'restoring', 'restored',
  17.    ],
  18.    $this->observables
  19.   );
  20. }
复制代码
先获取到observer的类名,然后判断是否存在事件名对应的方法,存在则调用registerModelEvent注册,这里事件名还包罗我们自己定义在observables数组中的。

事件以及监听器都定义好后,就是怎样触发了,前面说到有一个方法fireModelEvent,来看看源码:
  1. protected function fireModelEvent($event, $halt = true)
  2. {
  3.   if (! isset(static::$dispatcher)) {
  4.    return true;
  5.   }
  6.   $method = $halt ? 'until' : 'fire';
  7.   $result = $this->filterModelEventResults(
  8.    $this->fireCustomModelEvent($event, $method)
  9.   );
  10.   if ($result === false) {
  11.    return false;
  12.   }
  13.   return ! empty($result) ? $result : static::$dispatcher->{$method}(
  14.    "eloquent.{$event}: ".static::class, $this
  15.   );
  16. }
复制代码
此中比力关键的一个方法是fireCustomModelEvent,它继承一个事件名以及触发方式。顺带一提,filterModelEventResults这个方法的作用就是把监听器的返回值为null的过滤掉。

看看fireCustomModelEvent的源码:
  1. protected function fireCustomModelEvent($event, $method)
  2. {
  3.   if (! isset($this->events[$event])) {
  4.    return;
  5.   }
  6.   $result = static::$dispatcher->$method(new $this->events[$event]($this));
  7.   if (! is_null($result)) {
  8.    return $result;
  9.   }
  10. }
复制代码
这个就是用来触发我们通过$events定义的事件了,假如我们这么定义:
  1. class User extends Model{
  2. protected $events = [
  3.   'saved' => UserSaved::class
  4. ]
  5. }
复制代码
那这里的触发就是:
  1. $result = static::$dispatcher->fire(new UserSaved($this));
复制代码
顺带一提,Laravel中触发事件的方法有两个,一个是常用的fire,尚有一个是util,这两个的差异就是fire会把监听器的返回值返回,而util永久返回null

然后接下来就是会去触发通过观察者和静态方法定义的监听器了,这一段代码:
  1.   if ($result === false) {
  2.    return false;
  3.   }
  4.   return ! empty($result) ? $result : static::$dispatcher->{$method}(
  5.    "eloquent.{$event}: ".static::class, $this
  6.   );
复制代码
这里会先判断$events定义的监听器是否返回false以及返回值是否为空,假如为false则直接竣事事件,假如返回不为false而且为空的话,会再去触发通过观察者和静态方法定义的监听器,而且把监听器的返回值返回。
完。
总结
以上就是这篇文章的全部内容了,盼望本文的内容对各人的学习或者工作具有肯定的参考学习代价,假如有疑问各人可以留言交流,谢谢各人对草根技能分享的支持。

帖子地址: 

回复

使用道具 举报

分享
推广
火星云矿 | 预约S19Pro,享500抵1000!
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

草根技术分享(草根吧)是全球知名中文IT技术交流平台,创建于2021年,包含原创博客、精品问答、职业培训、技术社区、资源下载等产品服务,提供原创、优质、完整内容的专业IT技术开发社区。
  • 官方手机版

  • 微信公众号

  • 商务合作