/**
 * 指定广播数据。
 *
 * @return array
 */
 public function broadcastWith(){
     return ['id' => $this->user->id];
 }

/**
 * 事件被推送到的队列名称。
 *
 * @var string
 */
 public $broadcastQueue = 'your-queue-name';

<?php
  use Illuminate\Contracts\Broadcasting\ShouldBroadcastNow;
  class ShippingStatusUpdated implements ShouldBroadcastNow{ 
     //
  }

/**
 * 判定事件是否可以广播。
 *
 * @return bool
 */
 public function broadcastWhen(){ 
    return $this->value > 100;
 }

Broadcast::routes();

Broadcast::routes($attributes);

window.Echo = new Echo({
    broadcaster: 'pusher',
    key: 'your-pusher-key',
    authEndpoint: '/custom/endpoint/auth'
 });

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

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

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

php artisan make:channel OrderChannel

use App\Broadcasting\OrderChannel;
Broadcast::channel('order.{order}', OrderChannel::class);

イベントをブロードキャスト

イベントを定義し、ShouldBroadcast インターフェイスを実装するようにマークした後は、event 関数を使用してイベントをトリガーするだけです。 。イベント ディスパッチャは、ShouldBroadcast インターフェイスを実装するタグ付けされたイベントを認識し、ブロードキャスト用のキューにプッシュします。

<?php
    namespace App\Broadcasting;
    use App\User;use App\Order;
    class OrderChannel{   
     /**
     * 创建一个新的频道实例。
     *
     * @return void
     */ 
     public function __construct()  
       {     
          //  
        }   
     /**
     * 认证用户的频道访问权限。
     *
     * @param  \App\User  $user
     * @param  \App\Order  $order
     * @return array|bool
     */    
    public function join(User $user, Order $order) 
       {     
          return $user->id === $order->user_id;  
        }
   }

# #他の人にのみブロードキャストする

イベント ブロードキャストを使用するアプリケーションを作成する場合は、event の代わりに broadcast 関数を使用できます。 event 関数と同様に、broadcast 関数はサーバー側のリスナーにイベントを配布します。

event(new ShippingStatusUpdated($update));

ただし、broadcast 関数を使用すると、次のこともできます。現在のユーザーをブロードキャスト受信者から除外する toOthers メソッド:

broadcast(new ShippingStatusUpdated($update));

toOthers メソッドをいつ使用するかをよりよく理解するために、タスク リスト アプリケーションがあると仮定します。 , ユーザーはタスク名を入力して新しいタスクを作成できます。新しいタスクを作成するには、アプリケーションは /task ルートにリクエストを行う必要があります。これにより、タスクの作成がブロードキャストされ、新しいタスクに対する JSON 応答が返されます。 JavaScript アプリケーションがルートから応答を受け取ると、次のように新しいタスクをタスク リストに直接挿入します。

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

ただし、タスクの作成もブロードキャストすることを忘れないでください。 JavaScript アプリケーションがタスク リストにタスクを追加するためにこのイベントをリッスンしている場合、タスク リストには重複したタスクが存在します。1 つはルート応答から、もう 1 つはブロードキャストからです。この問題は、toOthers メソッドを使用して現在のユーザーにイベントをブロードキャストしないようにブロードキャスターに指示することで解決できます。

{注} toOthers メソッドを呼び出すには、イベントで Illuminate\Broadcasting\InteractsWithSockets トレイトを使用する必要があります。

設定

Laravel Echo インスタンスを初期化すると、ソケット ID が接続に割り当てられます。 Vue と Axios を使用する場合、このソケット ID は、すべての発信リクエストの XX-Socket-ID ヘッダー中央に自動的に追加されます。次に、toOthers メソッドを呼び出すと、Laravel はリクエストヘッダーからソケット ID を取り出し、このソケット ID を持つ接続にメッセージをブロードキャストしないようにブロードキャスターに指示します。

Vue と Axios を使用していない場合は、X-Socket-ID リクエスト ヘッダーを送信するように JavaScript アプリケーションを手動で構成する必要があります。 Echo.socketId メソッドを使用してソケット ID を取得できます:

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

#Receive Broadcast

# ＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃

Laravel Echo のインストール

Laravel Echo は JavaScript ライブラリであり、このライブラリを使用すると、チャンネルに登録したり、Laravel によってブロードキャストされるイベントを聞いたりすることが非常に簡単になります。 Echo は、NPM パッケージ マネージャーを通じてインストールできます。この場合、Pusher ブロードキャスターを使用するため、pusher-js パッケージもインストールします。

var socketId = Echo.socketId();

Echo をインストールした後、新しい Echo インスタンスを作成できます。これを行う理想的な場所は、Laravel フレームワークに付属する resources/js/bootstrap.js ファイルの下部です。

npm install --save laravel-echo pusher-js

When you use pusherコネクタを使用して Echo インスタンスを作成する場合、cluster と接続を暗号化する必要があるかどうかを指定することもできます:

import Echo from "laravel-echo"
window.Echo = new Echo({
    broadcaster: 'pusher',
    key: 'your-pusher-key'
  });

既存のクライアント インスタンスを使用する

Echo で使用したい Pusher または Socket.io クライアント インスタンスがすでにある場合は、client 設定オプションを介して Echo に渡すことができます:

window.Echo = new Echo({
    broadcaster: 'pusher',
    key: 'your-pusher-key',
    cluster: 'eu',
    encrypted: true
 });

イベントをリッスンする

