如何使用Laravel的活动广播？

设置广播驱动并安装Pusher包，配置.env文件中的凭证；2. 在RouteServiceProvider中启用Broadcast::routes()以启用广播路由；3. 创建实现ShouldBroadcast接口的事件类，定义broadcastOn、broadcastAs和broadcastWith方法；4. 在routes/channels.php中定义私有频道的授权逻辑；5. 在控制器中通过event()或dispatch()分发事件；6. 前端使用Laravel Echo连接Pusher并监听指定频道的事件，实现客户端实时更新。完整流程确保事件从后端安全广播到前端，适用于实时通知、聊天等场景。

Event broadcasting in Laravel allows you to broadcast events from your server to client-side applications in real time, typically using WebSockets. This is useful for features like live notifications, chat systems, or real-time dashboards. Laravel makes this easy with its event broadcasting system, often used with tools like Pusher, Redis, and Laravel Echo.

Here’s how to use event broadcasting in Laravel:

1. Set Up Broadcasting Driver

First, choose a broadcasting driver. The most common is Pusher, but Laravel also supports Redis and others.

• Install the required package:

  composer require pusher/pusher-php-server

• In .env, set your broadcasting driver and credentials:

  

  BROADCAST_DRIVER=pusher

PUSHER_APP_ID=your_app_id PUSHER_APP_KEY=your_app_key PUSHER_APP_SECRET=your_app_secret PUSHER_APP_CLUSTER=mt1

- Make sure `config/broadcasting.php` is set to use Pusher (default when configured).

---

### 2. **Enable Broadcasting in RouteServiceProvider**

Laravel disables broadcasting routes by default. You need to uncomment the `Broadcast::routes()` line in `App\Providers\RouteServiceProvider` within the `boot` method:

```php
use Illuminate\Support\Facades\Broadcast;

public function boot()
{
    Broadcast::routes();
    // ...
}

This enables the /broadcasting/auth route for private channels.

3. Create a Broadcastable Event

Generate an event using Artisan:

php artisan make:event NewMessageSent

In your event class (NewMessageSent.php), implement ShouldBroadcast to make it broadcastable:

<?php

namespace App\Events;

use Illuminate\Broadcasting\Channel;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Broadcasting\PresenceChannel;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class NewMessageSent implements ShouldBroadcast
{
    use Dispatchable, InteractsWithSockets, SerializesModels;

    public $message;

    public function __construct($message)
    {
        $this->message = $message;
    }

    public function broadcastOn()
    {
        return new PrivateChannel('chat.' . $this->message->chat_id);
    }

    public function broadcastAs()
    {
        return 'message.sent';
    }

    public function broadcastWith()
    {
        return ['message' => $this->message->content];
    }
}

• broadcastOn(): Defines the channel (public, private, or presence).
• broadcastAs(): Optional custom event name.
• broadcastWith(): Customize data sent to clients.

Use PrivateChannel or PresenceChannel if you need authorization.

4. Authorize Private Channels (if needed)

For private channels like chat.1, Laravel requires authorization. Define the authorization logic in routes/channels.php:

use Illuminate\Support\Facades\Broadcast;

Broadcast::channel('chat.{chatId}', function ($user, $chatId) {
    // Return true if the user can access this chat
    return $user->chats->contains('id', $chatId);
});

This ensures only authorized users receive events on that channel.

5. Dispatch the Event in Your Controller

use App\Events\NewMessageSent;

// Inside a controller method
event(new NewMessageSent($message));
// Or
NewMessageSent::dispatch($message);

When dispatched, Laravel broadcasts the event to the specified channel.

6. Listen on the Client Side with Laravel Echo

Install Laravel Echo and Pusher JS in your frontend:

npm install --save laravel-echo pusher-js

Initialize Laravel Echo in your JS (e.g., resources/js/bootstrap.js):

import Echo from 'laravel-echo';

window.Pusher = require('pusher-js');

window.Echo = new Echo({
    broadcaster: 'pusher',
    key: process.env.MIX_PUSHER_APP_KEY,
    cluster: process.env.MIX_PUSHER_APP_CLUSTER,
    encrypted: true,
    authEndpoint: '/broadcasting/auth',
    auth: {
        headers: {
            Authorization: 'Bearer '   localStorage.getItem('token'), // if using API auth
        },
    },
});

Make sure to expose the Pusher key in .env:

MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

Then, listen for the event:

Echo.private(`chat.1`)
    .listen('message.sent', (e) => {
        console.log(e.message);
    });

If you didn’t use broadcastAs(), use the full event class name:

.listen('.App.Events.NewMessageSent', (e) => { ... })

Summary of Key Steps

• ✅ Set BROADCAST_DRIVER and credentials
• ✅ Run Broadcast::routes() in RouteServiceProvider
• ✅ Create event implementing ShouldBroadcast
• ✅ Define channel and optional auth in routes/channels.php
• ✅ Dispatch event from backend
• ✅ Use Laravel Echo on frontend to listen

Using event broadcasting in Laravel isn’t complicated once you’ve set up the driver and understood the flow. It works great with Vue/React apps and APIs, especially when combined with Sanctum for SPA authentication.

Basically, just make the event broadcastable, secure the channel if needed, and listen on the frontend.

以上是如何使用Laravel的活动广播？的详细内容。更多信息请关注PHP中文网其他相关文章！