브로드캐스팅 (Broadcasting)

• 소개
• 빠른 시작
• 서버측 설치
  • 리버브
  • 푸셔 채널
  • Ably
• 클라이언트측 설치
  • 리버브
  • 푸셔 채널
  • Ably
• 개념 개요
  • 예제 애플리케이션 사용
• 브로드캐스트 이벤트 정의
  • 브로드캐스트 이름
  • 브로드캐스트 데이터
  • 브로드캐스트 큐
  • 브로드캐스트 조건
  • 브로드캐스트와 데이터베이스 트랜잭션
• 채널 인가
  • 인가 콜백 정의
  • 채널 클래스 정의
• 이벤트 브로드캐스팅
  • 다른 사람에게만
  • 연결 사용자 지정
  • 익명 이벤트
  • 브로드캐스트 복구
• 브로드캐스트 수신
  • 이벤트 수신
  • 채널 나가기
  • 네임스페이스
  • React 또는 Vue 사용
• 프레즌스 채널
  • 프레즌스 채널 인가
  • 프레즌스 채널 참여
  • 프레즌스 채널로 브로드캐스팅
• 모델 브로드캐스팅
  • 모델 브로드캐스팅 규칙
  • 모델 브로드캐스트 수신
• 클라이언트 이벤트
• 알림

소개 (Introduction)

많은 최신 웹 애플리케이션에서 WebSocket은 실시간으로 업데이트되는 사용자 인터페이스를 구현하는 데 사용됩니다. 서버에서 일부 데이터가 업데이트되면 일반적으로 클라이언트에서 처리할 메시지가 WebSocket 연결을 통해 전송됩니다. WebSocket은 UI에 반영되어야 하는 데이터 변경 사항에 대해 애플리케이션 서버를 지속적으로 폴링하는 보다 효율적인 대안을 제공합니다.

예를 들어, 애플리케이션이 사용자의 데이터를 CSV 파일로 내보내고 이메일로 보낼 수 있다고 가정해 보세요. 그러나 이 CSV 파일을 생성하는 데는 몇 분이 걸리므로 큐에 있는 작업 내에서 CSV를 생성하여 메일로 보내도록 선택하세요. CSV가 생성되어 사용자에게 메일로 전송되면 애플리케이션의 JavaScript에서 수신한 디스패치 및 App\Events\UserDataExported 이벤트에 대한 이벤트 브로드캐스팅을 사용할 수 있습니다. 이벤트가 수신되면 사용자가 페이지를 새로 고칠 필요 없이 CSV가 이메일로 전송되었다는 메시지를 사용자에게 표시할 수 있습니다.

이러한 유형의 기능을 구축하는 데 도움을 주기 위해 Laravel을 사용하면 WebSocket 연결을 통해 서버측 Laravel 이벤트를 쉽게 "브로드캐스트"할 수 있습니다. Laravel 이벤트를 브로드캐스트하면 서버 측 Laravel 애플리케이션과 클라이언트 측 JavaScript 애플리케이션 간에 동일한 이벤트 이름과 데이터를 공유할 수 있습니다.

브로드캐스팅의 핵심 개념은 간단합니다. 클라이언트는 프론트엔드의 명명된 채널에 연결하고, Laravel 애플리케이션은 백엔드의 이러한 채널에 이벤트를 브로드캐스트합니다. 이러한 이벤트에는 프론트엔드에서 사용할 수 있도록 하려는 추가 데이터가 포함될 수 있습니다.

지원되는 드라이버

기본적으로 Laravel에는 Laravel 리버브, 푸셔 채널 및 Ably 중에서 선택할 수 있는 세 가지 서버 측 브로드캐스트 드라이버가 포함되어 있습니다.

[!NOTE] 이벤트 브로드캐스팅을 시작하기 전에 이벤트 및 리스너에 대한 Laravel 설명서를 읽어보세요.

빠른 시작 (Quickstart)

기본적으로 새로운 Laravel 애플리케이션에서는 브로드캐스팅이 활성화되지 않습니다. install:broadcasting Artisan 명령을 사용하여 브로드캐스팅을 활성화할 수 있습니다:

php artisan install:broadcasting

install:broadcasting 명령은 사용하려는 이벤트 브로드캐스팅 서비스를 묻는 메시지를 표시합니다. 또한 애플리케이션의 브로드캐스트 인증 라우트 및 콜백을 등록할 수 있는 config/broadcasting.php 구성 파일과 routes/channels.php 파일을 생성합니다.

Laravel는 기본적으로 여러 브로드캐스트 드라이버를 지원합니다. Laravel 리버브, 푸셔 채널, Ably 및 로컬 개발을 위한 log 드라이버 디버깅. 또한 테스트 시 브로드캐스팅을 비활성화할 수 있는 null 드라이버가 포함되어 있습니다. config/broadcasting.php 구성 파일에는 이러한 각 드라이버에 대한 구성 예가 포함되어 있습니다.

애플리케이션의 모든 이벤트 브로드캐스팅 구성은 config/broadcasting.php 구성 파일에 저장됩니다. 이 파일이 애플리케이션에 존재하지 않더라도 걱정하지 마세요. install:broadcasting Artisan 명령을 실행할 때 생성됩니다.

다음 단계

이벤트 브로드캐스팅을 활성화하면 브로드캐스트 이벤트 정의 및 이벤트 수신에 대해 자세히 알아볼 수 있습니다. Laravel의 React 또는 Vue 스타터 키트를 사용하는 경우 Echo의 useEcho 후크를 사용하여 이벤트를 수신할 수 있습니다.

[!NOTE] 이벤트를 브로드캐스트하기 전에 먼저 큐 워커를 구성하고 실행해야 합니다. 모든 이벤트 브로드캐스팅은 큐 작업을 통해 수행되므로 애플리케이션의 응답 시간은 브로드캐스트되는 이벤트로 인해 심각한 영향을 받지 않습니다.

서버 측 설치 (Server Side Installation)

Laravel의 이벤트 브로드캐스팅 사용을 시작하려면 Laravel 애플리케이션 내에서 일부 구성을 수행하고 몇 가지 패키지를 설치해야 합니다.

이벤트 브로드캐스팅은 Laravel Echo(JavaScript 라이브러리)가 브라우저 클라이언트 내에서 수신할 수 있도록 Laravel 이벤트를 브로드캐스트하는 서버 측 브로드캐스트 드라이버에 의해 수행됩니다. 걱정하지 마세요. 설치 과정의 각 부분을 단계별로 안내해 드리겠습니다.

리버브

Reverb를 이벤트 브로드캐스터로 사용하는 동안 Laravel의 브로드캐스팅 기능에 대한 지원을 빠르게 활성화하려면 --reverb 옵션과 함께 install:broadcasting Artisan 명령을 호출하십시오. 이 Artisan 명령은 Reverb의 필수 Composer 및 NPM 패키지를 설치하고 애플리케이션의 .env 파일을 적절한 변수로 업데이트합니다.

php artisan install:broadcasting --reverb

수동 설치

install:broadcasting 명령을 실행하면 Laravel Reverb를 설치하라는 메시지가 표시됩니다. 물론 Composer 패키지 관리자를 사용하여 Reverb를 수동으로 설치할 수도 있습니다.

composer require laravel/reverb

패키지가 설치되면 Reverb의 설치 명령을 실행하여 구성을 게시하고 Reverb의 필수 환경 변수를 추가하고 애플리케이션에서 이벤트 브로드캐스팅을 활성화할 수 있습니다.

php artisan reverb:install

Reverb 문서에서 자세한 Reverb 설치 및 사용 지침을 확인할 수 있습니다.

푸셔 채널

Pusher를 이벤트 브로드캐스터로 사용하는 동안 Laravel의 브로드캐스팅 기능에 대한 지원을 빠르게 활성화하려면 --pusher 옵션과 함께 install:broadcasting Artisan 명령을 호출하세요. 이 Artisan 명령은 Pusher 자격 증명을 묻는 메시지를 표시하고, Pusher PHP 및 JavaScript SDK를 설치하고, 애플리케이션의 .env 파일을 적절한 변수로 업데이트합니다.

php artisan install:broadcasting --pusher

수동 설치

푸셔 지원을 수동으로 설치하려면 Composer 패키지 관리자를 사용하여 푸셔 채널 PHP SDK를 설치해야 합니다.

composer require pusher/pusher-php-server

다음으로 config/broadcasting.php 구성 파일에서 푸셔 채널 자격 증명을 구성해야 합니다. 푸셔 채널 구성 예시가 이 파일에 이미 포함되어 있어 키, 비밀 및 애플리케이션 ID를 빠르게 지정할 수 있습니다. 일반적으로 애플리케이션의 .env 파일에서 푸셔 채널 자격 증명을 구성해야 합니다.

PUSHER_APP_ID="your-pusher-app-id"
PUSHER_APP_KEY="your-pusher-key"
PUSHER_APP_SECRET="your-pusher-secret"
PUSHER_HOST=
PUSHER_PORT=443
PUSHER_SCHEME="https"
PUSHER_APP_CLUSTER="mt1"