Echo をインストールしてインスタンス化した後、イベント ブロードキャストのリッスンを開始できます。まず、channel メソッドを使用してチャネル インスタンスを取得し、次に listen メソッドを呼び出して指定されたイベントをリッスンします。プライベート チャネルでのイベントの場合は、

private

メソッドを使用してください。 listen メソッドを連鎖することで、単一のチャネルで複数のイベントをリッスンできます:

const client = require('pusher-js');
window.Echo = new Echo({
    broadcaster: 'pusher',
    key: 'your-pusher-key',
    client: client
 });

チャンネルを離れるには、Echo インスタンスで

leaveChannel

メソッドを呼び出します。

Echo.channel('orders') 
   .listen('OrderShipped', (e) => {
        console.log(e.order.name);  
   });

プライベート チャネルとオンライン チャネルを離れる場合は、次のように呼び出します。

Leave

メソッド:

Echo.private('orders') 
   .listen(...)    
   .listen(...)    
   .listen(...);

上記の例でお気づきかもしれませんが、 , イベント クラスの完全な名前空間を指定しませんでした。これは、Echo がデフォルトでイベントを

App\Events

名前空間に置くためです。ただし、#namespace 構成アイテムを渡して、Echo をインスタンス化するときにルート名前空間を指定できます。

Echo.leaveChannel('orders');

さらに、Echo を使用してイベントをサブスクライブするときに、イベント クラスに # を追加できます。 ##. プレフィックス。これにより、完全修飾クラス名を指定できます:

Echo.leave('orders');

##プレゼンス チャネル

プレゼンス チャネルはプライベート IT 上に構築されます。はチャネルのセキュリティに基づいて構築されており、誰がチャネルに登録しているかを知るという追加機能を提供します。これにより、1 人のユーザーがページを閲覧しているときに、同じページを閲覧している他のユーザーに通知するなど、強力な共同アプリケーションを構築することが非常に簡単になります。

承認されたプレゼンス チャネル

すべてのプレゼンス チャネルはプライベート チャネルでもあるため、ユーザーは にアクセスする前に 承認される必要があります。ただし、プレゼンス チャネルの承認コールバック関数を定義する場合、ユーザーがチャネルに参加している場合、true は返されず、ユーザーに関する情報の配列が返される必要があります。

認可コールバック関数によって返されたデータは、JavaScript アプリケーションのプレゼンス チャネル イベント リスナーによって使用できます。ユーザーがプレゼンス チャネルに参加する権限を持たない場合は、false または null:

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

# を返す必要があります。 #プレゼンス チャネルに参加する

Echo の

join メソッドを使用してプレゼンス チャネルに参加できます。 join メソッドは、PresenceChannel を実装するオブジェクトを返します。これにより、listen## を公開することで、here と joining# にサブスクライブできるようになります。 # メソッド。 ## および leaving イベント。

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

here

コールバック関数は、チャネルに正常に参加し、現在チャネルに登録している他のすべてのユーザーを含むユーザー情報の配列を受け取った直後に実行されます。

joining メソッドは、新しいユーザーがチャンネルに参加するときに実行され、leaving メソッドはユーザーがチャンネルから退出するときに実行されます。
#プレゼンス チャネルへのブロードキャスト

NewMessage

イベントをチャット ルームのプレゼンス チャネルにブロードキャストすることができます。これを実装するには、イベントの

broadcastOn

メソッドから PresenceChannel インスタンスを返します。

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

パブリック イベントやプライベート イベントと同様に、プレゼンス チャネル イベントも使用できます broadcast ブロードキャストする関数。同様に、

toOthers

メソッドを使用して現在のユーザーをブロードキャスト レシーバーから除外することもできます。

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

Echo の listen メソッドを通じて参加イベントを聞くことができます :

/**
 * 获得事件广播的频道。
 *
 * @return Channel|array
 */
 public function broadcastOn(){
     return new PresenceChannel('room.'.$this->message->room_id);
   }

クライアント側イベント

{注} Pusher を使用する場合、クライアント側イベントを送信したい場合は、「クライアント側イベント」を有効にするために「」セクションを設定する必要があります。イベント」オプション。

Laravel アプリケーションに通知せずに、接続されている他のクライアントにイベントをブロードキャストしたい場合があります。これは、別のユーザーが特定の画面に情報を入力していることをアプリのユーザーに警告するなど、「入力中」の通知を処理する場合に特に便利です。

Echo の

whisper

メソッドを使用してクライアント イベントをブロードキャストできます:

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

listenForWhisper

メソッドを使用してクライアント イベントをリッスンできます:

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

##メッセージ通知 イベント ブロードキャストとメッセージ通知を組み合わせることで、JavaScript アプリケーションはページを更新して新しいメッセージ通知を受信できます。 。これを行う前に、ブロードキャスト通知チャネルの使用方法に関するドキュメントを必ず読んでください。

ブロードキャスト チャネルを使用してメッセージ通知を構成した後、Echo の

notification

メソッドを使用してブロードキャスト イベントをリッスンできます。チャネル名は、メッセージ通知を受信するエンティティのクラス名と一致する必要があることに注意してください:

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

この例では、App\User

に送信されるすべてのメッセージは、

ブロードキャスト経由で送信されます。 チャネル インスタンスのメッセージ通知はコールバックで受信されます。 App.User.{id} チャネルの承認コールバック関数は、Laravel フレームワークの組み込み BroadcastServiceProvider に含まれています。 この記事は、LearnKu.com

Web サイトで初めて公開されました。