事件

简介
生成事件和监听器
注册事件和监听器
定义事件
定义监听器
可排队的事件监听器
分发事件
- 在数据库事务后分发事件
事件订阅者
- 编写事件订阅者
- 注册事件订阅者
测试
- 伪造一部分事件
- 作用域事件伪造

简介

Laravel 的事件提供了一个简单的观察者模式实现，允许你订阅和监听应用程序中发生的各种事件。事件类通常存储在 app/Events 目录中，而它们的监听器则存储在 app/Listeners 中。如果在你的应用程序中没有看到这些目录，不用担心，因为在使用 Artisan 控制台命令生成事件和监听器时，它们将自动为你创建。

事件是解耦应用程序各个方面的好方法，因为单个事件可以有多个相互独立的监听器。例如，你可能希望在每次订单发货时向用户发送 Slack 通知。与其将订单处理代码与 Slack 通知代码耦合，不如触发一个 App\Events\OrderShipped 事件，监听器可以接收该事件并用于分发 Slack 通知。

生成事件和监听器

要快速生成事件和监听器，可以使用 make:event 和 make:listener Artisan 命令。

php artisan make:event PodcastProcessed
 
php artisan make:listener SendPodcastNotification --event=PodcastProcessed

为了方便起见，你也可以在不带额外参数的情况下调用 make:event 和 make:listener Artisan 命令。当你这样做时，Laravel 会自动提示你输入类名，并在创建监听器时提示它应该监听的事件。

php artisan make:event
 
php artisan make:listener

注册事件和监听器

事件发现

默认情况下，Laravel 会通过扫描应用程序的 Listeners 目录来自动查找并注册你的事件监听器。当 Laravel 找到任何以 handle 或 __invoke 开头的监听器类方法时，Laravel 会将这些方法注册为事件监听器，用于方法签名中类型提示的事件。

use App\Events\PodcastProcessed;
 
class SendPodcastNotification
{
    /**
     * Handle the given event.
     */
    public function handle(PodcastProcessed $event): void
    {
        // ...
    }
}

可以使用 PHP 的联合类型来监听多个事件。

/**
 * Handle the given event.
 */
public function handle(PodcastProcessed|PodcastPublished $event): void
{
    // ...
}

如果计划将监听器存储在不同的目录或多个目录中，可以使用应用程序的 bootstrap/app.php 文件中的 withEvents 方法指示 Laravel 扫描这些目录。

->withEvents(discover: [
    __DIR__.'/../app/Domain/Orders/Listeners',
])

event:list 命令可用于列出应用程序中注册的所有监听器。

php artisan event:list

生产环境中的事件发现

为了提高应用程序的速度，应使用 optimize 或 event:cache Artisan 命令缓存应用程序所有监听器的清单。通常，此命令应作为应用程序部署过程的一部分运行。框架将使用此清单来加快事件注册过程。event:clear 命令可用于销毁事件缓存。

手动注册事件

使用 Event 门面，可以在应用程序的 AppServiceProvider 的 boot 方法中手动注册事件及其相应的监听器。

use App\Domain\Orders\Events\PodcastProcessed;
use App\Domain\Orders\Listeners\SendPodcastNotification;
use Illuminate\Support\Facades\Event;
 
/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Event::listen(
        PodcastProcessed::class,
        SendPodcastNotification::class,
    );
}

event:list 命令可用于列出应用程序中注册的所有监听器。

php artisan event:list

闭包监听器

通常，监听器被定义为类；但是，你也可以在应用程序的 AppServiceProvider 的 boot 方法中手动注册基于闭包的事件监听器。

use App\Events\PodcastProcessed;
use Illuminate\Support\Facades\Event;
 
/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Event::listen(function (PodcastProcessed $event) {
        // ...
    });
}

可排队的匿名事件监听器

在注册基于闭包的事件监听器时，可以使用 Illuminate\Events\queueable 函数将监听器闭包包装起来，以指示 Laravel 使用队列执行监听器。

use App\Events\PodcastProcessed;
use function Illuminate\Events\queueable;
use Illuminate\Support\Facades\Event;
 
/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Event::listen(queueable(function (PodcastProcessed $event) {
        // ...
    }));
}

与排队作业一样，可以使用 onConnection、onQueue 和 delay 方法来自定义排队监听器的执行。

Event::listen(queueable(function (PodcastProcessed $event) {
    // ...
})->onConnection('redis')->onQueue('podcasts')->delay(now()->addSeconds(10)));