config/broadcasting.php 파일의 pusher 구성을 사용하면 클러스터와 같은 채널에서 지원되는 추가 options를 지정할 수도 있습니다.

그런 다음 애플리케이션의 .env 파일에서 BROADCAST_CONNECTION 환경 변수를 pusher로 설정합니다.

BROADCAST_CONNECTION=pusher

마지막으로 클라이언트 측에서 브로드캐스트 이벤트를 수신하는 Laravel Echo를 설치하고 구성할 준비가 되었습니다.

Ably

[!NOTE] 아래 문서에서는 "푸셔 호환성" 모드에서 Ably를 사용하는 방법을 설명합니다. 그러나 Ably 팀은 Ably가 제공하는 고유한 기능을 활용할 수 있는 브로드캐스터와 Echo 클라이언트를 권장하고 유지 관리합니다. Ably에서 유지 관리하는 드라이버 사용에 대한 자세한 내용은 Ably의 Laravel 브로드캐스터 설명서를 참조하세요.

Ably를 이벤트 브로드캐스터로 사용하는 동안 Laravel의 브로드캐스팅 기능에 대한 지원을 빠르게 활성화하려면 --ably 옵션과 함께 install:broadcasting Artisan 명령을 호출하세요. 이 Artisan 명령은 Ably 자격 증명을 묻는 메시지를 표시하고, Ably PHP 및 JavaScript SDK를 설치하고, 애플리케이션의 .env 파일을 적절한 변수로 업데이트합니다.

php artisan install:broadcasting --ably

계속하기 전에 Ably 애플리케이션 설정에서 푸셔 프로토콜 지원을 활성화해야 합니다. Ably 애플리케이션 설정 대시보드의 "프로토콜 어댑터 설정" 부분에서 이 기능을 활성화할 수 있습니다.

수동 설치

Ably 지원을 수동으로 설치하려면 Composer 패키지 관리자를 사용하여 Ably PHP SDK를 설치해야 합니다.

composer require ably/ably-php

다음으로 config/broadcasting.php 구성 파일에서 Ably 자격 증명을 구성해야 합니다. 이 파일에는 Ably 구성 예시가 이미 포함되어 있어 키를 빠르게 지정할 수 있습니다. 일반적으로 이 값은 ABLY_KEY 환경 변수를 통해 설정되어야 합니다.

ABLY_KEY=your-ably-key

그런 다음 애플리케이션의 .env 파일에서 BROADCAST_CONNECTION 환경 변수를 ably로 설정합니다.

BROADCAST_CONNECTION=ably

마지막으로 클라이언트 측에서 브로드캐스트 이벤트를 수신하는 Laravel Echo를 설치하고 구성할 준비가 되었습니다.

클라이언트 측 설치 (Client Side Installation)

리버브

Laravel Echo는 채널을 구독하고 서버 측 브로드캐스트 드라이버에서 브로드캐스트하는 이벤트를 수신하기 쉽게 해주는 JavaScript 라이브러리입니다.

install:broadcasting Artisan 명령을 통해 Laravel Reverb를 설치하면 Reverb와 Echo의 스캐폴딩 및 구성이 자동으로 애플리케이션에 주입됩니다. 그러나 Laravel Echo를 수동으로 구성하려면 아래 지침을 따르면 됩니다.

수동 설치

애플리케이션의 프론트엔드에 대해 Laravel Echo를 수동으로 구성하려면 먼저 pusher-js 패키지를 설치하십시오. Reverb는 WebSocket 구독, 채널 및 메시지에 대해 Pusher 프로토콜을 사용하기 때문입니다.

npm install --save-dev laravel-echo pusher-js

Echo가 설치되면 애플리케이션의 JavaScript에 새로운 Echo 인스턴스를 생성할 준비가 된 것입니다. 이를 수행하기 가장 좋은 위치는 Laravel 프레임워크에 포함된 resources/js/bootstrap.js 파일의 하단입니다.

import Echo from 'laravel-echo';

import Pusher from 'pusher-js';
window.Pusher = Pusher;

window.Echo = new Echo({
    broadcaster: 'reverb',
    key: import.meta.env.VITE_REVERB_APP_KEY,
    wsHost: import.meta.env.VITE_REVERB_HOST,
    wsPort: import.meta.env.VITE_REVERB_PORT ?? 80,
    wssPort: import.meta.env.VITE_REVERB_PORT ?? 443,
    forceTLS: (import.meta.env.VITE_REVERB_SCHEME ?? 'https') === 'https',
    enabledTransports: ['ws', 'wss'],
});

import { configureEcho } from "@laravel/echo-react";

configureEcho({
    broadcaster: "reverb",
    // key: import.meta.env.VITE_REVERB_APP_KEY,
    // wsHost: import.meta.env.VITE_REVERB_HOST,
    // wsPort: import.meta.env.VITE_REVERB_PORT,
    // wssPort: import.meta.env.VITE_REVERB_PORT,
    // forceTLS: (import.meta.env.VITE_REVERB_SCHEME ?? 'https') === 'https',
    // enabledTransports: ['ws', 'wss'],
});

import { configureEcho } from "@laravel/echo-vue";

configureEcho({
    broadcaster: "reverb",
    // key: import.meta.env.VITE_REVERB_APP_KEY,
    // wsHost: import.meta.env.VITE_REVERB_HOST,
    // wsPort: import.meta.env.VITE_REVERB_PORT,
    // wssPort: import.meta.env.VITE_REVERB_PORT,
    // forceTLS: (import.meta.env.VITE_REVERB_SCHEME ?? 'https') === 'https',
    // enabledTransports: ['ws', 'wss'],
});

다음으로 애플리케이션 자산을 컴파일해야 합니다.

npm run build

[!WARNING] Laravel Echo reverb 브로드캐스터에는 laravel-echo v1.16.0+가 필요합니다.

푸셔 채널

Laravel Echo는 채널을 구독하고 서버 측 브로드캐스트 드라이버에서 브로드캐스트하는 이벤트를 수신하기 쉽게 해주는 JavaScript 라이브러리입니다.

install:broadcasting --pusher Artisan 명령을 통해 브로드캐스팅 지원을 설치하면 Pusher와 Echo의 스캐폴딩 및 구성이 자동으로 애플리케이션에 주입됩니다. 그러나 Laravel Echo를 수동으로 구성하려면 아래 지침을 따르면 됩니다.

수동 설치

애플리케이션의 프론트엔드에 대해 Laravel Echo를 수동으로 구성하려면 먼저 WebSocket 구독, 채널 및 메시지에 대해 Pusher 프로토콜을 활용하는 laravel-echo 및 pusher-js 패키지를 설치하십시오.

npm install --save-dev laravel-echo pusher-js

Echo가 설치되면 애플리케이션의 resources/js/bootstrap.js 파일에 새로운 Echo 인스턴스를 생성할 준비가 된 것입니다.

import Echo from 'laravel-echo';

import Pusher from 'pusher-js';
window.Pusher = Pusher;

window.Echo = new Echo({
    broadcaster: 'pusher',
    key: import.meta.env.VITE_PUSHER_APP_KEY,
    cluster: import.meta.env.VITE_PUSHER_APP_CLUSTER,
    forceTLS: true
});

import { configureEcho } from "@laravel/echo-react";

configureEcho({
    broadcaster: "pusher",
    // key: import.meta.env.VITE_PUSHER_APP_KEY,
    // cluster: import.meta.env.VITE_PUSHER_APP_CLUSTER,
    // forceTLS: true,
    // wsHost: import.meta.env.VITE_PUSHER_HOST,
    // wsPort: import.meta.env.VITE_PUSHER_PORT,
    // wssPort: import.meta.env.VITE_PUSHER_PORT,
    // enabledTransports: ["ws", "wss"],
});

import { configureEcho } from "@laravel/echo-vue";

configureEcho({
    broadcaster: "pusher",
    // key: import.meta.env.VITE_PUSHER_APP_KEY,
    // cluster: import.meta.env.VITE_PUSHER_APP_CLUSTER,
    // forceTLS: true,
    // wsHost: import.meta.env.VITE_PUSHER_HOST,
    // wsPort: import.meta.env.VITE_PUSHER_PORT,
    // wssPort: import.meta.env.VITE_PUSHER_PORT,
    // enabledTransports: ["ws", "wss"],
});

다음으로, 애플리케이션의 .env 파일에서 Pusher 환경 변수에 대한 적절한 값을 정의해야 합니다. 이러한 변수가 .env 파일에 아직 없으면 추가해야 합니다.

PUSHER_APP_ID="your-pusher-app-id"
PUSHER_APP_KEY="your-pusher-key"
PUSHER_APP_SECRET="your-pusher-secret"
PUSHER_HOST=
PUSHER_PORT=443
PUSHER_SCHEME="https"
PUSHER_APP_CLUSTER="mt1"

VITE_APP_NAME="${APP_NAME}"
VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
VITE_PUSHER_HOST="${PUSHER_HOST}"
VITE_PUSHER_PORT="${PUSHER_PORT}"
VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

