이벤트 (Events)

• 소개
• 이벤트와 리스너 생성
• 이벤트와 리스너 등록
  • 이벤트 발견
  • 이벤트 수동 등록
  • 클로저 리스너
• 이벤트 정의
• 리스너 정의
• 큐 이벤트 리스너
  • 큐와 수동으로 상호작용하기
  • 큐 이벤트 리스너와 데이터베이스 트랜잭션
  • 큐 리스너 Middleware
  • 암호화된 큐 리스너
  • 고유 이벤트 리스너
    • 처리가 시작될 때까지 리스너를 고유하게 유지하기
    • 고유 리스너 잠금
  • 실패한 Job 처리
• 이벤트 디스패치
  • 데이터베이스 트랜잭션 이후 이벤트 디스패치
  • 이벤트 지연
• 이벤트 구독자
  • 이벤트 구독자 작성
  • 이벤트 구독자 등록
• 테스트
  • 일부 이벤트만 Fake 처리하기
  • 범위가 지정된 이벤트 Fake

소개 (Introduction)

Laravel의 이벤트는 간단한 옵저버 패턴 구현을 제공하여, 애플리케이션 안에서 발생하는 다양한 이벤트를 구독하고 감지할 수 있게 해줍니다. 이벤트 클래스는 일반적으로 app/Events 디렉터리에 저장되고, 해당 리스너는 app/Listeners에 저장됩니다. 애플리케이션에서 이 디렉터리가 보이지 않더라도 걱정하지 않아도 됩니다. Artisan 콘솔 명령어로 이벤트와 리스너를 생성하면 Laravel이 자동으로 만들어 줍니다.

이벤트는 애플리케이션의 여러 부분을 서로 분리하는 좋은 방법입니다. 하나의 이벤트에 서로 의존하지 않는 여러 리스너를 연결할 수 있기 때문입니다. 예를 들어 주문이 배송될 때마다 사용자에게 Slack 알림을 보내고 싶을 수 있습니다. 주문 처리 코드와 Slack 알림 코드를 직접 결합하는 대신, 리스너가 받아 Slack 알림을 디스패치할 수 있는 App\Events\OrderShipped 이벤트를 발생시킬 수 있습니다.

이벤트와 리스너 생성 (Generating Events and Listeners)

이벤트와 리스너를 빠르게 생성하려면 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

이벤트와 리스너 등록 (Registering Events and Listeners)

이벤트 발견

기본적으로 Laravel은 애플리케이션의 Listeners 디렉터리를 스캔하여 이벤트 리스너를 자동으로 찾아 등록합니다. Laravel이 handle 또는 __invoke로 시작하는 리스너 클래스 메서드를 발견하면, 해당 메서드의 시그니처에 타입 힌트된 이벤트에 대한 이벤트 리스너로 그 메서드를 등록합니다.

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 파사드를 사용하면 애플리케이션의 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()->plus(seconds: 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) {
    // ...
});

이벤트 정의 (Defining Events)

이벤트 클래스는 기본적으로 이벤트와 관련된 정보를 담는 데이터 컨테이너입니다. 예를 들어 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 모델을 적절하게 직렬화합니다.

리스너 정의 (Defining Listeners)

다음으로 예제 이벤트에 대한 리스너를 살펴보겠습니다. 이벤트 리스너는 handle 메서드에서 이벤트 인스턴스를 받습니다. make:listener Artisan 명령어를 --event 옵션과 함께 실행하면 적절한 이벤트 클래스를 자동으로 import하고, 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를 반환하면 됩니다.

큐 이벤트 리스너 (Queued Event Listeners)

리스너가 이메일 전송이나 HTTP 요청 같은 느린 작업을 수행해야 한다면 리스너를 큐에 넣는 것이 유용할 수 있습니다. 큐 리스너를 사용하기 전에 큐를 설정하고 서버나 로컬 개발 환경에서 큐 워커를 시작해야 합니다.

리스너가 큐에 들어가야 함을 지정하려면 리스너 클래스에 ShouldQueue 인터페이스를 추가합니다. make:listener Artisan 명령어로 생성된 리스너에는 이미 이 인터페이스가 현재 네임스페이스에 import되어 있으므로 바로 사용할 수 있습니다.