如果要处理匿名排队监听器故障，可以在定义 queueable 监听器时向 catch 方法提供一个闭包。此闭包将接收事件实例和导致监听器故障的 Throwable 实例。

use App\Events\PodcastProcessed;
use function Illuminate\Events\queueable;
use Illuminate\Support\Facades\Event;
use Throwable;
 
Event::listen(queueable(function (PodcastProcessed $event) {
    // ...
})->catch(function (PodcastProcessed $event, Throwable $e) {
    // The queued listener failed...
}));

通配符事件监听器

你还可以使用 * 字符作为通配符参数注册监听器，允许你在同一个监听器上捕获多个事件。通配符监听器将事件名称作为其第一个参数，将整个事件数据数组作为其第二个参数。

Event::listen('event.*', function (string $eventName, array $data) {
    // ...
});

定义事件

事件类本质上是一个数据容器，其中包含与事件相关的信息。例如，假设一个 App\Events\OrderShipped 事件接收一个 Eloquent ORM 对象。

<?php
 
namespace App\Events;
 
use App\Models\Order;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;
 
class OrderShipped
{
    use Dispatchable, InteractsWithSockets, SerializesModels;
 
    /**
     * Create a new event instance.
     */
    public function __construct(
        public Order $order,
    ) {}
}

如你所见，此事件类不包含任何逻辑。它是已购买的 App\Models\Order 实例的容器。事件使用的 SerializesModels 特性将在使用 PHP 的 serialize 函数（例如，在使用排队监听器时）序列化事件对象时优雅地序列化任何 Eloquent 模型。

定义监听器

接下来，让我们看看示例事件的监听器。事件监听器在其 handle 方法中接收事件实例。当使用 --event 选项调用 make:listener Artisan 命令时，它会自动导入正确的事件类并在 handle 方法中对事件进行类型提示。在 handle 方法中，可以执行响应事件所需的任何操作。

<?php
 
namespace App\Listeners;
 
use App\Events\OrderShipped;
 
class SendShipmentNotification
{
    /**
     * Create the event listener.
     */
    public function __construct() {}
 
    /**
     * Handle the event.
     */
    public function handle(OrderShipped $event): void
    {
        // Access the order using $event->order...
    }
}

事件监听器也可以在其构造函数中类型提示任何所需的依赖项。所有事件监听器都通过 Laravel 服务容器解析，因此依赖项将自动注入。

停止事件传播

有时，你可能希望停止事件传播到其他监听器。可以通过从监听器的 handle 方法返回 false 来实现。

可排队的事件监听器

如果监听器要执行缓慢的任务（例如发送电子邮件或发出 HTTP 请求），则排队监听器可能会有益。在使用排队监听器之前，请确保配置队列并在服务器或本地开发环境上启动队列工作器。

要指定监听器应排队，请将 ShouldQueue 接口添加到监听器类。由 make:listener Artisan 命令生成的监听器已将此接口导入到当前命名空间中，因此可以立即使用它。

<?php
 
namespace App\Listeners;
 
use App\Events\OrderShipped;
use Illuminate\Contracts\Queue\ShouldQueue;
 
class SendShipmentNotification implements ShouldQueue
{
    // ...
}

就是这样！现在，当分发由此监听器处理的事件时，事件分发器将使用 Laravel 的队列系统自动将监听器排队。如果在队列执行监听器时未引发异常，则排队作业将在处理完成后自动删除。

自定义队列连接、名称和延迟

如果要自定义事件监听器的队列连接、队列名称或队列延迟时间，可以在监听器类上定义 $connection、$queue 或 $delay 属性。

<?php
 
namespace App\Listeners;
 
use App\Events\OrderShipped;
use Illuminate\Contracts\Queue\ShouldQueue;
 
class SendShipmentNotification implements ShouldQueue
{
    /**
     * The name of the connection the job should be sent to.
     *
     * @var string|null
     */
    public $connection = 'sqs';
 
    /**
     * The name of the queue the job should be sent to.
     *
     * @var string|null
     */
    public $queue = 'listeners';
 
    /**
     * The time (seconds) before the job should be processed.
     *
     * @var int
     */
    public $delay = 60;
}

如果要在运行时定义监听器的队列连接、队列名称或延迟，可以在监听器上定义 viaConnection、viaQueue 或 withDelay 方法。

/**
 * Get the name of the listener's queue connection.
 */
public function viaConnection(): string
{
    return 'sqs';
}
 