애플리케이션의 필요에 따라 Echo 구성을 조정한 후에는 애플리케이션의 자산을 컴파일할 수 있습니다.

npm run build

[!NOTE] 애플리케이션의 JavaScript 자산 컴파일에 대한 자세한 내용은 Vite 문서를 참조하세요.

기존 클라이언트 인스턴스 사용

Echo가 활용하려는 사전 구성된 푸셔 채널 클라이언트 인스턴스가 이미 있는 경우 client 구성 옵션을 통해 이를 Echo에 전달할 수 있습니다.

import Echo from 'laravel-echo';
import Pusher from 'pusher-js';

const options = {
    broadcaster: 'pusher',
    key: import.meta.env.VITE_PUSHER_APP_KEY
}

window.Echo = new Echo({
    ...options,
    client: new Pusher(options.key, options)
});

Ably

[!NOTE] 아래 문서에서는 "푸셔 호환성" 모드에서 Ably를 사용하는 방법을 설명합니다. 그러나 Ably 팀은 Ably가 제공하는 고유한 기능을 활용할 수 있는 브로드캐스터와 Echo 클라이언트를 권장하고 유지 관리합니다. Ably에서 유지 관리하는 드라이버 사용에 대한 자세한 내용은 Ably의 Laravel 브로드캐스터 설명서를 참조하세요.

Laravel Echo는 채널을 구독하고 서버 측 브로드캐스트 드라이버에서 브로드캐스트하는 이벤트를 수신하기 쉽게 해주는 JavaScript 라이브러리입니다.

install:broadcasting --ably Artisan 명령을 통해 브로드캐스팅 지원을 설치하면 Ably 및 Echo의 스캐폴딩 및 구성이 자동으로 애플리케이션에 주입됩니다. 그러나 Laravel Echo를 수동으로 구성하려면 아래 지침을 따르면 됩니다.

수동 설치

애플리케이션의 프론트엔드에 대해 Laravel Echo를 수동으로 구성하려면 먼저 WebSocket 구독, 채널 및 메시지에 대해 Pusher 프로토콜을 활용하는 laravel-echo 및 pusher-js 패키지를 설치하십시오.

npm install --save-dev laravel-echo pusher-js

계속하기 전에 Ably 애플리케이션 설정에서 푸셔 프로토콜 지원을 활성화해야 합니다. Ably 애플리케이션 설정 대시보드의 "프로토콜 어댑터 설정" 부분에서 이 기능을 활성화할 수 있습니다.

Echo가 설치되면 애플리케이션의 resources/js/bootstrap.js 파일에 새로운 Echo 인스턴스를 생성할 준비가 된 것입니다.

import Echo from 'laravel-echo';

import Pusher from 'pusher-js';
window.Pusher = Pusher;

window.Echo = new Echo({
    broadcaster: 'pusher',
    key: import.meta.env.VITE_ABLY_PUBLIC_KEY,
    wsHost: 'realtime-pusher.ably.io',
    wsPort: 443,
    disableStats: true,
    encrypted: true,
});

import { configureEcho } from "@laravel/echo-react";

configureEcho({
    broadcaster: "ably",
    // key: import.meta.env.VITE_ABLY_PUBLIC_KEY,
    // wsHost: "realtime-pusher.ably.io",
    // wsPort: 443,
    // disableStats: true,
    // encrypted: true,
});

import { configureEcho } from "@laravel/echo-vue";

configureEcho({
    broadcaster: "ably",
    // key: import.meta.env.VITE_ABLY_PUBLIC_KEY,
    // wsHost: "realtime-pusher.ably.io",
    // wsPort: 443,
    // disableStats: true,
    // encrypted: true,
});

Ably Echo 구성이 VITE_ABLY_PUBLIC_KEY 환경 변수를 참조하는 것을 확인하셨을 것입니다. 이 변수의 값은 Ably 공개 키여야 합니다. 공개 키는 : 문자 앞에 나오는 Ably 키 부분입니다.

필요에 따라 Echo 구성을 조정한 후에는 애플리케이션 자산을 컴파일할 수 있습니다.

npm run dev

[!NOTE] 애플리케이션의 JavaScript 자산 컴파일에 대한 자세한 내용은 Vite 문서를 참조하세요.

개념 개요 (Concept Overview)

Laravel의 이벤트 브로드캐스팅을 사용하면 WebSocket에 대한 드라이버 기반 접근 방식을 사용하여 서버 측 Laravel 이벤트를 클라이언트 측 JavaScript 애플리케이션에 브로드캐스트할 수 있습니다. 현재 Laravel는 Laravel 리버브, 푸셔 채널 및 Ably 드라이버와 함께 제공됩니다. 이벤트는 Laravel Echo JavaScript 패키지를 사용하여 클라이언트 측에서 쉽게 사용할 수 있습니다.

이벤트는 공개 또는 비공개로 지정될 수 있는 "채널"을 통해 브로드캐스트됩니다. 애플리케이션을 방문하는 모든 방문자는 인증이나 인가 없이 공개 채널을 구독할 수 있습니다. 그러나 비공개 채널을 구독하려면 사용자가 해당 채널을 수신할 수 있도록 인증 및 인가를 받아야 합니다.

예제 애플리케이션 사용

이벤트 브로드캐스팅의 각 구성요소를 살펴보기 전에 전자상거래 상점을 예로 들어 높은 수준의 개요를 살펴보겠습니다.

우리 애플리케이션에는 사용자가 주문의 배송 상태를 확인할 수 있는 페이지가 있다고 가정해 보겠습니다. 또한 애플리케이션에서 디스패치 상태 업데이트를 처리할 때 OrderShipmentStatusUpdated 이벤트가 실행된다고 가정해 보겠습니다.

use App\Events\OrderShipmentStatusUpdated;

OrderShipmentStatusUpdated::dispatch($order);

ShouldBroadcast 인터페이스

사용자가 주문 중 하나를 볼 때 상태 업데이트를 확인하기 위해 페이지를 새로 고칠 필요가 없습니다. 대신, 업데이트가 생성될 때 애플리케이션에 업데이트를 브로드캐스트하려고 합니다. 따라서 OrderShipmentStatusUpdated 이벤트를 ShouldBroadcast 인터페이스로 표시해야 합니다. 이는 Laravel가 실행될 때 이벤트를 브로드캐스트하도록 지시합니다.

<?php

namespace App\Events;

use App\Models\Order;
use Illuminate\Broadcasting\Channel;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Broadcasting\PresenceChannel;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
use Illuminate\Queue\SerializesModels;

class OrderShipmentStatusUpdated implements ShouldBroadcast
{
    /**
     * The order instance.
     *
     * @var \App\Models\Order
     */
    public $order;
}

ShouldBroadcast 인터페이스는 이벤트에 broadcastOn 메서드를 정의할 것을 요구합니다. 이 메서드는 이벤트가 브로드캐스트해야 하는 채널을 반환하는 역할을 합니다. 이 메서드의 빈 스텁은 생성된 이벤트 클래스에 이미 정의되어 있으므로 세부 내용만 채우면 됩니다. 주문 생성자만 상태 업데이트를 볼 수 있도록 하기 위해, 주문과 연결된 비공개 채널에서 이벤트를 브로드캐스트합니다.

use Illuminate\Broadcasting\Channel;
use Illuminate\Broadcasting\PrivateChannel;

/**
 * Get the channel the event should broadcast on.
 */
public function broadcastOn(): Channel
{
    return new PrivateChannel('orders.'.$this->order->id);
}

이벤트를 여러 채널로 브로드캐스트하려면 대신 array를 반환하면 됩니다.

use Illuminate\Broadcasting\PrivateChannel;

/**
 * Get the channels the event should broadcast on.
 *
 * @return array<int, \Illuminate\Broadcasting\Channel>
 */
public function broadcastOn(): array
{
    return [
        new PrivateChannel('orders.'.$this->order->id),
        // ...
    ];
}

채널 인가

사용자는 비공개 채널을 수신하기 위해 인가를 받아야 합니다. 애플리케이션의 routes/channels.php 파일에서 채널 인가 규칙을 정의할 수 있습니다. 이 예에서는 비공개 orders.1 채널에서 수신을 시도하는 모든 사용자가 실제로 주문을 생성한 사람인지 확인해야 합니다.

use App\Models\Order;
use App\Models\User;

Broadcast::channel('orders.{orderId}', function (User $user, int $orderId) {
    return $user->id === Order::findOrNew($orderId)->user_id;
});

channel 메서드는 채널 이름과 사용자가 채널에서 수신할 수 있는 권한이 있는지 여부를 나타내는 true 또는 false를 반환하는 콜백이라는 두 가지 인수를 허용합니다.

모든 인가 콜백은 현재 인증된 사용자를 첫 번째 인수로 받고 추가 와일드카드 매개변수를 후속 인수로 받습니다. 이 예에서는 {orderId} 자리 표시자를 사용하여 채널 이름의 "ID" 부분이 와일드카드임을 나타냅니다.

이벤트 브로드캐스트 수신