<?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;
use Illuminate\Queue\Attributes\Connection;
use Illuminate\Queue\Attributes\Delay;
use Illuminate\Queue\Attributes\Queue;

#[Connection('sqs')]
#[Queue('listeners')]
#[Delay(60)]
class SendShipmentNotification implements ShouldQueue
{
    // ...
}

런타임에 리스너의 큐 연결, 큐 이름 또는 지연 시간을 정의하려면 리스너에 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 트레이트를 사용하면 됩니다. 이 트레이트는 생성된 리스너에 기본적으로 import되어 있으며, 이러한 메서드에 접근할 수 있게 해줍니다.

<?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);
        }
    }
}

큐 처리되는 이벤트 리스너와 데이터베이스 트랜잭션

큐 처리되는 리스너가 데이터베이스 트랜잭션 안에서 디스패치되면, 데이터베이스 트랜잭션이 커밋되기 전에 큐에서 처리될 수 있습니다. 이런 상황이 발생하면 데이터베이스 트랜잭션 중에 모델이나 데이터베이스 레코드에 적용한 변경 사항이 아직 데이터베이스에 반영되지 않았을 수 있습니다. 또한 트랜잭션 안에서 생성한 모델이나 데이터베이스 레코드가 데이터베이스에 아직 존재하지 않을 수도 있습니다. 리스너가 이러한 모델에 의존한다면, 큐 처리되는 리스너를 디스패치한 작업이 처리될 때 예상치 못한 오류가 발생할 수 있습니다.

큐 연결의 after_commit 설정 옵션이 false로 설정되어 있더라도, 리스너 클래스에 ShouldQueueAfterCommit 인터페이스를 구현하면 열려 있는 모든 데이터베이스 트랜잭션이 커밋된 뒤에 특정 큐 리스너가 디스패치되어야 함을 지정할 수 있습니다.

<?php

namespace App\Listeners;

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

class SendShipmentNotification implements ShouldQueueAfterCommit
{
    use InteractsWithQueue;
}

이러한 문제를 해결하는 방법을 더 알아보려면 큐 작업과 데이터베이스 트랜잭션에 관한 문서를 확인하십시오.

큐 리스너 미들웨어

큐 처리되는 리스너도 작업 미들웨어를 사용할 수 있습니다. 작업 미들웨어를 사용하면 큐 리스너의 실행 전후에 사용자 정의 로직을 감쌀 수 있어, 리스너 자체의 반복 코드를 줄일 수 있습니다. 작업 미들웨어를 만든 뒤에는 리스너의 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
{
    // ...
}

고유 이벤트 리스너

고유 리스너를 사용하려면 락을 지원하는 캐시 드라이버가 필요합니다. 현재 memcached, redis, dynamodb, database, file, array 캐시 드라이버가 원자적 락을 지원합니다.

때로는 특정 리스너의 인스턴스가 어떤 시점에도 큐에 하나만 존재하도록 보장하고 싶을 수 있습니다. 리스너 클래스에 ShouldBeUnique 인터페이스를 구현하면 이를 수행할 수 있습니다.

<?php

namespace App\Listeners;

use App\Events\LicenseSaved;
use Illuminate\Contracts\Queue\ShouldBeUnique;
use Illuminate\Contracts\Queue\ShouldQueue;

class AcquireProductKey implements ShouldQueue, ShouldBeUnique
{
    public function __invoke(LicenseSaved $event): void
    {
        // ...
    }
}

위 예제에서 AcquireProductKey 리스너는 고유합니다. 따라서 같은 리스너의 다른 인스턴스가 이미 큐에 있고 아직 처리가 끝나지 않았다면, 해당 리스너는 큐에 추가되지 않습니다. 이렇게 하면 라이선스가 짧은 시간 안에 여러 번 저장되더라도 각 라이선스마다 제품 키가 하나만 획득됩니다.

