Laravel 실제 코드 예제에서 이벤트 리스너를 사용하는 방법 및 시기

Laravel의 이벤트 시스템은 분리되고 완전히 복잡한 앱을 구축하기 위한 초석이기 때문에 웹 앱의 복잡한 데이터를 처리할 때 경이롭습니다. 이 가이드는 특히 2024년 이벤트 리스닝의 구현 및 활용에 대한 매우 자세한 사항을 설명하며 Laravel 11의 가장 광범위한 콘텐츠와 자세한 코드 예제 이벤트 리스너를 통해 새로운 관점을 제공합니다.

*(A) 이벤트 및 청취자의 핵심 이해
*
이제 분석해 보겠습니다. Laravel의 이벤트는 앱 내에서 특정 발생을 나타냅니다. 리스너는 이러한 모든 앱 이벤트에 응답하는 클래스입니다. 이 패턴은 계속해서 우려 사항의 분리를 촉진하고 더 모듈화되고 테스트 가능한 코드를 허용해 왔습니다.

*(B) 이벤트 만들기
*
더 잘 설명하기 위해 Artisan 명령을 사용할 복잡한 이벤트를 만드는 것부터 시작하겠습니다. 여러분도 그렇게 하시기를 적극 권장합니다

php artisan make:event OrderPlaced

이 명령은 app/Events 디렉터리에 새 이벤트 클래스를 생성합니다. 좀 더 자세한 이벤트 클래스를 살펴보겠습니다

`네임스페이스 AppEvents;

AppModelsOrder를 사용하세요.
AppModelsUser를 사용하세요.
IlluminateFoundationEventsDispatchable을 사용하세요.
IlluminateQueueSerializesModels를 사용하세요.
IlluminateBroadcastingInteractsWithSockets를 사용하세요.
IlluminateBroadcastingPrivateChannel을 사용하세요.
IlluminateContractsBroadcastingShouldBroadcast를 사용하세요.

OrderPlaced 클래스는 ShouldBroadcast를 구현합니다
{
Dispatchable, InteractsWithSockets, SerializesModels를 사용하세요.

public $order;
public $user;

/**
 * Create a new event instance.
 *
 * @param  \App\Models\Order  $order
 * @param  \App\Models\User  $user
 * @return void
 */
public function __construct(Order $order, User $user)
{
    $this->order = $order;
    $this->user = $user;
}

/**
 * Get the channels the event should broadcast on.
 *
 * @return \Illuminate\Broadcasting\Channel|array
 */
public function broadcastOn()
{
    return new PrivateChannel('orders.'.$this->user->id);
}

/**
 * The event's broadcast name.
 *
 * @return string
 */
public function broadcastAs()
{
    return 'order.placed';
}

}`

이 확장된 예에서는 Order 및 User 모델을 모두 포함했습니다. SerializesModels 특성은 이벤트가 대기 중인 리스너에게 전달될 때 Eloquent 모델이 올바르게 직렬화 및 역직렬화되도록 보장해 왔습니다. 또한 ShouldBroadcast 인터페이스를 구현하고 broadcastOn 및 broadcastAs 메소드를 정의하여 이 이벤트가 실시간 업데이트를 위해 웹소켓에 브로드캐스팅될 수 있도록 했습니다.

*여러 청취자 생성
*
단일 이벤트의 경우 여러 리스너가 필요할 수 있습니다. 예제를 더욱 확장하기 위해 OrderPlaced 이벤트에 대한 두 개의 리스너를 생성해 보겠습니다. 나는 단지 여러분이 모든 것의 요점을 확실히 이해하기를 바랍니다. 이에 대해서는 아래 코드 예시를 참조하세요

php artisan make:listener SendOrderConfirmation --event=OrderPlaced
php artisan make:listener UpdateInventory --event=OrderPlaced

이제 이 명령줄을 통해 app/Listeners 디렉터리에 몇 가지 새로운 리스너 클래스가 생성된다는 점을 이해하셨을 것입니다. 이제 문제는 아래에서 SendOrderConfirmation 리스너를 검사하고 어떻게 진행되는지 살펴보겠습니다

