Laravel 创建事件监听器 - PHP

介绍

在 Laravel 中，事件是一种使得应用程序各部分之间互相协调和通讯的优雅方式。事件是一个特殊的对象，它包含了应用程序内部的一些状态信息和触发事件的方法。而事件监听器则是解耦了事件和应用程序的实际逻辑之间的关联关系，是事件流程中的关键角色之一。

监听器是一个类，它包含了在事件被触发时，应用程序需要执行的操作。在 Laravel 中，通过创建和注册事件监听器，我们可以轻松地处理所有类型的事件并执行相应的操作。建议将事件监听器与其需要响应的事件放在同一个目录中。

创建事件监听器

创建事件监听器的步骤如下：

1. 创建监听器

   <?php
   
   namespace App\Listeners;
   
   use Illuminate\Contracts\Queue\ShouldQueue;
   use Illuminate\Queue\InteractsWithQueue;
   
   class OrderShipped
   {
       /**
        * Create the event listener.
        *
        * @return void
        */
       public function __construct()
       {
           //
       }
   
       /**
        * Handle the event.
        *
        * @param  OrderShipped  $event
        * @return void
        */
       public function handle($event)
       {
           //
       }
   }
   

   在该示例中，我们创建了一个名为 OrderShipped 的事件监听器，并且定义了其构造函数和处理事件的 handle 方法。示例中的监听器类位于 App\Listeners 命名空间下。

2. 注册监听器

   接着，我们需要将监听器注册到对应的事件中。在 Laravel 中，我们使用 EventServiceProvider.php 文件来注册事件和监听器。我们需要找到其 boot 方法并加入要注册的监听器和其对应的事件。

   /**
    * The event listener mappings for the application.
    *
    * @var array
    */
   protected $listen = [
       'App\Events\OrderShipped' => [
           'App\Listeners\SendShipmentNotification',
           'App\Listeners\UpdateProductInventory',
       ],
   ];
   

   在上述代码中，我们将 OrderShipped 事件与 SendShipmentNotification 以及 UpdateProductInventory 两个事件监听器进行了绑定。需要注意的是，监听器的名称必须与监听器类的名称一致。

绑定多个监听器

在 Laravel 中，可以通过将多个监听器的名称以数组的形式传递给事件的 listen 方法来为事件绑定多个监听器。在触发事件时，每个监听器将按照它们被注册的顺序依次执行。

protected $listen = [
    'App\Events\OrderShipped' => [
        'App\Listeners\SendShipmentNotification',
        'App\Listeners\UpdateProductInventory',
    ],
];

触发事件

Laravel 中的事件使得应用程序中不相关的部分之间能够协调协作。为了触发事件，我们可以使用 event 函数并且将要触发的事件实例传递给它。触发事件后，所有已注册的监听器将会按照注册顺序依次执行。下面是一个触发事件的示例：

event(new OrderShipped($order));

在上述示例中，我们利用 OrderShipped 事件实例化了一个新的事件，并使用 event 函数来触发它。所有已注册的监听器都将在该步骤执行。

总结

在本文中，我们已经介绍了 Laravel 中如何创建和注册事件监听器，以及触发事件的过程。大家可以通过这些内容来了解事件和监听器在 Laravel 中的基本应用方式。