어떤 경우에는 리스너를 고유하게 만드는 특정 "키"를 정의하거나, 리스너가 더 이상 고유 상태로 유지되지 않을 제한 시간을 지정하고 싶을 수 있습니다. 이를 위해 리스너 클래스에 uniqueId 및 uniqueFor 속성이나 메서드를 정의할 수 있습니다. 메서드는 이벤트 인스턴스를 받으므로, 이벤트 데이터를 사용해 반환값을 구성할 수 있습니다.

<?php

namespace App\Listeners;

use App\Events\LicenseSaved;
use Illuminate\Contracts\Queue\ShouldBeUnique;
use Illuminate\Contracts\Queue\ShouldQueue;

class AcquireProductKey implements ShouldQueue, ShouldBeUnique
{
    /**
     * The number of seconds after which the listener's unique lock will be released.
     *
     * @var int
     */
    public $uniqueFor = 3600;

    public function __invoke(LicenseSaved $event): void
    {
        // ...
    }

    /**
     * Get the unique ID for the listener.
     */
    public function uniqueId(LicenseSaved $event): string
    {
        return 'listener:'.$event->license->id;
    }
}

위 예제에서 AcquireProductKey 리스너는 라이선스 ID를 기준으로 고유합니다. 따라서 같은 라이선스에 대한 이 리스너의 새 디스패치는 기존 리스너 처리가 완료될 때까지 무시됩니다. 이렇게 하면 같은 라이선스에 대해 제품 키가 중복으로 획득되는 것을 방지합니다. 또한 기존 리스너가 한 시간 안에 처리되지 않으면 고유 락이 해제되고, 같은 고유 키를 가진 다른 리스너를 큐에 추가할 수 있습니다.

애플리케이션이 여러 웹 서버나 컨테이너에서 이벤트를 디스패치한다면, Laravel이 리스너의 고유 여부를 정확히 판단할 수 있도록 모든 서버가 동일한 중앙 캐시 서버와 통신하고 있는지 확인해야 합니다.

처리가 시작될 때까지만 리스너를 고유하게 유지하기

기본적으로 고유 리스너는 리스너 처리가 완료되거나 모든 재시도 시도가 실패한 뒤 "잠금 해제"됩니다. 하지만 리스너가 처리되기 직전에 즉시 잠금 해제되기를 원하는 상황도 있을 수 있습니다. 이를 위해 리스너는 ShouldBeUnique 계약 대신 ShouldBeUniqueUntilProcessing 계약을 구현해야 합니다.

<?php

namespace App\Listeners;

use App\Events\LicenseSaved;
use Illuminate\Contracts\Queue\ShouldBeUniqueUntilProcessing;
use Illuminate\Contracts\Queue\ShouldQueue;

class AcquireProductKey implements ShouldQueue, ShouldBeUniqueUntilProcessing
{
    // ...
}

고유 리스너 락

내부적으로 ShouldBeUnique 리스너가 디스패치되면 Laravel은 uniqueId 키로 락을 획득하려고 시도합니다. 락이 이미 잡혀 있다면 리스너는 디스패치되지 않습니다. 이 락은 리스너 처리가 완료되거나 모든 재시도 시도가 실패하면 해제됩니다. 기본적으로 Laravel은 이 락을 얻기 위해 기본 캐시 드라이버를 사용합니다. 하지만 락을 획득할 때 다른 드라이버를 사용하고 싶다면, 사용할 캐시 드라이버를 반환하는 uniqueVia 메서드를 정의할 수 있습니다.

<?php

namespace App\Listeners;

use App\Events\LicenseSaved;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Support\Facades\Cache;

class AcquireProductKey implements ShouldQueue, ShouldBeUnique
{
    // ...

    /**
     * Get the cache driver for the unique listener lock.
     */
    public function uniqueVia(LicenseSaved $event): Repository
    {
        return Cache::driver('redis');
    }
}

리스너의 동시 처리를 제한하기만 하면 된다면, 대신 WithoutOverlapping 작업 미들웨어를 사용하십시오.

실패한 작업 처리

큐 처리되는 이벤트 리스너가 실패하는 경우가 있습니다. 큐 리스너가 큐 워커에 정의된 최대 시도 횟수를 초과하면, 리스너의 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\Attributes\Tries;
use Illuminate\Queue\InteractsWithQueue;

#[Tries(5)]
class SendShipmentNotification implements ShouldQueue
{
    use InteractsWithQueue;

