事件

• 介紹
• 生成事件與監聽器
• 註冊事件與監聽器
  • 事件探索
  • 手動註冊事件
  • 閉包監聽器
• 定義事件
• 定義監聽器
• 佇列事件監聽器
  • 手動與佇列互動
  • 佇列事件監聽器與資料庫交易
  • 佇列監聽器中介層
  • 加密佇列監聽器
  • 處理失敗的 Job
• 分派事件
  • 在資料庫交易後分派事件
  • 延遲事件
• 事件訂閱者
  • 撰寫事件訂閱者
  • 註冊事件訂閱者
• 測試
  • 模擬部分事件
  • 範圍事件模擬

介紹

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 event.
     */
    public function handle(PodcastProcessed $event): void
    {
        // ...
    }
}

您可以使用 PHP 的聯合型別來監聽多個事件：

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

如果您計劃將監聽器儲存在不同的目錄或多個目錄中，您可以使用應用程式的 bootstrap/app.php 檔案中的 withEvents 方法指示 Laravel 掃描這些目錄：

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

您可以使用 * 字元作為萬用字元，掃描多個類似目錄中的監聽器：

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

event:list 指令可用於列出應用程式中註冊的所有監聽器：

php artisan event:list

生產環境中的事件探索

為了提升應用程式的速度，您應該使用 optimize 或 event:cache Artisan 指令快取所有應用程式監聽器的清單。通常，此指令應該作為應用程式部署流程的一部分執行。此清單將被框架用於加速事件註冊過程。event:clear 指令可用於銷毀事件快取。

手動註冊事件

使用 Event Facade，您可以在應用程式的 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) {
        // ...
    }));
}

就像佇列 Job 一樣，您可以使用 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 trait 會優雅地序列化任何 Eloquent 模型，如果事件物件是使用 PHP 的 serialize 函數序列化時，例如在使用佇列監聽器時。

定義監聽器

接下來，讓我們看看範例事件的監聽器。事件監聽器在其 handle 方法中接收事件實例。make:listener Artisan 命令，當使用 --event 選項呼叫時，會自動導入正確的事件類別並在 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 service container 解析，因此依賴項將自動注入。

停止事件的傳播

有時，您可能希望停止事件傳播到其他監聽器。您可以透過從監聽器的 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 的佇列系統加入佇列。如果監聽器由佇列執行時沒有拋出任何例外，則佇列化的 Job 將會在處理完成後自動被刪除。

自訂佇列連線、名稱與延遲

如果您想自訂事件監聽器的佇列連線、佇列名稱或佇列延遲時間，您可以在監聽器類別上定義 $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;
    }
}

手動與佇列互動

如果您需要手動存取監聽器底層佇列 Job 的 delete 和 release 方法，您可以透過使用 Illuminate\Queue\InteractsWithQueue Trait 來達成。這個 Trait 預設在生成的監聽器中匯入，並提供對這些方法的存取：

<?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 ($condition) {
            $this->release(30);
        }
    }
}

佇列事件監聽器與資料庫交易

當佇列化的監聽器在資料庫交易中被分派時，它們可能會在資料庫交易提交之前由佇列處理。發生這種情況時，在資料庫交易期間對 Models 或資料庫記錄所做的任何更新可能尚未反映在資料庫中。此外，在交易中建立的任何 Models 或資料庫記錄可能不存在於資料庫中。如果您的監聽器依賴於這些 Models，當分派佇列監聽器的 Job 被處理時，可能會發生意料之外的錯誤。

如果您的佇列連線的 after_commit 設定選項設為 false，您仍然可以透過在監聽器類別上實作 ShouldQueueAfterCommit 介面，來表示特定的佇列監聽器應在所有開啟的資料庫交易提交後才分派：

<?php

namespace App\Listeners;

use Illuminate\Contracts\Queue\ShouldQueueAfterCommit;
use Illuminate\Queue\InteractsWithQueue;

class SendShipmentNotification implements ShouldQueueAfterCommit
{
    use InteractsWithQueue;
}

📌 備註

若要深入了解如何解決這些問題，請參閱有關佇列 Job 與資料庫交易的文件。

佇列監聽器中介層

佇列監聽器也可以利用Job 中介層。Job 中介層允許您在佇列監聽器執行時包裝自訂邏輯，減少監聽器本身的樣板程式碼。建立 Job 中介層後，可以透過從監聽器的 middleware 方法回傳它們來將其附加到監聽器：

<?php

namespace App\Listeners;

use App\Events\OrderShipped;
use App\Jobs\Middleware\RateLimited;
use Illuminate\Contracts\Queue\ShouldQueue;

class SendShipmentNotification implements ShouldQueue
{
    /**
     * Handle the event.
     */
    public function handle(OrderShipped $event): void
    {
        // Process the event...
    }

    /**
     * Get the middleware the listener should pass through.
     *
     * @return array<int, object>
     */
    public function middleware(OrderShipped $event): array
    {
        return [new RateLimited];
    }
}

加密佇列監聽器

Laravel 允許您透過加密來確保佇列監聽器資料的隱私與完整性。若要開始使用，只需將 ShouldBeEncrypted 介面添加到監聽器類別。一旦此介面被添加到類別中，Laravel 將在將您的監聽器推送到佇列之前自動加密它：

<?php

namespace App\Listeners;

use App\Events\OrderShipped;
use Illuminate\Contracts\Queue\ShouldBeEncrypted;
use Illuminate\Contracts\Queue\ShouldQueue;

class SendShipmentNotification implements ShouldQueue, ShouldBeEncrypted
{
    // ...
}

處理失敗的 Job

