定義廣播事件

要告知 Laravel 一個給定的事件需要廣播，只需要在事件類別中實作 Illuminate\Contracts\Broadcasting\ShouldBroadcast 介面即可。這個介面已被匯入到所有由框架產生的事件類別中，所以你可以很方便地將它新增到你自己的事件中。

ShouldBroadcast 介面要求你實作一個方法： broadcastOn 。此方法傳回一個頻道或一個頻道數組，事件會被廣播到這些頻道。這些頻道必須是 Channel 、PrivateChannel 或 PresenceChannel 的實例。 Channel 代表任何使用者都可以訂閱的公開頻道， 而PrivateChannels 和PresenceChannels 則代表需要頻道授權 的私人頻道：

<?php
    namespace App\Events;
    use Illuminate\Broadcasting\Channel;
    use Illuminate\Queue\SerializesModels;
    use Illuminate\Broadcasting\PrivateChannel;
    use Illuminate\Broadcasting\PresenceChannel;
    use Illuminate\Broadcasting\InteractsWithSockets;
    use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
    class ServerCreated implements ShouldBroadcast{ 
       use SerializesModels;    
       public $user;  
     /**
     * 创建一个新的事件实例。
     *
     * @return void
     */ 
      public function __construct(User $user) 
         {      
             $this->user = $user; 
         }   
      /**
     *获得事件广播的频道。
     *
     * @return Channel|array
     */   
   public function broadcastOn()  
     {     
        return new PrivateChannel('user.'.$this->user->id);   
      }
 }

然後，你只需要像你平常那樣觸發事件。一旦事件被觸發，一個 佇列任務 會自動廣播事件到你指定的廣播驅動程式。

廣播名稱

Laravel 預設會使用事件的類別名稱作為廣播名稱來廣播事件。不過，你也可以在事件類別中定義一個broadcastAs 方法來自訂廣播名稱：

/**
 * 事件的广播名称。
 *
 * @return string
 */
 public function broadcastAs(){
     return 'server.created';
  }

如果你使用了broadcastAs 方法來自訂廣播名稱，你應當確保在你註冊監聽器時加上一個. 的前綴。這將指示Echo 不要在事件之前新增應用程式的命名空間：

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

廣播資料

當一個當事件被廣播時，其所有的public 屬性都會自動序列化並作為事件有效載荷進行廣播，這允許你在JavaScript 應用程式中存取到事件所有的公有資料。舉個例子，如果你的事件有一個單獨的包含了一個Eloquent 模型的公有$user 屬性，那麼事件的廣播有效載荷將會是：

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

不過，如果你想更細緻地控制你的廣播有效載荷，你可以在你的事件中添加一個broadcastWith 方法。這個方法會回傳一個你想要作為事件有效載荷進行廣播的資料數組：

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

廣播佇列

預設情況下，每個廣播事件都會被推送到在 queue.php 設定檔中指定的預設佇列連接對應的預設佇列中。你可以在事件類別中定義一個 broadcastQueue 屬性來自訂廣播器所使用的佇列。這個屬性需要你指定廣播時你想要用的佇列名稱：

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

如果你想使用sync 佇列而不是預設佇列驅動程式來廣播事件，你可以實作ShouldBroadcastNow 介面而不是ShouldBroadcast ：

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

廣播條件

有時，你想在給定條件為true 的情況下才廣播你的事件。你可以透過在事件類別中新增一個broadcastWhen 方法來定義這些條件：

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

Laravel Echo 時，授權訂閱私有頻道的 HTTP 請求會自動傳送；儘管如此，你仍需定義對應的路由來回應這些要求。

BroadcastServiceProvider 中，你可以看到對 Broadcast::routes 方法的呼叫。此方法會註冊/broadcasting/auth 路由來處理授權請求：

Broadcast::routes();

Broadcast::routes 方法會自動將它的路由置入web 中間件組中；不過，如果你想自訂指定的屬性，你可以向該方法傳遞一個路由屬性數組：

Broadcast::routes($attributes);

/broadcasting/auth 端點來授權頻道存取。但是，您可以透過將 authEndpoint 設定選項傳遞給 Echo 實例來指定自己的授權端點：

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

定義授權回呼

接下來，我們需要定義真正用來處理頻道授權的邏輯。邏輯在應用程式自帶的 routes/channels.php 檔案中完成。在這個檔案中，你可以使用Broadcast::channel 方法來註冊頻道授權回呼：

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

channel 方法接收兩個參數：頻道名稱和一個回調函數，該回呼透過傳回true 或false 來表示使用者是否被授權監聽該頻道。

所有的授權回呼接收目前認證使用者作為第一個參數，任何額外的通配符參數作為後續參數。在本例中，我們使用 {orderId} 佔位符來表示頻道名稱的 “ID” 部分是萬用字元。

授權回呼模型綁定

就像 HTTP 路由一樣，頻道路由也可以利用明確或隱含 路由模型綁定 。例如，你可以請求接收一個真正的Order 模型實例，而不是字串或數字類型的order 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']])

routes/channels.php 檔案可能會變得很龐大。所以，你可以使用頻道類別來取代使用閉包授權頻道。若要產生頻道類，請使用 make:channel Artisan 指令。指令會在 App/Broadcasting 目錄中放置一個新的頻道類別。

php artisan make:channel OrderChannel

routes/channels.php 檔案中註冊你的頻道：

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

join 方法中。該 join 方法將保存你通常放置在頻道授權閉包中的相同邏輯。當然，你也可以利用頻道模型綁定：

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

{注} 就像 Laravel 中的許多其它類，頻道類會透過 服務容器 自動解析。因此，你可以在頻道類別的建構函式中對其進行所需依賴項的型別提示。

event(new ShippingStatusUpdated($update));

broadcast(new ShippingStatusUpdated($update));

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

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

var socketId = Echo.socketId();

npm install --save laravel-echo pusher-js

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

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

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

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

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

Echo.leaveChannel('orders');

Echo.leave('orders');

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

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

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

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

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

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

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

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

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

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