/**
 * Get the name of the listener's queue.
 */
public function viaQueue(): string
{
    return 'listeners';
}
 
/**
 * Get the number of seconds before the job should be processed.
 */
public function withDelay(OrderShipped $event): int
{
    return $event->highPriority ? 0 : 60;
}

有条件地排队监听器

有时，你可能需要根据运行时才可用的某些数据来确定是否应排队监听器。为此，可以向监听器添加 shouldQueue 方法来确定是否应排队监听器。如果 shouldQueue 方法返回 false，则不会排队监听器。

<?php
 
namespace App\Listeners;
 
use App\Events\OrderCreated;
use Illuminate\Contracts\Queue\ShouldQueue;
 
class RewardGiftCard implements ShouldQueue
{
    /**
     * Reward a gift card to the customer.
     */
    public function handle(OrderCreated $event): void
    {
        // ...
    }
 
    /**
     * Determine whether the listener should be queued.
     */
    public function shouldQueue(OrderCreated $event): bool
    {
        return $event->order->subtotal >= 5000;
    }
}

手动与队列交互

如果需要手动访问监听器底层队列作业的 delete 和 release 方法，可以使用 Illuminate\Queue\InteractsWithQueue 特性。此特性在生成的监听器上默认导入，并提供对这些方法的访问。

<?php
 
namespace App\Listeners;
 
use App\Events\OrderShipped;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue;
 
class SendShipmentNotification implements ShouldQueue
{
    use InteractsWithQueue;
 
    /**
     * Handle the event.
     */
    public function handle(OrderShipped $event): void
    {
        if (true) {
            $this->release(30);
        }
    }
}

可排队的事件监听器和数据库事务

当在数据库事务中调度排队的监听器时，它们可能会在数据库事务提交之前由队列处理。当这种情况发生时，您在数据库事务期间对模型或数据库记录所做的任何更新可能尚未反映在数据库中。此外，在事务中创建的任何模型或数据库记录可能不存在于数据库中。如果您的监听器依赖于这些模型，则在处理调度排队监听器的工作时可能会发生意外错误。

如果您的队列连接的after_commit配置选项设置为false，您仍然可以通过在监听器类上实现ShouldQueueAfterCommit接口来指示某个特定的排队监听器应该在所有打开的数据库事务提交后调度。

<?php
 
namespace App\Listeners;
 
use Illuminate\Contracts\Queue\ShouldQueueAfterCommit;
use Illuminate\Queue\InteractsWithQueue;
 
class SendShipmentNotification implements ShouldQueueAfterCommit
{
    use InteractsWithQueue;
}

要了解有关解决这些问题的更多信息，请查看有关排队作业和数据库事务的文档。

处理失败的作业

有时您的排队事件监听器可能会失败。如果排队监听器超过了队列工作程序定义的最大尝试次数，则将在您的监听器上调用failed方法。failed方法接收事件实例和导致失败的Throwable。

<?php
 
namespace App\Listeners;
 
use App\Events\OrderShipped;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue;
use Throwable;
 
class SendShipmentNotification implements ShouldQueue
{
    use InteractsWithQueue;
 
    /**
     * Handle the event.
     */
    public function handle(OrderShipped $event): void
    {
        // ...
    }
 
    /**
     * Handle a job failure.
     */
    public function failed(OrderShipped $event, Throwable $exception): void
    {
        // ...
    }
}

指定排队监听器最大尝试次数

如果您的某个排队监听器遇到错误，您可能不希望它无限期地继续重试。因此，Laravel 提供了多种方法来指定监听器可以尝试的次数或持续时间。

您可以在监听器类上定义一个$tries属性来指定在监听器被认为失败之前可以尝试的次数。

<?php
 
namespace App\Listeners;
 
use App\Events\OrderShipped;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue;
 
class SendShipmentNotification implements ShouldQueue
{
    use InteractsWithQueue;
 
    /**
     * The number of times the queued listener may be attempted.
     *
     * @var int
     */
    public $tries = 5;
}

作为定义监听器在失败之前可以尝试多少次的一种替代方法，您可以定义一个监听器不应该再尝试的时间。这允许监听器在给定的时间范围内尝试任意次数。要定义监听器不应该再尝试的时间，请向您的监听器类添加一个retryUntil方法。此方法应返回一个DateTime实例。

use DateTime;
 
/**
 * Determine the time at which the listener should timeout.
 */