有時您的佇列事件監聽器可能會失敗。如果佇列監聽器超過了您的佇列 Worker 所定義的最大嘗試次數，則監聽器上的 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);
}

如果同時定義了 retryUntil 和 tries，Laravel 會優先採用 retryUntil 方法。

指定佇列監聽器退避時間

如果您想設定 Laravel 在重試遇到異常的監聽器之前應該等待多少秒，您可以透過在監聽器類別上定義 backoff 屬性來實現：

/**
 * The number of seconds to wait before retrying the queued listener.
 *
 * @var int
 */
public $backoff = 3;

如果您需要更複雜的邏輯來決定監聽器的退避時間，您可以在監聽器類別上定義一個 backoff 方法：

/**
 * Calculate the number of seconds to wait before retrying the queued listener.
 */
public function backoff(OrderShipped $event): int
{
    return 3;
}

您可以透過從 backoff 方法回傳一個退避值陣列來輕鬆設定「指數型」退避。在此範例中，如果還有更多嘗試次數，則第一次重試的延遲為 1 秒，第二次重試為 5 秒，第三次重試為 10 秒，之後的每次重試都為 10 秒：

/**
 * Calculate the number of seconds to wait before retrying the queued listener.
 *
 * @return list<int>
 */
public function backoff(OrderShipped $event): array
{
    return [1, 5, 10];
}

指定佇列監聽器最大異常數

有時您可能希望指定佇列監聽器可以嘗試多次，但如果重試是由特定數量的未處理異常觸發（而不是直接由 release 方法釋放），則應失敗。為此，您可以在監聽器類別上定義一個 maxExceptions 屬性：

<?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 = 25;

    /**
     * The maximum number of unhandled exceptions to allow before failing.
     *
     * @var int
     */
    public $maxExceptions = 3;

    /**
     * Handle the event.
     */
    public function handle(OrderShipped $event): void
    {
        // Process the event...
    }
}

在此範例中，監聽器將重試最多 25 次。但是，如果監聽器拋出三個未處理的異常，則監聽器將會失敗。

指定佇列監聽器逾時時間

通常，您大致知道佇列監聽器預計需要多長時間。因此，Laravel 允許您指定一個「逾時」值。如果監聽器處理的時間超過逾時值所指定的秒數，處理該監聽器的 Worker 將會以錯誤結束。您可以透過在監聽器類別上定義一個 timeout 屬性來定義監聽器允許執行的最大秒數：

<?php

namespace App\Listeners;

use App\Events\OrderShipped;
use Illuminate\Contracts\Queue\ShouldQueue;

class SendShipmentNotification implements ShouldQueue
{
    /**
     * The number of seconds the listener can run before timing out.
     *
     * @var int
     */
    public $timeout = 120;
}

如果您希望指示監聽器在逾時時應被標記為失敗，您可以在監聽器類別上定義 failOnTimeout 屬性：

<?php

namespace App\Listeners;

use App\Events\OrderShipped;
use Illuminate\Contracts\Queue\ShouldQueue;

class SendShipmentNotification implements ShouldQueue
{
    /**
     * Indicate if the listener should be marked as failed on timeout.
     *
     * @var bool
     */
    public $failOnTimeout = true;
}

分派事件

要分派事件，您可以呼叫事件上的靜態 dispatch 方法。此方法透過 Illuminate\Foundation\Events\Dispatchable trait 在事件上可用。任何傳遞給 dispatch 方法的參數都將傳遞給事件的建構函式：

<?php

namespace App\Http\Controllers;

use App\Events\OrderShipped;
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,
    ) {}
}

延遲事件

延遲事件允許您延遲模型事件的分派以及事件監聽器的執行，直到特定程式碼區塊完成之後。當您需要確保在觸發事件監聽器之前所有相關記錄都已建立時，這特別有用。

要延遲事件，請提供一個閉包給 Event::defer() 方法：

use App\Models\User;
use Illuminate\Support\Facades\Event;

Event::defer(function () {
    $user = User::create(['name' => 'Victoria Otwell']);

    $user->posts()->create(['title' => 'My first post!']);
});

閉包中觸發的所有事件都將在閉包執行後分派。這確保了事件監聽器能夠存取在延遲執行期間建立的所有相關記錄。如果在閉包中發生異常，延遲事件將不會被分派。

要僅延遲特定事件，請將一個事件陣列作為第二個參數傳遞給 defer 方法：

use App\Models\User;
use Illuminate\Support\Facades\Event;

Event::defer(function () {
    $user = User::create(['name' => 'Victoria Otwell']);

    $user->posts()->create(['title' => 'My first post!']);
}, ['eloquent.created: '.User::class]);

事件訂閱者

撰寫事件訂閱者

事件訂閱者是可以在訂閱者類別本身內訂閱多個事件的類別，允許您在單一類別中定義多個事件處理器。訂閱者應定義一個 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 Facade 的 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 Facade 的 fake 方法，您可以阻止監聽器執行、執行待測試的程式碼，然後使用 assertDispatched、assertNotDispatched 和 assertNothingDispatched 方法斷言您的應用程式分派了哪些事件：

Pest

<?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 dispatched once...
    Event::assertDispatchedOnce(OrderShipped::class);

    // Assert an event was not dispatched...
    Event::assertNotDispatched(OrderFailedToShip::class);

    // Assert that no events were dispatched...
    Event::assertNothingDispatched();
});

PHPUnit

<?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 dispatched once...
        Event::assertDispatchedOnce(OrderShipped::class);

        // 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 方法：

Pest

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([
        // ...
    ]);
});

PHPUnit

/**
 * 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 方法：

Pest

<?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([
        // ...
    ]);
});

PHPUnit

<?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([
            // ...
        ]);
    }
}