다음으로 남은 것은 JavaScript 애플리케이션에서 이벤트를 수신하는 것입니다. Laravel Echo를 사용하여 이 작업을 수행할 수 있습니다. Laravel Echo에 내장된 React 및 Vue 후크를 사용하면 쉽게 시작할 수 있으며 기본적으로 이벤트의 모든 공개 속성은 브로드캐스트 이벤트에 포함됩니다.

import { useEcho } from "@laravel/echo-react";

useEcho(
    `orders.${orderId}`,
    "OrderShipmentStatusUpdated",
    (e) => {
        console.log(e.order);
    },
);

<script setup lang="ts">
import { useEcho } from "@laravel/echo-vue";

useEcho(
    `orders.${orderId}`,
    "OrderShipmentStatusUpdated",
    (e) => {
        console.log(e.order);
    },
);
</script>

브로드캐스트 이벤트 정의 (Defining Broadcast Events)

지정된 이벤트가 브로드캐스트되어야 함을 Laravel에 알리려면 이벤트 클래스에 Illuminate\Contracts\Broadcasting\ShouldBroadcast 인터페이스를 구현해야 합니다. 이 인터페이스는 이미 프레임워크에서 생성된 모든 이벤트 클래스로 가져왔으므로 이벤트에 쉽게 추가할 수 있습니다.

ShouldBroadcast 인터페이스를 사용하려면 broadcastOn라는 단일 메서드를 구현해야 합니다. broadcastOn 메서드는 이벤트가 브로드캐스트해야 하는 채널 또는 채널 배열을 반환해야 합니다. 채널은 Channel, PrivateChannel 또는 PresenceChannel의 인스턴스여야 합니다. Channel 인스턴스는 모든 사용자가 구독할 수 있는 공개 채널을 나타내는 반면, PrivateChannels 및 PresenceChannels는 채널 인가이 필요한 비공개 채널을 나타냅니다.

<?php

namespace App\Events;

use App\Models\User;
use Illuminate\Broadcasting\Channel;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Broadcasting\PresenceChannel;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
use Illuminate\Queue\SerializesModels;

class ServerCreated implements ShouldBroadcast
{
    use SerializesModels;

    /**
     * Create a new event instance.
     */
    public function __construct(
        public User $user,
    ) {}

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

ShouldBroadcast 인터페이스를 구현한 후에는 평소처럼 이벤트를 실행하기만 하면 됩니다. 이벤트가 실행되면 큐에 있는 작업가 지정된 브로드캐스트 드라이버를 사용하여 자동으로 이벤트를 브로드캐스트합니다.

브로드캐스트 이름

기본적으로 Laravel는 이벤트의 클래스 이름을 사용하여 이벤트를 브로드캐스트합니다. 그러나 이벤트에 broadcastAs 메서드를 정의하여 브로드캐스트 이름을 사용자 지정할 수 있습니다.

/**
 * The event's broadcast name.
 */
public function broadcastAs(): string
{
    return 'server.created';
}

broadcastAs 메서드를 사용하여 브로드캐스트 이름을 사용자 지정하는 경우 선행 . 문자로 리스너를 등록해야 합니다. 이렇게 하면 Echo가 애플리케이션의 네임스페이스를 이벤트 앞에 추가하지 않도록 지시합니다.

.listen('.server.created', function (e) {
    // ...
});

브로드캐스트 데이터

이벤트가 브로드캐스트되면 모든 public 속성이 자동으로 직렬화되고 이벤트의 페이로드로 브로드캐스트되므로 JavaScript 애플리케이션에서 공개 데이터에 액세스할 수 있습니다. 예를 들어 이벤트에 Eloquent 모델을 포함하는 단일 공개 $user 속성이 있는 경우 이벤트의 브로드캐스트 페이로드는 다음과 같습니다.

{
    "user": {
        "id": 1,
        "name": "Patrick Stewart"
        ...
    }
}

그러나 브로드캐스트 페이로드를 보다 세밀하게 제어하려면 이벤트에 broadcastWith 메서드를 추가할 수 있습니다. 이 메서드는 이벤트 페이로드로 브로드캐스트하려는 데이터 배열을 반환해야 합니다.

/**
 * Get the data to broadcast.
 *
 * @return array<string, mixed>
 */
public function broadcastWith(): array
{
    return ['id' => $this->user->id];
}

브로드캐스트 큐

기본적으로 각 브로드캐스트 이벤트는 queue.php 구성 파일에 지정된 기본 큐 연결에 대한 기본 큐에 배치됩니다. 이벤트 클래스에 Connection 및 Queue 속성을 사용하여 브로드캐스터가 사용하는 큐 연결과 이름을 사용자 지정할 수 있습니다.

use Illuminate\Queue\Attributes\Connection;
use Illuminate\Queue\Attributes\Queue;

#[Connection('redis')]
#[Queue('default')]
class ServerCreated implements ShouldBroadcast
{
    // ...
}

또는 이벤트에 broadcastQueue 메서드를 정의하여 큐 이름을 사용자 지정할 수도 있습니다.

/**
 * The name of the queue on which to place the broadcasting job.
 */
public function broadcastQueue(): string
{
    return 'default';
}

기본 큐 드라이버 대신 sync 큐를 사용하여 이벤트를 브로드캐스팅하려는 경우 ShouldBroadcast 대신 ShouldBroadcastNow 인터페이스를 구현할 수 있습니다.

<?php

namespace App\Events;

use Illuminate\Contracts\Broadcasting\ShouldBroadcastNow;

class OrderShipmentStatusUpdated implements ShouldBroadcastNow
{
    // ...
}

브로드캐스트 조건

때때로 주어진 조건이 참인 경우에만 이벤트를 브로드캐스트하고 싶을 때가 있습니다. 이벤트 클래스에 broadcastWhen 메서드를 추가하여 이러한 조건을 정의할 수 있습니다.

/**
 * Determine if this event should broadcast.
 */
public function broadcastWhen(): bool
{
    return $this->order->value > 100;
}

브로드캐스트와 데이터베이스 트랜잭션

브로드캐스트 이벤트가 데이터베이스 트랜잭션 내의 디스패치인 경우 데이터베이스 트랜잭션이 커밋되기 전에 큐에 의해 처리될 수 있습니다. 이런 일이 발생하면 데이터베이스 트랜잭션 중에 모델 또는 데이터베이스 레코드에 대해 수행한 업데이트가 아직 데이터베이스에 반영되지 않을 수 있습니다. 또한 트랜잭션 내에서 생성된 모델 또는 데이터베이스 레코드가 데이터베이스에 존재하지 않을 수도 있습니다. 이벤트가 이러한 모델에 의존하는 경우 이벤트를 브로드캐스트하는 작업이 처리될 때 예기치 않은 오류가 발생할 수 있습니다.

큐 연결의 after_commit 구성 옵션이 false로 설정된 경우에도 이벤트 클래스에서 ShouldDispatchAfterCommit 인터페이스를 구현하여 열려 있는 모든 데이터베이스 트랜잭션이 커밋된 후에도 특정 브로드캐스트 이벤트가 디스패치여야 함을 나타낼 수 있습니다.

<?php

namespace App\Events;

use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
use Illuminate\Contracts\Events\ShouldDispatchAfterCommit;
use Illuminate\Queue\SerializesModels;

class ServerCreated implements ShouldBroadcast, ShouldDispatchAfterCommit
{
    use SerializesModels;
}

[!NOTE] 이러한 문제를 해결하는 방법에 대해 자세히 알아보려면 큐에 있는 작업 및 데이터베이스 트랜잭션에 관한 설명서를 검토하세요.

채널 인가 (Authorizing Channels)

비공개 채널에서는 현재 인증된 사용자가 실제로 채널을 수신할 수 있도록 인가해야 합니다. 이는 채널 이름을 포함한 HTTP 요청을 Laravel 애플리케이션에 보내고, 애플리케이션이 사용자가 해당 채널을 수신할 수 있는지 여부를 결정하는 방식으로 수행됩니다. Laravel Echo를 사용하면 비공개 채널 구독을 인가하는 HTTP 요청이 자동으로 이루어집니다.

브로드캐스트가 설치되면 Laravel는 인증 요청을 처리하기 위해 /broadcasting/auth 라우트를 자동으로 등록하려고 시도합니다. Laravel가 이러한 라우트를 자동으로 등록하지 못하는 경우 애플리케이션의 /bootstrap/app.php 파일에 수동으로 등록할 수 있습니다.

->withRouting(
    web: __DIR__.'/../routes/web.php',
    channels: __DIR__.'/../routes/channels.php',
    health: '/up',
)

인가 콜백 정의

다음으로, 현재 인증된 사용자가 특정 채널을 수신할 수 있는지 실제로 결정하는 로직을 정의해야 합니다. 이는 install:broadcasting Artisan 명령으로 생성된 routes/channels.php 파일에서 수행됩니다. 이 파일에서는 Broadcast::channel 메서드를 사용하여 채널 인가 콜백을 등록할 수 있습니다.

use App\Models\User;

Broadcast::channel('orders.{orderId}', function (User $user, int $orderId) {
    return $user->id === Order::findOrNew($orderId)->user_id;
});

channel 메서드는 채널 이름과 사용자가 채널에서 수신할 수 있는 권한이 있는지 여부를 나타내는 true 또는 false를 반환하는 콜백이라는 두 가지 인수를 허용합니다.

모든 인가 콜백은 현재 인증된 사용자를 첫 번째 인수로 받고 추가 와일드카드 매개변수를 후속 인수로 받습니다. 이 예에서는 {orderId} 자리 표시자를 사용하여 채널 이름의 "ID" 부분이 와일드카드임을 나타냅니다.

channel:list Artisan 명령을 사용하여 애플리케이션의 브로드캐스트 인가 콜백 목록을 확인할 수 있습니다.

php artisan channel:list

인가 콜백 모델 바인딩

HTTP 라우트와 마찬가지로 채널 라우트도 암시적 및 명시적 라우트 모델 바인딩을 활용할 수 있습니다. 예를 들어 문자열이나 숫자로 된 주문 ID를 받는 대신 실제 Order 모델 인스턴스를 요청할 수 있습니다.

use App\Models\Order;
use App\Models\User;

Broadcast::channel('orders.{order}', function (User $user, Order $order) {
    return $user->id === $order->user_id;
});

[!WARNING] HTTP 라우트 모델 바인딩과 달리 채널 모델 바인딩은 자동 암시적 모델 바인딩 범위 지정을 지원하지 않습니다. 그러나 대부분의 채널은 단일 모델의 고유한 기본 키를 기반으로 범위가 지정될 수 있으므로 이는 거의 문제가 되지 않습니다.

인가 콜백 인증

비공개 및 프레즌스 브로드캐스트 채널은 애플리케이션의 기본 인증 가드를 통해 현재 사용자를 인증합니다. 사용자가 인증되지 않으면 채널 인가가 자동으로 거부되고 인가 콜백이 실행되지 않습니다. 그러나 필요한 경우 수신 요청을 인증해야 하는 여러 커스텀 가드를 할당할 수 있습니다.

Broadcast::channel('channel', function () {
    // ...
}, ['guards' => ['web', 'admin']]);

채널 클래스 정의

애플리케이션이 다양한 채널을 사용하는 경우 routes/channels.php 파일이 커질 수 있습니다. 따라서 채널을 인가하기 위해 클로저를 사용하는 대신 채널 클래스를 사용할 수 있습니다. 채널 클래스를 생성하려면 make:channel Artisan 명령을 사용하십시오. 이 명령은 App/Broadcasting 디렉토리에 새 채널 클래스를 배치합니다.

php artisan make:channel OrderChannel

다음으로 routes/channels.php 파일에 채널을 등록하세요.

use App\Broadcasting\OrderChannel;

Broadcast::channel('orders.{order}', OrderChannel::class);

마지막으로 채널 클래스의 join 메서드에 채널에 대한 인가 로직을 배치할 수 있습니다. 이 join 메서드에는 일반적으로 채널 인가 클로저에 배치하는 것과 동일한 로직이 포함됩니다. 채널 모델 바인딩을 활용할 수도 있습니다.

<?php

namespace App\Broadcasting;

use App\Models\Order;
use App\Models\User;

class OrderChannel
{
    /**
     * Create a new channel instance.
     */
    public function __construct() {}

