前言
Laravel的ORM模型在一些特定的情況下，會(huì)觸發(fā)一系列的事件，目前支持的事件有這些：creating, created, updating, updated, saving, saved, deleting, deleted, restoring, restored，那么在底層是如何實(shí)現(xiàn)這個(gè)功能的呢？
下面話不多說了，來一起看看詳細(xì)的介紹吧。
1.如何使用模型事件
先來看看如何使用模型事件，文檔里面寫了兩種方法，實(shí)際上總共有三種方式可以定義一個(gè)模型事件，這里以saved事件來做例子，其他事件都一樣。
1.events屬性
直接上代碼：
class User extends Authenticatable {
use Notifiable;
protected $events = [
'saved' => UserSaved::class,
];
}
這個(gè)比較難以理解，而且文檔并沒有詳細(xì)說明，剛開始以為saved被觸發(fā)后會(huì)調(diào)用UserSaved里面的handle方法，實(shí)際上并不是。這個(gè)數(shù)組只是對(duì)事件做的一個(gè)映射，它定義了在模型的saved的時(shí)候會(huì)觸發(fā)UserSaved這個(gè)事件，我們還要定義該事件以及其監(jiān)聽器才可以：
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中去注冊(cè)該事件和監(jiān)聽器：
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節(jié)點(diǎn)的時(shí)候，UserSaved事件會(huì)被觸發(fā)，其監(jiān)聽器UserSavedListener的handle方法會(huì)被調(diào)用。
2.觀察者
這是文檔比較推崇的一個(gè)模型事件定義方法，也比較好理解，先定義一個(gè)觀察者：
use App\User;
class UserObserver
{
/**
* 監(jiān)聽用戶創(chuàng)建事件.
*
* @param User $user
* @return void
*/
public function created(User $user)
{
//
}
/**
* 監(jiān)聽用戶創(chuàng)建/更新事件.
*
* @param User $user
* @return void
*/
public function saved(User $user)
{
//
}
}
然后在某個(gè)服務(wù)提供者的boot方法中注冊(cè)觀察者：
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()
{
//
}
}
這樣在模型事件觸發(fā)的時(shí)候，UserObserver的相應(yīng)方法就會(huì)被調(diào)用。其實(shí)，在使用觀察者的時(shí)候，除了一些系統(tǒng)自帶的，我們還可以定義一些自己的事件：
class User extends Authenticatable {
use Notifiable;
protected $observables = [
'customing', 'customed'
];
}
然后在觀察者里面定義同名方法：
class UserObserver
{
/**
* 監(jiān)聽用戶創(chuàng)建/更新事件.
*
* @param User $user
* @return void
*/
public function saved(User $user)
{
//
}
public function customing(User $user){
}
public function customed(User $user){
}
}
由于是我們自己定義的事件，所以觸發(fā)的時(shí)候也必須手動(dòng)觸發(fā)，在需要觸發(fā)的地方調(diào)用模型里面的一個(gè)fireModelEvent方法即可。不過由于該方法是protected的，所以只能在自己定義的模型方法里面，當(dāng)然如果通過反射來調(diào)用，或許可以直接在$user對(duì)象上觸發(fā)也說不定，這個(gè)我沒試，大家可以自行測試下。
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.靜態(tài)方法定義
我們還可以通過模型上的對(duì)應(yīng)靜態(tài)方法來定義一個(gè)事件，在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');
}
}
通過靜態(tài)方法定義的時(shí)候，可以直接傳遞進(jìn)入一個(gè)閉包，也可以定義為某個(gè)類的方法，事件觸發(fā)時(shí)候傳遞進(jìn)入的參數(shù)就是該模型實(shí)例。
2.模型事件實(shí)現(xiàn)原理
Laravel的模型事件所有的代碼都在Illuminate\Database\Eloquent\Concerns\HasEvents這個(gè)trait下，先來看看Laravel是如何注冊(cè)這些事件的，其中的$dispatcher是一個(gè)事件的調(diào)度器Illuminate\Contracts\Events\Dispatcher實(shí)例，在Illuminate\Database\DatabaseServiceProvider的boot方法中注入。
protected static function registerModelEvent($event, $callback){
if (isset(static::$dispatcher)) {
$name = static::class;
static::$dispatcher->listen("eloquent.{$event}: {$name}", $callback);
}
}
這里是Laravel事件注冊(cè)的地方，其中以eloquent.saved:App\User為事件名，$callback作為處理器來注冊(cè)。這個(gè)注冊(cè)事件的方法，只會(huì)注冊(cè)以觀察者和靜態(tài)方法定義的。假如你定義為模型的$events屬性的話，Laravel是不會(huì)注冊(cè)的，會(huì)在觸發(fā)事件的時(shí)候同步觸發(fā)，接下來會(huì)分析。
然后在HasEvents中定義了一堆的方法如下，這些就是我們上面通過靜態(tài)方法來定義事件監(jiān)聽器的原理，不多說一看就懂。
public static function saving($callback){
static::registerModelEvent('saving', $callback);
}
public static function saved($callback){
static::registerModelEvent('saved', $callback);
}
那么如何通過觀察者的形式來定義事件監(jiān)聽器呢？看源碼：
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的類名，然后判斷是否存在事件名對(duì)應(yīng)的方法，存在則調(diào)用registerModelEvent注冊(cè)，這里事件名還包括我們自己定義在observables數(shù)組中的。
事件以及監(jiān)聽器都定義好后，就是如何觸發(fā)了，前面說到有一個(gè)方法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
);
}
其中比較關(guān)鍵的一個(gè)方法是fireCustomModelEvent，它接受一個(gè)事件名以及觸發(fā)方式。順帶一提，filterModelEventResults這個(gè)方法的作用就是把監(jiān)聽器的返回值為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;
}
}
這個(gè)就是用來觸發(fā)我們通過$events定義的事件了，假如我們這么定義：
class User extends Model{
protected $events = [
'saved' => UserSaved::class
]
}
那這里的觸發(fā)就是：
$result = static::$dispatcher->fire(new UserSaved($this));
順帶一提，Laravel中觸發(fā)事件的方法有兩個(gè)，一個(gè)是常用的fire，還有一個(gè)是util，這兩個(gè)的差別就是fire會(huì)把監(jiān)聽器的返回值返回，而util永遠(yuǎn)返回null
然后接下來就是會(huì)去觸發(fā)通過觀察者和靜態(tài)方法定義的監(jiān)聽器了，這一段代碼：
if ($result === false) {
return false;
}
return ! empty($result) ? $result : static::$dispatcher->{$method}(
"eloquent.{$event}: ".static::class, $this
);
這里會(huì)先判斷$events定義的監(jiān)聽器是否返回false以及返回值是否為空，如果為false則直接結(jié)束事件，如果返回不為false而且為空的話，會(huì)再去觸發(fā)通過觀察者和靜態(tài)方法定義的監(jiān)聽器，并且把監(jiān)聽器的返回值返回。
完。
總結(jié)
以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，如果有疑問大家可以留言交流，謝謝大家對(duì)腳本之家的支持。
您可能感興趣的文章:- Laravel框架源碼解析之入口文件原理分析
- Laravel框架源碼解析之反射的使用詳解
- Laravel源碼解析之路由的使用和示例詳解
- 通過源碼解析Laravel的依賴注入
- Laravel框架學(xué)習(xí)筆記（二）項(xiàng)目實(shí)戰(zhàn)之模型（Models）
- laravel model模型定義實(shí)現(xiàn)開啟自動(dòng)管理時(shí)間created_at,updated_at
- laravel model模型處理之修改查詢或修改字段時(shí)的類型格式案例
- Laravel5.1 框架模型工廠ModelFactory用法實(shí)例分析
- Laravel 5框架學(xué)習(xí)之模型、控制器、視圖基礎(chǔ)流程
- Laravel模型間關(guān)系設(shè)置分表的方法示例
- laravel學(xué)習(xí)教程之關(guān)聯(lián)模型
- Laravel框架源碼解析之模型Model原理與用法解析
