Laravel模型事件的实现原理详解[通俗易懂]

Laravel模型事件的实现原理详解

大家好,又见面了,我是全栈君。

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

前言

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

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

1.如何使用模型事件

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

1.events属性

直接上代码:

?
1
2
3
4
5
6
7
class
User
extends
Authenticatable {
 
use
Notifiable;
 
 
protected
$events
= [
  
'saved'
=> UserSaved::
class
,
 
];
}

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

?
1
2
3
4
5
6
7
8
namespace
App\Events;
use
App\User;
class
UserSaved {
 
public
$user
;
 
public
function
__construct(User
$user
){
  
$this
->user =
$user
;
 
}
}

?
1
2
3
4
5
6
namespace
App\Listeners;
class
UserSavedListener {
 
public
function
handle(UserSaved
$userSaved
){
  
dd(
$userSaved
);
 
}
}

然后还要到EventServiceProvider中去注册该事件和监听器:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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.观察者

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

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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方法中注册观察者:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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的相应方法就会被调用。其实,在使用观察者的时候,除了一些系统自带的,我们还可以定义一些自己的事件:

?
1
2
3
4
5
6
class
User
extends
Authenticatable {
 
use
Notifiable;
 
protected
$observables
= [
  
'customing'
,
'customed'
 
];
}

然后在观察者里面定义同名方法:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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对象上触发也说不定,这个我没试,大家可以自行测试下。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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方法里面定义:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
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方法中注入。

?
1
2
3
4
5
6
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中定义了一堆的方法如下,这些就是我们上面通过静态方法来定义事件监听器的原理,不多说一看就懂。

?
1
2
3
4
5
6
7
public
static
function
saving(
$callback
){
 
static
::registerModelEvent(
'saving'
,
$callback
);
}
 
public
static
function
saved(
$callback
){
 
static
::registerModelEvent(
'saved'
,
$callback
);
}

那么如何通过观察者的形式来定义事件监听器呢?看源码:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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,来看看源码:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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的源码:

?
1
2
3
4
5
6
7
8
9
10
11
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定义的事件了,假如我们这么定义:

?
1
2
3
4
5
class
User
extends
Model{
 
protected
$events
= [
  
'saved'
=> UserSaved::
class
 
]
}

那这里的触发就是:

?
1
$result
=
static
::
$dispatcher
->fire(
new
UserSaved(
$this
));

顺带一提,Laravel中触发事件的方法有两个,一个是常用的fire,还有一个是util,这两个的差别就是fire会把监听器的返回值返回,而util永远返回null

然后接下来就是会去触发通过观察者和静态方法定义的监听器了,这一段代码:

?
1
2
3
4
5
6
7
if
(
$result
=== false) {
 
return
false;
}
 
return
!
empty
(
$result
) ?
$result
:
static
::
$dispatcher
->{

$method
}(
 
"eloquent.{$event}: "
.
static
::
class
,
$this
);

这里会先判断$events定义的监听器是否返回false以及返回值是否为空,如果为false则直接结束事件,如果返回不为false而且为空的话,会再去触发通过观察者和静态方法定义的监听器,并且把监听器的返回值返回。

原文:https://www.jb51.net/article/136377.htm

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/112289.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)


相关推荐

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号