public function retryUntil(): DateTime
{
    return now()->addMinutes(5);
}

分发事件

要调度事件，您可以调用事件上的静态dispatch方法。此方法通过Illuminate\Foundation\Events\Dispatchable特征在事件上可用。传递给dispatch方法的任何参数都将传递给事件的构造函数。

<?php
 
namespace App\Http\Controllers;
 
use App\Events\OrderShipped;
use App\Http\Controllers\Controller;
use App\Models\Order;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
 
class OrderShipmentController extends Controller
{
    /**
     * Ship the given order.
     */
    public function store(Request $request): RedirectResponse
    {
        $order = Order::findOrFail($request->order_id);
 
        // Order shipment logic...
 
        OrderShipped::dispatch($order);
 
        return redirect('/orders');
    }
}

如果您想有条件地调度事件，您可以使用dispatchIf和dispatchUnless方法。

OrderShipped::dispatchIf($condition, $order);
 
OrderShipped::dispatchUnless($condition, $order);

在测试时，断言某些事件已调度而无需实际触发其监听器可能很有用。Laravel 的内置测试助手使这变得轻而易举。

在数据库事务后分发事件

有时，您可能希望指示 Laravel 仅在活动数据库事务提交后调度事件。为此，您可以在事件类上实现ShouldDispatchAfterCommit接口。

此接口指示 Laravel 在当前数据库事务提交之前不要调度事件。如果事务失败，则会丢弃事件。如果在调度事件时没有数据库事务正在进行，则会立即调度事件。

<?php
 
namespace App\Events;
 
use App\Models\Order;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Contracts\Events\ShouldDispatchAfterCommit;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;
 
class OrderShipped implements ShouldDispatchAfterCommit
{
    use Dispatchable, InteractsWithSockets, SerializesModels;
 
    /**
     * Create a new event instance.
     */
    public function __construct(
        public Order $order,
    ) {}
}

事件订阅者

编写事件订阅者

事件订阅者是可以订阅订阅者类本身中的多个事件的类，允许您在一个类中定义多个事件处理程序。订阅者应定义一个subscribe方法，该方法将传递一个事件调度器实例。您可以调用给定调度器上的listen方法来注册事件监听器。

<?php
 
namespace App\Listeners;
 
use Illuminate\Auth\Events\Login;
use Illuminate\Auth\Events\Logout;
use Illuminate\Events\Dispatcher;
 
class UserEventSubscriber
{
    /**
     * Handle user login events.
     */
    public function handleUserLogin(Login $event): void {}
 
    /**
     * Handle user logout events.
     */
    public function handleUserLogout(Logout $event): void {}
 
    /**
     * Register the listeners for the subscriber.
     */
    public function subscribe(Dispatcher $events): void
    {
        $events->listen(
            Login::class,
            [UserEventSubscriber::class, 'handleUserLogin']
        );
 
        $events->listen(
            Logout::class,
            [UserEventSubscriber::class, 'handleUserLogout']
        );
    }
}

如果您的事件监听器方法是在订阅者本身中定义的，您可能会发现从订阅者的subscribe方法返回事件和方法名称的数组更方便。Laravel 会在注册事件监听器时自动确定订阅者的类名。

<?php
 
namespace App\Listeners;
 
use Illuminate\Auth\Events\Login;
use Illuminate\Auth\Events\Logout;
use Illuminate\Events\Dispatcher;
 
class UserEventSubscriber
{
    /**
     * Handle user login events.
     */
    public function handleUserLogin(Login $event): void {}
 
    /**
     * Handle user logout events.
     */
    public function handleUserLogout(Logout $event): void {}
 
    /**
     * Register the listeners for the subscriber.
     *
     * @return array<string, string>
     */
    public function subscribe(Dispatcher $events): array
    {
        return [
            Login::class => 'handleUserLogin',
            Logout::class => 'handleUserLogout',
        ];
    }
}

注册事件订阅者

编写订阅者后，如果它们遵循 Laravel 的事件发现约定，Laravel 将自动注册订阅者中的处理程序方法。否则，您可以使用Event门面的subscribe方法手动注册您的订阅者。通常，这应该在应用程序的AppServiceProvider的boot方法中完成。

<?php
 
namespace App\Providers;
 
use App\Listeners\UserEventSubscriber;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\ServiceProvider;
 
class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        Event::subscribe(UserEventSubscriber::class);
    }
}

测试

