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.模型事件实现原理