    /**
     * Authenticate the user's access to the channel.
     */
    public function join(User $user, Order $order): array|bool
    {
        return $user->id === $order->user_id;
    }
}

[!NOTE] Laravel의 다른 많은 클래스와 마찬가지로 채널 클래스는 서비스 컨테이너에 의해 자동으로 확인됩니다. 따라서 생성자에서 채널에 필요한 종속성을 유형 힌트로 지정할 수 있습니다.

이벤트 브로드캐스팅 (Broadcasting Events)

이벤트를 정의하고 ShouldBroadcast 인터페이스로 표시한 후에는 이벤트의 디스패치 메서드를 사용하여 이벤트를 실행하기만 하면 됩니다. 이벤트 디스패처는 이벤트가 ShouldBroadcast 인터페이스로 표시되어 있음을 확인하고 브로드캐스팅을 위해 이벤트를 큐에 넣습니다.

use App\Events\OrderShipmentStatusUpdated;

OrderShipmentStatusUpdated::dispatch($order);

다른 사람에게만

이벤트 브로드캐스팅을 활용하는 애플리케이션을 구축할 때 때때로 현재 사용자를 제외한 특정 채널의 모든 구독자에게 이벤트를 브로드캐스트해야 할 수도 있습니다. broadcast 도우미와 toOthers 메서드를 사용하여 이 작업을 수행할 수 있습니다.

use App\Events\OrderShipmentStatusUpdated;

broadcast(new OrderShipmentStatusUpdated($update))->toOthers();

toOthers 메서드를 사용하려는 경우를 더 잘 이해하기 위해 사용자가 작업 이름을 입력하여 새 작업을 생성할 수 있는 작업 목록 애플리케이션을 상상해 보겠습니다. 작업을 생성하기 위해 애플리케이션은 작업 생성을 브로드캐스트하고 새 작업의 JSON 표현을 반환하는 /task URL에 요청할 수 있습니다. JavaScript 애플리케이션이 엔드포인트로부터 응답을 받으면 다음과 같이 새 작업을 작업 목록에 직접 삽입할 수 있습니다.

axios.post('/task', task)
    .then((response) => {
        this.tasks.push(response.data);
    });

그러나 작업 생성도 브로드캐스트된다는 점을 기억하세요. JavaScript 애플리케이션이 작업 목록에 작업을 추가하기 위해 이 이벤트도 수신하는 경우 목록에 중복된 작업이 있게 됩니다. 하나는 엔드포인트에서, 다른 하나는 브로드캐스트에서 발생합니다. toOthers 메서드를 사용하여 브로드캐스터에 현재 사용자에게 이벤트를 브로드캐스트하지 않도록 지시하면 이 문제를 해결할 수 있습니다.

[!WARNING] 이벤트는 toOthers 메서드를 호출하려면 Illuminate\Broadcasting\InteractsWithSockets 트레이트를 사용해야 합니다.

구성

Laravel Echo 인스턴스를 초기화하면 소켓 ID가 연결에 할당됩니다. 전역 Axios 인스턴스를 사용하여 JavaScript 애플리케이션에서 HTTP 요청을 생성하는 경우 소켓 ID는 모든 나가는 요청에 X-Socket-ID 헤더로 자동 첨부됩니다. 그런 다음 toOthers 메서드를 호출하면 Laravel는 헤더에서 소켓 ID를 추출하고 해당 소켓 ID가 있는 연결에는 브로드캐스트하지 않도록 브로드캐스터에 지시합니다.

글로벌 Axios 인스턴스를 사용하지 않는 경우 모든 나가는 요청과 함께 X-Socket-ID 헤더를 보내도록 JavaScript 애플리케이션을 수동으로 구성해야 합니다. Echo.socketId 메서드를 사용하여 소켓 ID를 검색할 수 있습니다:

var socketId = Echo.socketId();

연결 사용자 지정

애플리케이션이 여러 브로드캐스트 연결과 상호 작용하고 기본 브로드캐스터가 아닌 다른 브로드캐스터를 사용하여 이벤트를 브로드캐스트하려는 경우 via 메서드를 사용하여 이벤트를 푸시할 연결을 지정할 수 있습니다.

use App\Events\OrderShipmentStatusUpdated;

broadcast(new OrderShipmentStatusUpdated($update))->via('pusher');

또는 이벤트 생성자 내에서 broadcastVia 메서드를 호출하여 이벤트의 브로드캐스트 연결을 지정할 수도 있습니다. 그러나 그렇게 하기 전에 이벤트 클래스가 InteractsWithBroadcasting 트레이트를 사용하는지 확인해야 합니다.

<?php

namespace App\Events;

use Illuminate\Broadcasting\Channel;
use Illuminate\Broadcasting\InteractsWithBroadcasting;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Broadcasting\PresenceChannel;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
use Illuminate\Queue\SerializesModels;

class OrderShipmentStatusUpdated implements ShouldBroadcast
{
    use InteractsWithBroadcasting;

