ホームページ > 記事 > バックエンド開発 > Laravelモデルのイベント実装手順の詳細説明

Laravelモデルのイベント実装手順の詳細説明

php中世界最好的语言オリジナル: 2018-05-18 11:13:222033ブラウズ

今回は、Laravel モデルのイベントを実装するための手順について詳しく説明します。Laravel モデルのイベントを実装するための注意点について、実際の事例を見てみましょう。

前書き

Laravel の ORM モデルは、特定の状況下で一連のイベントをトリガーします。現在サポートされているイベントは、作成、作成、更新、更新、保存、保存、削除、削除、復元、復元です。この関数は最下位レベルで実装されていますか?

以下で言うことはあまりありません。詳細な紹介を見てみましょう。

1. モデルイベントの使い方

まず、モデルイベントの使い方を見てみましょう。実際には、モデルイベントを定義する方法は 2 つあります。ここでは保存されたイベントを例として取り上げますが、他のすべてのイベントは同じです。

1.events 属性

コードに直接移動します:

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

これは理解するのが難しく、ドキュメントでは詳しく説明されていません。最初は、保存後にハンドルメソッドがトリガーされるのだと思いました。 UserSaved が呼び出されますが、実際には呼び出されません。この配列は単なるイベントのマッピングであり、モデルが保存されるときに 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();
 }
}

このように、保存されたノードが保存されると、UserSaved イベントがトリガーされ、そのリスナー UserSavedListener のハンドルメソッドが呼び出されます。

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)
 {
  //
 }
}

次に、オブザーバーをサービスプロバイダーのブートメソッドに登録します:

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 メソッドを呼び出すだけで、手動でトリガーする必要があります。ただし、このメソッドはプロテクトされているため、自分で定義したモデルメソッドでのみ使用できます。もちろん、リフレクションを通じて呼び出された場合は、$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 のブートメソッドで定義された、モデルの対応する静的メソッドを通じてイベントを定義することもできます:

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 のモデルイベントのすべてのコードは、IlluminateDatabaseEloquentConcernsEvents の下にあります。まず、Laravel がこれらのイベントをどのように登録するかを見てみましょう。注入されたIlluminateDatabaseDatabaseServiceProvider のブートメソッド。

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

これは、イベント名として eloquent.saved:AppUser 、プロセッサとして $callback を使用して、Laravel イベントが登録される場所です。このイベント登録方法では、オブザーバーおよび静的メソッドとして定義されたイベントのみが登録されます。これをモデルの $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
  );
 }

まず、オブザーバーのクラス名を取得し、イベント名に対応するメソッドがあるかどうかを確認します。存在する場合は、 registerModelEvent を呼び出して登録します。オブザーバブル配列で定義されます。

イベントとリスナーを定義したら、それらをトリガーします。ソースコードを見てみましょう。

 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而且为空的话，会再去触发通过观察者和静态方法定义的监听器，并且把监听器的返回值返回。
完。

相信看了本文案例你已经掌握了方法，更多精彩请关注php中文网其它相关文章！

Laravelモデルのイベント実装手順の詳細説明

関連記事