`네임스페이스 AppListener;

AppEventsOrderPlaced를 사용하세요.
AppMailOrderConfirmation을 사용하세요.
IlluminateContractsQueueShouldQueue를 사용하세요.
IlluminateQueueInteractsWithQueue를 사용하세요.
IlluminateSupportFacadesMail을 사용하세요.
IlluminateSupportFacadesLog를 사용하세요.

SendOrderConfirmation 클래스는 ShouldQueue를 구현합니다
{
InteractsWithQueue를 사용하세요.

/**
 * The number of times the job may be attempted.
 *
 * @var int
 */
public $tries = 3;

/**
 * Handle the event.
 *
 * @param  \App\Events\OrderPlaced  $event
 * @return void
 */
public function handle(OrderPlaced $event)
{
    $order = $event->order;
    $user = $event->user;

    try {
        Mail::to($user->email)->send(new OrderConfirmation($order));
        Log::info('Order confirmation email sent', ['order_id' => $order->id, 'user_id' => $user->id]);
    } catch (\Exception $e) {
        Log::error('Failed to send order confirmation email', ['order_id' => $order->id, 'user_id' => $user->id, 'error' => $e->getMessage()]);
        $this->fail($e);
    }
}

/**
 * Handle a job failure.
 *
 * @param  \App\Events\OrderPlaced  $event
 * @param  \Throwable  $exception
 * @return void
 */
public function failed(OrderPlaced $event, $exception)
{
    Log::error('Order confirmation listener failed', ['order_id' => $event->order->id, 'user_id' => $event->user->id, 'error' => $exception->getMessage()]);
}

}`

이 리스너는 ShouldQueue 인터페이스를 구현하여 대기열에 추가되어야 함을 나타냅니다. 오류 처리, 로깅을 추가하고 실패를 처리하기 위한 실패한 메서드를 정의했습니다. $tries 속성은 실패 시 여러 번의 시도를 허용하도록 설정됩니다.
이제 UpdateInventory 리스너를 살펴보겠습니다

`네임스페이스 AppListener;

AppEventsOrderPlaced를 사용하세요.
IlluminateContractsQueueShouldQueue를 사용하세요.
IlluminateQueueInteractsWithQueue를 사용하세요.
IlluminateSupportFacadesDB를 사용하세요.
IlluminateSupportFacadesLog를 사용하세요.

UpdateInventory 클래스는 ShouldQueue를 구현합니다
{
InteractsWithQueue를 사용하세요.

/**
 * Handle the event.
 *
 * @param  \App\Events\OrderPlaced  $event
 * @return void
 */
public function handle(OrderPlaced $event)
{
    $order = $event->order;

    DB::transaction(function () use ($order) {
        foreach ($order->items as $item) {
            $product = $item->product;

            if ($product->stock < $item->quantity) {
                throw new \Exception("Insufficient stock for product: {$product->id}");
            }

            $product->decrement('stock', $item->quantity);
            Log::info("Inventory updated", ['product_id' => $product->id, 'quantity' => $item->quantity]);
        }
    });
}

/**
 * Handle a job failure.
 *
 * @param  \App\Events\OrderPlaced  $event
 * @param  \Throwable  $exception
 * @return void
 */
public function failed(OrderPlaced $event, $exception)
{
    Log::error('Failed to update inventory', ['order_id' => $event->order->id, 'error' => $exception->getMessage()]);
}

}`

이제 이 리스너는 주문 항목 등을 기반으로 인벤토리를 업그레이드하는 등의 이유로 존재한다는 점을 이해하실 것입니다. 데이터 일관성을 보장하기 위해 데이터베이스 트랜잭션에 인벤토리 업데이트를 래핑했습니다. 또한 부정적인 재고를 방지하기 위해 오류 검사를 추가하고 성공적인 업데이트 및 실패에 대한 로깅을 포함했습니다.

*이벤트 및 리스너 등록
*
EventServiceProvider

에 이러한 이벤트와 리스너를 등록하겠습니다.

`AppEventsOrderPlaced 사용;
AppListenersSendOrderConfirmation을 사용하세요.
AppListenersUpdateInventory를 사용하세요.

class EventServiceProvider extends ServiceProvider
{
/**
* The event listener mappings for the application.
*
* @var array
*/
protected $listen = [
OrderPlaced::class => [
SendOrderConfirmation::class,
UpdateInventory::class,
],
];

/**
 * Register any events for your application.
 *
 * @return void
 */
public function boot()
{
    parent::boot();

    //
}

}`

Dispatching Events:

We can dispatch the event from a controller or service class

`use App\Events\OrderPlaced;
use App\Models\Order;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\DB;

class OrderController extends Controller
{
/**
* Place a new order.
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\JsonResponse
*/
public function placeOrder(Request $request)
{
$user = auth()->user();

    DB::transaction(function () use ($request, $user) {
        $order = Order::create($request->all());
        $order->user()->associate($user);
        $order->save();

        event(new OrderPlaced($order, $user));
    });

    return response()->json(['message' => 'Order placed successfully', 'order_id' => $order->id]);
}

}`

In this example, we have wrapped the order creation and event dispatching in a database transaction to ensure that both occur successfully or not at all.

위 내용은 Laravel 실제 코드 예제에서 이벤트 리스너를 사용하는 방법 및 시기의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!