    /**
     * Create a new event instance.
     */
    public function __construct()
    {
        $this->broadcastVia('pusher');
    }
}

익명 이벤트

때로는 전용 이벤트 클래스를 만들지 않고 간단한 이벤트를 애플리케이션의 프론트엔드에 브로드캐스팅하고 싶을 수도 있습니다. 이를 수용하기 위해 Broadcast 파사드를 사용하면 "익명 이벤트"를 브로드캐스트할 수 있습니다.

Broadcast::on('orders.'.$order->id)->send();

위의 예에서는 다음 이벤트를 브로드캐스트합니다.

{
    "event": "AnonymousEvent",
    "data": "[]",
    "channel": "orders.1"
}

as 및 with 메서드를 사용하면 이벤트의 이름과 데이터를 사용자 지정할 수 있습니다.

Broadcast::on('orders.'.$order->id)
    ->as('OrderPlaced')
    ->with($order)
    ->send();

위의 예는 다음과 같이 이벤트를 브로드캐스트합니다.

{
    "event": "OrderPlaced",
    "data": "{ id: 1, total: 100 }",
    "channel": "orders.1"
}

비공개 또는 프레즌스 채널에서 익명 이벤트를 브로드캐스트하려면 private 및 presence 메서드를 활용할 수 있습니다.

Broadcast::private('orders.'.$order->id)->send();
Broadcast::presence('channels.'.$channel->id)->send();

send 메서드를 사용하면 익명 이벤트가 애플리케이션의 큐에 디스패치되어 처리됩니다. 이벤트를 즉시 브로드캐스트하려면 sendNow 메서드를 사용할 수 있습니다.

Broadcast::on('orders.'.$order->id)->sendNow();

현재 인증된 사용자를 제외한 모든 채널 구독자에게 이벤트를 브로드캐스트하려면 toOthers 메서드를 호출하면 됩니다.

Broadcast::on('orders.'.$order->id)
    ->toOthers()
    ->send();

브로드캐스트 복구

애플리케이션의 큐 서버를 사용할 수 없거나 이벤트를 브로드캐스트하는 동안 Laravel에 오류가 발생하면 일반적으로 최종 사용자에게 애플리케이션 오류가 표시되는 예외가 발생합니다. 이벤트 브로드캐스팅은 애플리케이션의 핵심 기능을 보완하는 경우가 많으므로 이벤트에 ShouldRescue 인터페이스를 구현하여 이러한 예외로 인해 사용자 경험이 중단되는 것을 방지할 수 있습니다.

ShouldRescue 인터페이스를 구현하는 이벤트는 브로드캐스트 시도 중에 Laravel의 rescue 헬퍼 함수을 자동으로 활용합니다. 이 도우미는 모든 예외를 포착하고 이를 애플리케이션의 예외 처리기에 기록하여 보고하며 사용자의 작업 흐름을 방해하지 않고 애플리케이션이 정상적으로 계속 실행될 수 있도록 합니다.

<?php

namespace App\Events;

use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
use Illuminate\Contracts\Broadcasting\ShouldRescue;

class ServerCreated implements ShouldBroadcast, ShouldRescue
{
    // ...
}

브로드캐스트 수신 (Receiving Broadcasts)

이벤트 수신

Laravel Echo를 설치하고 인스턴스화하고 나면 Laravel 애플리케이션에서 브로드캐스트되는 이벤트를 수신할 준비가 된 것입니다. 먼저 channel 메서드를 사용하여 채널의 인스턴스를 검색한 다음 listen 메서드를 호출하여 지정된 이벤트를 수신합니다.

Echo.channel(`orders.${this.order.id}`)
    .listen('OrderShipmentStatusUpdated', (e) => {
        console.log(e.order.name);
    });

비공개 채널에서 이벤트를 수신하려면 대신 private 메서드를 사용하세요. 단일 채널에서 여러 이벤트를 수신하기 위해 계속해서 listen 메서드에 대한 호출을 연결할 수 있습니다.

Echo.private(`orders.${this.order.id}`)
    .listen(/* ... */)
    .listen(/* ... */)
    .listen(/* ... */);

이벤트 수신 중지

채널을 나가지 않고 특정 이벤트 수신을 중지하려면 stopListening 메서드를 사용할 수 있습니다.

Echo.private(`orders.${this.order.id}`)
    .stopListening('OrderShipmentStatusUpdated');

채널 나가기

채널을 나가려면 Echo 인스턴스에서 leaveChannel 메서드를 호출하면 됩니다.

Echo.leaveChannel(`orders.${this.order.id}`);

채널과 관련 비공개 및 프레즌스 채널을 종료하려면 leave 메서드를 호출하면 됩니다.

Echo.leave(`orders.${this.order.id}`);

네임스페이스

위의 예에서 이벤트 클래스에 대해 전체 App\Events 네임스페이스를 지정하지 않았음을 알 수 있습니다. 이는 Echo가 자동으로 이벤트가 App\Events 네임스페이스에 있다고 가정하기 때문입니다. 그러나 namespace 구성 옵션을 전달하여 Echo를 인스턴스화할 때 루트 네임스페이스를 구성할 수 있습니다.

window.Echo = new Echo({
    broadcaster: 'pusher',
    // ...
    namespace: 'App.Other.Namespace'
});

또는 Echo를 사용하여 구독할 때 이벤트 클래스 앞에 .를 붙일 수도 있습니다. 이렇게 하면 항상 정규화된 클래스 이름을 지정할 수 있습니다.

Echo.channel('orders')
    .listen('.Namespace\\Event\\Class', (e) => {
        // ...
    });

React 또는 Vue 사용

Laravel Echo에는 이벤트를 쉽게 수신할 수 있게 해주는 React 및 Vue 후크가 포함되어 있습니다. 시작하려면 비공개 이벤트를 수신하는 데 사용되는 useEcho 후크를 호출하십시오. useEcho 후크는 소비 컴포넌트가 마운트 해제되면 자동으로 채널을 종료합니다.

import { useEcho } from "@laravel/echo-react";

useEcho(
    `orders.${orderId}`,
    "OrderShipmentStatusUpdated",
    (e) => {
        console.log(e.order);
    },
);

<script setup lang="ts">
import { useEcho } from "@laravel/echo-vue";

useEcho(
    `orders.${orderId}`,
    "OrderShipmentStatusUpdated",
    (e) => {
        console.log(e.order);
    },
);
</script>

useEcho에 이벤트 배열을 제공하여 여러 이벤트를 수신할 수 있습니다.

useEcho(
    `orders.${orderId}`,
    ["OrderShipmentStatusUpdated", "OrderShipped"],
    (e) => {
        console.log(e.order);
    },
);

또한 브로드캐스트 이벤트 페이로드 데이터의 모양을 지정하여 유형 안전성과 편집 편의성을 높일 수도 있습니다.

type OrderData = {
    order: {
        id: number;
        user: {
            id: number;
            name: string;
        };
        created_at: string;
    };
};

useEcho<OrderData>(`orders.${orderId}`, "OrderShipmentStatusUpdated", (e) => {
    console.log(e.order.id);
    console.log(e.order.user.id);
});

useEcho 후크는 소비 컴포넌트가 마운트 해제되면 자동으로 채널을 종료합니다. 그러나 필요한 경우 반환된 함수를 활용하여 프로그래밍 방식으로 채널 수신을 수동으로 중지/시작할 수 있습니다.

import { useEcho } from "@laravel/echo-react";

const { leaveChannel, leave, stopListening, listen } = useEcho(
    `orders.${orderId}`,
    "OrderShipmentStatusUpdated",
    (e) => {
        console.log(e.order);
    },
);

// Stop listening without leaving channel...
stopListening();

// Start listening again...
listen();

// Leave channel...
leaveChannel();

// Leave a channel and also its associated private and presence channels...
leave();

<script setup lang="ts">
import { useEcho } from "@laravel/echo-vue";

const { leaveChannel, leave, stopListening, listen } = useEcho(
    `orders.${orderId}`,
    "OrderShipmentStatusUpdated",
    (e) => {
        console.log(e.order);
    },
);

// Stop listening without leaving channel...
stopListening();

// Start listening again...
listen();

// Leave channel...
leaveChannel();

// Leave a channel and also its associated private and presence channels...
leave();
</script>

공개 채널에 연결

공개 채널에 연결하려면 useEchoPublic 후크를 사용할 수 있습니다.

import { useEchoPublic } from "@laravel/echo-react";

useEchoPublic("posts", "PostPublished", (e) => {
    console.log(e.post);
});

<script setup lang="ts">
import { useEchoPublic } from "@laravel/echo-vue";

useEchoPublic("posts", "PostPublished", (e) => {
    console.log(e.post);
});
</script>

프레즌스 채널에 연결

프레즌스 채널에 연결하려면 useEchoPresence 후크를 사용할 수 있습니다.

import { useEchoPresence } from "@laravel/echo-react";

useEchoPresence("posts", "PostPublished", (e) => {
    console.log(e.post);
});

<script setup lang="ts">
import { useEchoPresence } from "@laravel/echo-vue";

useEchoPresence("posts", "PostPublished", (e) => {
    console.log(e.post);
});
</script>

연결 상태

연결 상태가 변경되면 자동으로 업데이트되는 반응 상태를 제공하는 useConnectionStatus 후크를 사용하여 현재 WebSocket 연결 상태를 검색할 수 있습니다.

import { useConnectionStatus } from "@laravel/echo-react";

function ConnectionIndicator() {
    const status = useConnectionStatus();

    return <div>Connection: {status}</div>;
}

<script setup lang="ts">
import { useConnectionStatus } from "@laravel/echo-vue";

const status = useConnectionStatus();
</script>

<template>
    <div>Connection: {{ status }}</div>
</template>

가능한 상태 값은 다음과 같습니다.

• connected - WebSocket 서버에 성공적으로 연결되었습니다.
• connecting - 초기 연결 시도가 진행 중입니다.
• reconnecting - 연결이 끊어진 후 다시 연결을 시도합니다.
• disconnected - 연결되지 않았으며 다시 연결을 시도하지 않습니다.
• failed - 연결이 실패했으며 다시 시도하지 않습니다.

프레즌스 채널 (Presence Channels)

프레즌스 채널은 비공개 채널의 보안을 기반으로 구축되는 동시에 채널 구독자를 인식하는 추가 기능을 제공합니다. 이를 통해 다른 사용자가 동일한 페이지를 볼 때 사용자에게 알리거나 채팅방 거주자 목록을 나열하는 등 강력한 협업 애플리케이션 기능을 쉽게 구축할 수 있습니다.

프레즌스 채널 인가

모든 프레즌스 채널은 비공개 채널이기도 합니다. 따라서 사용자는 액세스 권한을 받아야 합니다. 그러나 프레즌스 채널에 대한 인가 콜백을 정의할 때 사용자가 채널에 참여할 수 있는 권한이 있으면 true를 반환하지 않습니다. 대신 사용자에 대한 데이터 배열을 반환해야 합니다.

인가 콜백에서 반환된 데이터는 JavaScript 애플리케이션의 프레즌스 채널 이벤트 리스너에서 사용할 수 있습니다. 사용자가 프레즌스 채널에 참여할 권한이 없는 경우 false 또는 null를 반환해야 합니다.

use App\Models\User;

Broadcast::channel('chat.{roomId}', function (User $user, int $roomId) {
    if ($user->canJoinRoom($roomId)) {
        return ['id' => $user->id, 'name' => $user->name];
    }
});

프레즌스 채널에 참여하기

프레즌스 채널에 참여하려면 Echo의 join 메서드를 사용할 수 있습니다. join 메서드는 listen 메서드와 함께 here, joining 및 leaving 이벤트를 구독할 수 있게 해주는 PresenceChannel 구현을 반환합니다.

Echo.join(`chat.${roomId}`)
    .here((users) => {
        // ...
    })
    .joining((user) => {
        console.log(user.name);
    })
    .leaving((user) => {
        console.log(user.name);
    })
    .error((error) => {
        console.error(error);
    });

here 콜백은 채널에 성공적으로 참여하면 즉시 실행되며, 현재 채널에 참여하고 있는 다른 모든 사용자의 정보가 포함된 배열을 수신합니다. joining 메서드는 새로운 사용자가 채널에 참여할 때 실행되고, leaving 메서드는 사용자가 채널을 떠날 때 실행됩니다. 인가 엔드포인트가 200이 아닌 HTTP 상태 코드를 반환하거나 반환된 JSON을 파싱하는 데 문제가 있는 경우 error 메서드가 실행됩니다.

프레즌스 채널로 브로드캐스팅

프레즌스 채널은 공개 또는 비공개 채널과 마찬가지로 이벤트를 수신할 수 있습니다. 채팅방의 예를 사용하여 NewMessage 이벤트를 방의 프레즌스 채널에 브로드캐스트할 수 있습니다. 이를 위해 이벤트의 broadcastOn 메서드에서 PresenceChannel 인스턴스를 반환합니다.

/**
 * Get the channels the event should broadcast on.
 *
 * @return array<int, \Illuminate\Broadcasting\Channel>
 */
public function broadcastOn(): array
{
    return [
        new PresenceChannel('chat.'.$this->message->room_id),
    ];
}

다른 이벤트와 마찬가지로 broadcast 도우미와 toOthers 메서드를 사용하여 현재 사용자를 브로드캐스트 수신에서 제외할 수 있습니다.

broadcast(new NewMessage($message));

broadcast(new NewMessage($message))->toOthers();

다른 유형의 이벤트와 마찬가지로 Echo의 listen 메서드를 사용하여 프레즌스 채널로 전송된 이벤트를 수신할 수 있습니다.

Echo.join(`chat.${roomId}`)
    .here(/* ... */)
    .joining(/* ... */)
    .leaving(/* ... */)
    .listen('NewMessage', (e) => {
        // ...
    });

모델 브로드캐스팅 (Model Broadcasting)

[!WARNING] 모델 브로드캐스팅에 대한 다음 문서를 읽기 전에 Laravel의 모델 브로드캐스팅 서비스의 일반적인 개념과 브로드캐스트 이벤트를 수동으로 생성하고 수신하는 방법을 숙지하는 것이 좋습니다.

애플리케이션의 Eloquent 모델가 생성, 업데이트 또는 삭제될 때 이벤트를 브로드캐스트하는 것이 일반적입니다. 물론 이는 수동으로 Eloquent 모델 상태 변경에 대한 사용자 지정 이벤트 정의하고 해당 이벤트를 ShouldBroadcast 인터페이스로 표시하여 쉽게 수행할 수 있습니다.

그러나 애플리케이션에서 다른 목적으로 이러한 이벤트를 사용하지 않는 경우 이를 브로드캐스팅할 목적으로만 이벤트 클래스를 생성하는 것이 번거로울 수 있습니다. 이 문제를 해결하기 위해 Laravel을 사용하면 Eloquent 모델이 상태 변경 사항을 자동으로 브로드캐스트해야 함을 나타낼 수 있습니다.

시작하려면 Eloquent 모델이 Illuminate\Database\Eloquent\BroadcastsEvents 트레이트를 사용해야 합니다. 또한 모델은 모델의 이벤트가 브로드캐스트해야 하는 채널 배열을 반환하는 broadcastOn 메서드를 정의해야 합니다.

<?php

namespace App\Models;

use Illuminate\Broadcasting\Channel;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Database\Eloquent\BroadcastsEvents;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;

class Post extends Model
{
    use BroadcastsEvents, HasFactory;