在测试调度事件的代码时，您可能希望指示 Laravel 不要实际执行事件的监听器，因为监听器的代码可以直接单独测试，而不是测试调度相应事件的代码。当然，要测试监听器本身，您可以在测试中实例化一个监听器实例并直接调用handle方法。

使用Event门面的fake方法，您可以阻止监听器执行，执行被测代码，然后使用assertDispatched、assertNotDispatched和assertNothingDispatched方法断言应用程序调度了哪些事件。

<?php
 
use App\Events\OrderFailedToShip;
use App\Events\OrderShipped;
use Illuminate\Support\Facades\Event;
 
test('orders can be shipped', function () {
    Event::fake();
 
    // Perform order shipping...
 
    // Assert that an event was dispatched...
    Event::assertDispatched(OrderShipped::class);
 
    // Assert an event was dispatched twice...
    Event::assertDispatched(OrderShipped::class, 2);
 
    // Assert an event was not dispatched...
    Event::assertNotDispatched(OrderFailedToShip::class);
 
    // Assert that no events were dispatched...
    Event::assertNothingDispatched();
});

<?php
 
namespace Tests\Feature;
 
use App\Events\OrderFailedToShip;
use App\Events\OrderShipped;
use Illuminate\Support\Facades\Event;
use Tests\TestCase;
 
class ExampleTest extends TestCase
{
    /**
     * Test order shipping.
     */
    public function test_orders_can_be_shipped(): void
    {
        Event::fake();
 
        // Perform order shipping...
 
        // Assert that an event was dispatched...
        Event::assertDispatched(OrderShipped::class);
 
        // Assert an event was dispatched twice...
        Event::assertDispatched(OrderShipped::class, 2);
 
        // Assert an event was not dispatched...
        Event::assertNotDispatched(OrderFailedToShip::class);
 
        // Assert that no events were dispatched...
        Event::assertNothingDispatched();
    }
}

您可以将闭包传递给assertDispatched或assertNotDispatched方法，以断言已调度通过给定“真值测试”的事件。如果至少有一个通过给定真值测试的事件被调度，则断言将成功。

Event::assertDispatched(function (OrderShipped $event) use ($order) {
    return $event->order->id === $order->id;
});

如果您只想断言事件监听器正在侦听给定事件，您可以使用assertListening方法。

Event::assertListening(
    OrderShipped::class,
    SendShipmentNotification::class
);

调用Event::fake()后，将不会执行任何事件监听器。因此，如果您的测试使用依赖于事件的模型工厂，例如在模型的creating事件期间创建 UUID，则应在使用工厂**之后**调用Event::fake()。

伪造一部分事件

如果您只想为特定的一组事件伪造事件监听器，您可以将它们传递给fake或fakeFor方法。

test('orders can be processed', function () {
    Event::fake([
        OrderCreated::class,
    ]);
 
    $order = Order::factory()->create();
 
    Event::assertDispatched(OrderCreated::class);
 
    // Other events are dispatched as normal...
    $order->update([...]);
});

/**
 * Test order process.
 */
public function test_orders_can_be_processed(): void
{
    Event::fake([
        OrderCreated::class,
    ]);
 
    $order = Order::factory()->create();
 
    Event::assertDispatched(OrderCreated::class);
 
    // Other events are dispatched as normal...
    $order->update([...]);
}

您可以使用except方法伪造除指定的一组事件之外的所有事件。

Event::fake()->except([
    OrderCreated::class,
]);

范围事件伪造

如果您只想为测试的一部分伪造事件监听器，您可以使用fakeFor方法。

<?php
 
use App\Events\OrderCreated;
use App\Models\Order;
use Illuminate\Support\Facades\Event;
 
test('orders can be processed', function () {
    $order = Event::fakeFor(function () {
        $order = Order::factory()->create();
 
        Event::assertDispatched(OrderCreated::class);
 
        return $order;
    });
 
    // Events are dispatched as normal and observers will run ...
    $order->update([...]);
});

<?php
 
namespace Tests\Feature;
 
use App\Events\OrderCreated;
use App\Models\Order;
use Illuminate\Support\Facades\Event;
use Tests\TestCase;
 
class ExampleTest extends TestCase
{
    /**
     * Test order process.
     */
    public function test_orders_can_be_processed(): void
    {
        $order = Event::fakeFor(function () {
            $order = Order::factory()->create();
 
            Event::assertDispatched(OrderCreated::class);
 
            return $order;
        });
 
        // Events are dispatched as normal and observers will run ...
        $order->update([...]);
    }
}