    // ...
}

리스너가 실패하기 전에 몇 번 시도될 수 있는지 정의하는 대신, 리스너를 더 이상 시도하지 않아야 하는 시점을 정의할 수도 있습니다. 이렇게 하면 주어진 시간 범위 안에서 리스너를 횟수 제한 없이 시도할 수 있습니다. 리스너를 더 이상 시도하지 않아야 하는 시점을 정의하려면 리스너 클래스에 retryUntil 메서드를 추가하십시오. 이 메서드는 DateTimeInterface 인스턴스를 반환해야 합니다.

use DateTimeInterface;

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

retryUntil과 tries가 모두 정의되어 있다면 Laravel은 retryUntil 메서드를 우선합니다.

큐 리스너 백오프 지정

예외가 발생한 리스너를 재시도하기 전에 Laravel이 몇 초를 기다려야 하는지 설정하고 싶다면, 리스너 클래스에 Backoff 속성을 사용할 수 있습니다.

<?php

namespace App\Listeners;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\Attributes\Backoff;

#[Backoff(3)]
class SendShipmentNotification implements ShouldQueue
{
    // ...
}

리스너의 백오프 시간을 결정하는 데 더 복잡한 로직이 필요하다면, 리스너 클래스에 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 메서드로 직접 해제된 경우가 아니라 처리되지 않은 예외가 지정된 횟수만큼 발생해 재시도가 일어난 경우에는 실패하도록 지정하고 싶을 수 있습니다. 이를 위해 리스너 클래스에 Tries 및 MaxExceptions 속성을 사용할 수 있습니다.

<?php

namespace App\Listeners;

use App\Events\OrderShipped;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\Attributes\MaxExceptions;
use Illuminate\Queue\Attributes\Tries;
use Illuminate\Queue\InteractsWithQueue;

#[Tries(25)]
#[MaxExceptions(3)]
class SendShipmentNotification implements ShouldQueue
{
    use InteractsWithQueue;

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

이 예제에서 리스너는 최대 25번까지 재시도됩니다. 하지만 리스너에서 처리되지 않은 예외가 세 번 발생하면 리스너는 실패합니다.

큐 리스너 타임아웃 지정

큐 리스너가 대략 얼마나 오래 걸릴지 알고 있는 경우가 많습니다. 이런 이유로 Laravel은 "타임아웃" 값을 지정할 수 있게 해 줍니다. 리스너가 타임아웃 값으로 지정된 초보다 더 오래 처리 중이라면, 해당 리스너를 처리하는 워커가 오류와 함께 종료됩니다. 리스너가 실행될 수 있는 최대 초 수는 리스너 클래스에 Timeout 속성을 사용해 정의할 수 있습니다.

<?php

namespace App\Listeners;

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

#[Timeout(120)]
class SendShipmentNotification implements ShouldQueue
{
    // ...
}

시간 초과 시 리스너를 실패한 것으로 표시하고 싶다면, 리스너 클래스에 FailOnTimeout 속성을 사용할 수 있습니다.

<?php

namespace App\Listeners;

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

#[FailOnTimeout]
class SendShipmentNotification implements ShouldQueue
{
    // ...
}

이벤트 디스패치하기 (Dispatching Events)

이벤트를 디스패치하려면 이벤트의 정적 dispatch 메서드를 호출하면 됩니다. 이 메서드는 Illuminate\Foundation\Events\Dispatchable 트레이트를 통해 이벤트에서 사용할 수 있습니다. 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]);

이벤트 구독자 (Event Subscribers)

이벤트 구독자 작성하기

이벤트 구독자는 구독자 클래스 자체 안에서 여러 이벤트를 구독할 수 있는 클래스입니다. 이를 통해 하나의 클래스 안에 여러 이벤트 핸들러를 정의할 수 있습니다. 구독자는 이벤트 디스패처 인스턴스를 받는 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);
    }
}

테스트 (Testing)

이벤트를 디스패치하는 코드를 테스트할 때는 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 dispatched once...
    Event::assertDispatchedOnce(OrderShipped::class);

    // 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 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 메서드에 전달할 수 있습니다.

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