    /**
     * Get the user that the post belongs to.
     */
    public function user(): BelongsTo
    {
        return $this->belongsTo(User::class);
    }

    /**
     * Get the channels that model events should broadcast on.
     *
     * @return array<int, \Illuminate\Broadcasting\Channel|\Illuminate\Database\Eloquent\Model>
     */
    public function broadcastOn(string $event): array
    {
        return [$this, $this->user];
    }
}

모델에 이 트레이트가 포함되고 브로드캐스트 채널을 정의하면 모델 인스턴스가 생성, 업데이트, 삭제, 소프트 삭제 또는 복원될 때 자동으로 이벤트 브로드캐스팅이 시작됩니다.

또한 broadcastOn 메서드가 문자열 $event 인수를 받는 것을 알 수 있습니다. 이 인수에는 모델에서 발생한 이벤트 유형이 포함되며 값은 created, updated, deleted, trashed 또는 restored입니다. 이 변수의 값을 검사하여 모델이 특정 이벤트에 대해 브로드캐스트해야 하는 채널(있는 경우)을 결정할 수 있습니다.

/**
 * Get the channels that model events should broadcast on.
 *
 * @return array<string, array<int, \Illuminate\Broadcasting\Channel|\Illuminate\Database\Eloquent\Model>>
 */
public function broadcastOn(string $event): array
{
    return match ($event) {
        'deleted' => [],
        default => [$this, $this->user],
    };
}

모델 브로드캐스트 이벤트 생성 사용자 지정

경우에 따라 Laravel이 기본 모델 브로드캐스트 이벤트를 생성하는 방식을 사용자 지정하고 싶을 수도 있습니다. Eloquent 모델에 newBroadcastableEvent 메서드를 정의하여 이를 수행할 수 있습니다. 이 메서드는 Illuminate\Database\Eloquent\BroadcastableModelEventOccurred 인스턴스를 반환해야 합니다.

use Illuminate\Database\Eloquent\BroadcastableModelEventOccurred;

/**
 * Create a new broadcastable model event for the model.
 */
protected function newBroadcastableEvent(string $event): BroadcastableModelEventOccurred
{
    return (new BroadcastableModelEventOccurred(
        $this, $event
    ))->dontBroadcastToCurrentUser();
}

모델 브로드캐스팅 규칙

채널 규칙

아시다시피 위의 모델 예제에서 broadcastOn 메서드는 Channel 인스턴스를 반환하지 않았습니다. 대신 Eloquent 모델이 직접 반환되었습니다. Eloquent 모델 인스턴스가 모델의 broadcastOn 메서드에 의해 반환되거나 메서드에 의해 반환된 배열에 포함된 경우, Laravel는 모델의 클래스 이름과 기본 키 식별자를 채널 이름으로 사용하여 모델에 대한 비공개 채널 인스턴스를 자동으로 인스턴스화합니다.

따라서 1의 id가 포함된 App\Models\User 모델은 이름이 App.Models.User.1인 Illuminate\Broadcasting\PrivateChannel 인스턴스로 변환됩니다. 물론 모델의 broadcastOn 메서드에서 Eloquent 모델 인스턴스를 반환하는 것 외에도 모델의 채널 이름을 완전히 제어하기 위해 완전한 Channel 인스턴스를 반환할 수도 있습니다.

use Illuminate\Broadcasting\PrivateChannel;

/**
 * Get the channels that model events should broadcast on.
 *
 * @return array<int, \Illuminate\Broadcasting\Channel>
 */
public function broadcastOn(string $event): array
{
    return [
        new PrivateChannel('user.'.$this->id)
    ];
}

모델의 broadcastOn 메서드에서 채널 인스턴스를 명시적으로 반환하려는 경우 Eloquent 모델 인스턴스를 채널 생성자에 전달할 수 있습니다. 이렇게 하면 Laravel는 위에서 설명한 모델 채널 규칙을 사용하여 Eloquent 모델을 채널 이름 문자열로 변환합니다.

return [new Channel($this->user)];

모델의 채널 이름을 확인해야 하는 경우 모델 인스턴스에서 broadcastChannel 메서드를 호출할 수 있습니다. 예를 들어, 이 메서드는 1의 id를 사용하여 App\Models\User 모델에 대해 App.Models.User.1 문자열을 반환합니다.

$user->broadcastChannel();

이벤트 규칙

모델 브로드캐스트 이벤트는 애플리케이션의 App\Events 디렉터리 내의 "실제" 이벤트와 연결되지 않으므로 규칙에 따라 이름과 페이로드가 할당됩니다. Laravel의 규칙은 모델의 클래스 이름(네임스페이스 제외)과 브로드캐스트를 트리거한 모델 이벤트의 이름을 사용하여 이벤트를 브로드캐스트하는 것입니다.

예를 들어 App\Models\Post 모델에 대한 업데이트는 다음 페이로드를 사용하여 이벤트를 클라이언트 측 애플리케이션에 PostUpdated로 브로드캐스트합니다.

{
    "model": {
        "id": 1,
        "title": "My first post"
        ...
    },
    ...
    "socket": "someSocketId"
}

App\Models\User 모델을 삭제하면 UserDeleted라는 이벤트가 브로드캐스트됩니다.

원하는 경우 모델에 broadcastAs 및 broadcastWith 메서드를 추가하여 커스텀 브로드캐스트 이름과 페이로드를 정의할 수 있습니다. 이러한 메서드는 발생 중인 모델 이벤트 / 작업의 이름을 수신하여 각 모델 작업에 대해 이벤트의 이름과 페이로드를 사용자 지정할 수 있습니다. null가 broadcastAs 메서드에서 반환되면 Laravel는 이벤트를 브로드캐스트할 때 위에서 설명한 모델 브로드캐스팅 이벤트 이름 규칙을 사용합니다.

/**
 * The model event's broadcast name.
 */
public function broadcastAs(string $event): string|null
{
    return match ($event) {
        'created' => 'post.created',
        default => null,
    };
}

/**
 * Get the data to broadcast for the model.
 *
 * @return array<string, mixed>
 */
public function broadcastWith(string $event): array
{
    return match ($event) {
        'created' => ['title' => $this->title],
        default => ['model' => $this],
    };
}

모델 브로드캐스트 수신

모델에 BroadcastsEvents 트레이트를 추가하고 모델의 broadcastOn 메서드를 정의하면 클라이언트 측 애플리케이션 내에서 브로드캐스트된 모델 이벤트를 수신할 준비가 된 것입니다. 시작하기 전에 이벤트 수신에 대한 전체 문서를 참조하는 것이 좋습니다.

먼저 private 메서드를 사용하여 채널의 인스턴스를 검색한 다음 listen 메서드를 호출하여 지정된 이벤트를 수신합니다. 일반적으로 private 메서드에 지정된 채널 이름은 Laravel의 모델 브로드캐스팅 규칙과 일치해야 합니다.

채널 인스턴스를 얻은 후에는 listen 메서드를 사용하여 특정 이벤트를 수신할 수 있습니다. 모델 브로드캐스트 이벤트는 애플리케이션의 App\Events 디렉터리 내의 "실제" 이벤트와 연결되어 있지 않으므로 이벤트 이름 앞에 .가 붙어 특정 네임스페이스에 속하지 않음을 나타내야 합니다. 각 모델 브로드캐스트 이벤트에는 모델의 브로드캐스트 가능한 모든 속성을 포함하는 model 속성이 있습니다.

Echo.private(`App.Models.User.${this.user.id}`)
    .listen('.UserUpdated', (e) => {
        console.log(e.model);
    });

React 또는 Vue 사용

React 또는 Vue를 사용하는 경우 Laravel Echo에 포함된 useEchoModel 후크를 사용하여 모델 브로드캐스트를 쉽게 수신할 수 있습니다.

import { useEchoModel } from "@laravel/echo-react";

useEchoModel("App.Models.User", userId, ["UserUpdated"], (e) => {
    console.log(e.model);
});

<script setup lang="ts">
import { useEchoModel } from "@laravel/echo-vue";

useEchoModel("App.Models.User", userId, ["UserUpdated"], (e) => {
    console.log(e.model);
});
</script>

또한 모델 이벤트 페이로드 데이터의 모양을 지정하여 유형 안전성과 편집 편의성을 높일 수도 있습니다.

type User = {
    id: number;
    name: string;
    email: string;
};

useEchoModel<User, "App.Models.User">("App.Models.User", userId, ["UserUpdated"], (e) => {
    console.log(e.model.id);
    console.log(e.model.name);
});

클라이언트 이벤트 (Client Events)

[!NOTE] 푸셔 채널을 사용할 때 클라이언트 이벤트를 보내려면 애플리케이션 대시보드의 "앱 설정" 섹션에서 "클라이언트 이벤트" 옵션을 활성화해야 합니다.

때로는 Laravel 애플리케이션을 전혀 실행하지 않고 연결된 다른 클라이언트에 이벤트를 브로드캐스트하고 싶을 수도 있습니다. 이는 다른 사용자가 특정 화면에 메시지를 입력하고 있음을 애플리케이션 사용자에게 알리려는 "입력" 알림과 같은 작업에 특히 유용할 수 있습니다.

클라이언트 이벤트를 브로드캐스트하려면 Echo의 whisper 메서드를 사용할 수 있습니다.

Echo.private(`chat.${roomId}`)
    .whisper('typing', {
        name: this.user.name
    });

import { useEcho } from "@laravel/echo-react";

const { channel } = useEcho(`chat.${roomId}`, ['update'], (e) => {
    console.log('Chat event received:', e);
});

channel().whisper('typing', { name: user.name });

<script setup lang="ts">
import { useEcho } from "@laravel/echo-vue";

const { channel } = useEcho(`chat.${roomId}`, ['update'], (e) => {
    console.log('Chat event received:', e);
});

channel().whisper('typing', { name: user.name });
</script>

클라이언트 이벤트를 수신하려면 listenForWhisper 메서드를 사용할 수 있습니다.

Echo.private(`chat.${roomId}`)
    .listenForWhisper('typing', (e) => {
        console.log(e.name);
    });

import { useEcho } from "@laravel/echo-react";

const { channel } = useEcho(`chat.${roomId}`, ['update'], (e) => {
    console.log('Chat event received:', e);
});

channel().listenForWhisper('typing', (e) => {
    console.log(e.name);
});

<script setup lang="ts">
import { useEcho } from "@laravel/echo-vue";

const { channel } = useEcho(`chat.${roomId}`, ['update'], (e) => {
    console.log('Chat event received:', e);
});

channel().listenForWhisper('typing', (e) => {
    console.log(e.name);
});
</script>

알림 (Notifications)

이벤트 브로드캐스팅을 알림과 페어링하면 JavaScript 애플리케이션이 페이지를 새로 고치지 않고도 새 알림을 받을 수 있습니다. 시작하기 전에 브로드캐스트 알림 채널 사용에 대한 설명서를 읽어보세요.

브로드캐스트 채널을 사용하도록 알림을 구성한 후에는 Echo의 notification 메서드를 사용하여 브로드캐스트 이벤트를 수신할 수 있습니다. 채널 이름은 알림을 받는 엔터티의 클래스 이름과 일치해야 합니다.

Echo.private(`App.Models.User.${userId}`)
    .notification((notification) => {
        console.log(notification.type);
    });

import { useEchoModel } from "@laravel/echo-react";

const { channel } = useEchoModel('App.Models.User', userId);

channel().notification((notification) => {
    console.log(notification.type);
});

<script setup lang="ts">
import { useEchoModel } from "@laravel/echo-vue";

const { channel } = useEchoModel('App.Models.User', userId);

channel().notification((notification) => {
    console.log(notification.type);
});
</script>

이 예에서는 broadcast 채널을 통해 App\Models\User 인스턴스로 전송된 모든 알림이 콜백에 의해 수신됩니다. App.Models.User.{id} 채널에 대한 채널 인가 콜백은 애플리케이션의 routes/channels.php 파일에 포함되어 있습니다.

알림 수신 중지

채널을 나가지 않고 알림 수신을 중지하려면 stopListeningForNotification 메서드를 사용할 수 있습니다.

const callback = (notification) => {
    console.log(notification.type);
}

// Start listening...
Echo.private(`App.Models.User.${userId}`)
    .notification(callback);

// Stop listening (callback must be the same)...
Echo.private(`App.Models.User.${userId}`)
    .stopListeningForNotification(callback);