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

前言

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

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

一.如何使用模型事件

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

1.events属性

直接上代码:

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

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

namespace AppEvents;
use AppUser;
class UserSaved {public $user;public function __construct(User $user){$this->user = $user;}
}
namespace AppListeners;
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 = ['AppEventsUserSaved' => ['AppListenersUserSavedListener',]];/*** Register any events for your application.** @return void*/public function boot(){parent::boot();}
}

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

2.观察者

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

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

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

namespace AppProviders;
use AppUser;
use AppObserversUserObserver;
use IlluminateSupportServiceProvider;
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;}//TODOif ($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');}
}

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

二.模型事件实现原理

Laravel的模型事件所有的代码都在IlluminateDatabaseEloquentConcernsHasEvents这个trait下,先来看看Laravel是如何注册这些事件的,其中的$dispatcher是一个事件的调度器IlluminateContractsEventsDispatcher实例,在IlluminateDatabaseDatabaseServiceProvider的boot方法中注入。

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

这里是Laravel事件注册的地方,其中以eloquent.saved:AppUser为事件名,$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而且为空的话,会再去触发通过观察者和静态方法定义的监听器,并且把监听器的返回值返回。

以上内容希望帮助到大家,很多PHPer在进阶的时候总会遇到一些问题和瓶颈,业务代码写多了没有方向感,不知道该从那里入手去提升,对此我整理了一些资料,包括但不限于:分布式架构、高可扩展、高性能、高并发、服务器性能调优、TP6,laravel,YII2,Redis,Swoole、Swoft、Kafka、Mysql优化、shell脚本、Docker、微服务、Nginx等多个知识点高级进阶干货需要的可以免费分享给大家,需要戳这里PHP进阶架构师>>>视频、面试文档免费获取

或 者关注我每天分享技术文章

PHP架构师之路​www.zhihu.com

安卓中radiobutton不进入监听事件_Laravel模型事件的实现原理详解相关推荐

  1. html鼠标滚轮监听,jQuery - 鼠标滚轮插件jquery.mousewheel.js详解(上下、左右滚动监听)...

    1,插件介绍 jquery.mousewheel.js是一个用于添加跨浏览器的鼠标滚轮支持的 jQuery插件. 2,使用说明 (1)使用该插件,只需将 mousewheel事件绑定到一个元素上即可. ...

  2. python监听鼠标事件_Python中使用PyHook监听鼠标和键盘事件实例

    Python 中使用 PyHook 监听鼠标和键盘事件实例 PyHook 是一个基于 Python 的"钩子"库,主要用于监 听当前电脑上鼠标和键盘的事件.这个库依赖于另一个 Py ...

  3. cordova监听事件中调用其他方法_Laravel模型事件的实现原理详解

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

  4. android 剪切板监听_安卓监听剪切复制粘贴事件实例

    本文的剪切复制粘贴事件只针对文本,URI 和 intent 不在讨论范围内. 实例代码实现了2个功能: 监听剪切复制粘贴事件: 获取剪切复制或粘贴的文本: 剪切复制 有2个方法监听剪切复制事件:剪切板 ...

  5. 给gridview动态生成radiobutton添加OnCheckedChanged监听函数

    在写研究生系统审核功能的时候,有一个页面的gridview动态生成四列radiobutton,在gridview控件外有四个radiobutton分别控制这四列的全选中.那么当外面的某个全选按钮选中后 ...

  6. 云闪付APP内嵌H5监听左上角X关闭事件

    最近在做云闪付蓝牙对接,遇到的一个问题. 需求 用户进入云闪付APP内嵌 H5页面调用接口连上蓝牙后,可能不想支付使用,或其他原因,随手关闭左上角X关闭浏览器,这时需要监听这个动作,断开蓝牙连接,不然 ...

  7. Spring5源码 - 12 Spring事件监听机制_异步事件监听应用及源码解析

    文章目录 Pre 实现原理 应用 配置类 Event事件 事件监听 EventListener 发布事件 publishEvent 源码解析 (反推) Spring默认的事件广播器 SimpleApp ...

  8. 13、Java Swing事件监听:事件处理模型和事件监听器

    事件表示程序和用户之间的交互,例如在文本框中输入,在列表框或组合框中选择,选中复选框和单选框,单击按钮等.事件处理表示程序对事件的响应,对用户的交互或者说对事件的处理是事件处理程序完成的. 当事件发生 ...

  9. java swing列表数据加监听,【Java Swing公开课|Java监听列表项选择事件怎么用,看完这篇文章你一定就会了】- 环球网校...

    [摘要]作为一门面向对象编程语言,Java吸收了C++语言的优点,也展现了其强大的一面,我们能在各个地方看到其功能强大和简单易用的两个特征,当然,也吸引了很多程序员的注意力,所以就有人想了解Java的 ...

最新文章

  1. li变成行内块级元素之后,每一个li之间会有间隙,这是为什么?
  2. WordPress搬家全攻略
  3. 二分查找(递归和非递归实现)
  4. python三维圆曲面_python – matplotlib中的曲面和三维轮廓
  5. kubernetes StatefulSet介绍
  6. winform图片操作
  7. 如何免费将XPS转Word格式
  8. pyserial安装失败
  9. vue3.0引入element插件报错解决
  10. CSS实现多余文本隐藏
  11. u盘是传播计算机病毒的媒介,u盘病毒有几种传播方式
  12. html banner图片滚动,jQuery实现的网站banner图片无缝轮播效果完整实例
  13. 10.Python面向对象编程
  14. Codeforces Round #744 (Div. 3) B. Shifting Sort
  15. python中多行语句可以用反斜杠来实现_Python中的多行语句可以使用反斜杠来实现...
  16. 微信小程序注册相关资料
  17. RT-Thread嵌入式人工智能教学研讨会圆满成功
  18. matlab 画qpsk眼图,qpsk调制星座图:通信里 星座图 到底是什么意思
  19. CST和GMT时间的区别
  20. Django 模型Model层2

热门文章

  1. 强烈推荐Bulletproof Ajax 中文版
  2. C#开发WPF/Silverlight动画及游戏系列教程(Game Tutorial):(二十五)完美捕捉精灵之神器 -- HitTest...
  3. 【数理知识】《积分变换与场论》王振老师-第5章-场论
  4. 【Paper】41_[24]novel type of phase transition in a system of self-driven particles
  5. copy_to_user和copy_from_user
  6. windows 下远程登录ubuntu服务器--realVNC
  7. 【PC工具】文件夹多文件群体比较工具beyond compare4
  8. 用云服务器实现janus之web端与web通话!
  9. C++异常处理(try和catch)
  10. IT兄弟连 JavaWeb教程 EL表达式获取对象的属性以及数组的元素