Laravel 实时事件广播（reverb）配置指南

这是一个用于 Laravel 应用程序的实时事件广播包（使用 WebSocket）。本指南将帮助你在 Laravel 11 中配置使用 Reverb - 一个强大的 WebSocket 实时事件解决方案。

事件与广播的解释

事件: 在 Laravel 中，事件是应用程序中发生的某件事，你想要在应用程序中处理它。你可以在应用程序的任何地方在重要事件发生后触发事件，比如用户注册或下单。事件主要用于数据封装，可以被事件监听器监听或触发其他操作。

广播: 广播是通过 WebSocket 连接发送的一种事件。当事件可以广播时，这使你能够通过 WebSocket 与客户端共享实时信息。通过广播事件，可以在服务器发生变化时快速更新客户端，提供更流畅的客户端体验。

公共频道与私有频道的解释

公共频道: 这些频道是公开的，任何人都可以在不经过任何认证/授权流程的情况下监听它们。当你想广播不需要用户之间安全边界的事件时，这是一个很好的选择，例如对所有参与用户都有用的更新或通知。例如，公共频道可用于公告或系统消息。

公共频道定义示例：

Broadcast::channel('public-updates', function () {
    return true;
});

私有频道: 需要认证，用于用户特定数据。这些事件广播的频道只能被授权用户监听。当你希望某些敏感数据只能被特定查询访问时（例如用户通知等）这很有用，这些数据应该只能到达最终客户。

私有频道定义示例：

Broadcast::channel('App.User.{id}', function ($user, $id) {
    return $user->id === (int) $id;
});

步骤 1: 安装广播依赖

如果你要为新项目添加广播功能，或在现有项目中运行以下命令：

composer install
php artisan broadcast:install

这个命令会创建必要的配置和文件：

• 广播配置：位于 config/broadcasting.php
• Reverb 配置：位于 config/reverb.php
• 检查 resources/js 文件夹中新生成的 echo.js 文件—这用于管理 WebSocket 连接

步骤 2: 配置广播驱动

运行广播安装后，打开你的 .env 文件并通过添加以下配置将广播驱动设置为 Reverb：

BROADCAST_DRIVER=reverb
REVERB_APP_ID=your_app_id
REVERB_APP_KEY=your_app_key
REVERB_APP_SECRET=your_app_secret
REVERB_HOST="yourhost.test"
REVERB_PORT=8080
REVERB_SCHEME=https

VITE_REVERB_APP_KEY="${REVERB_APP_KEY}"
VITE_REVERB_HOST="${REVERB_HOST}"
VITE_REVERB_PORT="${REVERB_PORT}"
VITE_REVERB_SCHEME="${REVERB_SCHEME}"

步骤 3: 定义广播频道

在创建事件之前，你需要定义事件将广播的频道。打开 routes/channels.php 文件并添加你的频道定义：

私有频道示例：

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

私有频道如果需要sanctum鉴权:
@https://stackoverflow.com/questions/54229753/getting-403-error-when-using-private-channels-with-laravel-broadcast/78580632#78580632

//在 channel.php 路由上添加此项（如果您使用 sanctum auth）或者您可以使用您正在使用的任何其他身份验证中间件。
Broadcast::routes(['middleware' => ['auth:sanctum', 'abilities:admin']]);

公共频道示例：

Broadcast::channel('public-updates', function () {
    return true;
});

步骤 4: 创建事件类

接下来，创建将要广播的事件。运行以下命令：

php artisan make:event UserEvent

在生成的 UserEvent 类中，实现 ShouldBroadcast 接口并添加必要的导入以广播事件。

私有频道事件示例：

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\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

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

    public function __construct(public $downloadURL, public User $user)
    {
        //
    }

    public function broadcastOn(): array
    {
        return [
            new PrivateChannel("App.User." . $this->user->id),
        ];
    }

    public function broadcastWith(): array
    {
        return array(
            'username' => __('app.welcome_message', ['username' => $this->user->name]),
            'message' => __('events.download_hawb_ready'),
        );
    }

    public function broadcastAs(): string
    {
        return 'user.notification';
    }
}

公共频道事件示例：

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\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

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

    public function __construct(public $downloadURL)
    {
        //
    }

    public function broadcastOn(): array
    {
        return [
            new Channel("public-updates"),
        ];
    }

    public function broadcastWith(): array
    {
        return array(
            'message' => __('events.download_hawb_ready'),
        );
    }

    public function broadcastAs(): string
    {
        return 'public.notification';
    }
}

步骤 5: 触发事件

要广播事件，在控制器中使用 broadcast() 辅助函数：

use App\Events\UserEvent;

broadcast(new UserEvent($data));

步骤 6: 设置前端监听

现在，你需要在前端监听广播的事件。你可以使用 Laravel Echo 和 Reverb WebSocket 来实现。打开 resources/js/echo.js 文件并添加以下监听器：

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'],
});

document.addEventListener('DOMContentLoaded', function () {
    const userID = window.userID;

    window.Echo.private(`App.User.${userID}`)
        .listen('.user.notification', (response) => {
            console.log("Event received:", response);
            showNotification(response);
        });
});

步骤 7: 编译资源

设置完事件监听器后，需要编译前端资源以确保更改生效。运行以下命令：

npm run dev

步骤 8: 运行队列监听器

Laravel 中的广播是异步工作的，所以你需要运行队列监听器来处理队列中的事件：

php artisan queue:listen

步骤 9: 验证频道配置

要确保你的频道设置正确，可以运行以下命令列出所有注册的频道：

php artisan channel:list

步骤 10: 启动 Reverb

接下来，你需要启动 Reverb WebSocket 服务器：

php artisan reverb:start --host="0.0.0.0" --port=8080 --hostname="yourhost.test" --debug

步骤 11: 应用程序路由配置

确保你的应用程序路由正确配置以包含广播频道：

return Application::configure(basePath: dirname(__DIR__))
    ->withRouting(
        web: __DIR__ . '/../routes/web.php',
        commands: __DIR__ . '/../routes/console.php',
        channels: __DIR__ . '/../routes/channels.php',
        health: '/up',
    );

 

按照这些步骤，你可以成功在 Laravel 11 应用程序中设置使用 Reverb 的广播功能。完成所有设置后，你将能够实时广播事件，确保应用程序的无缝更新。别忘了检查你的配置，并使用 php artisan channel:list 命令验证你的频道设置。


postman测试:

ws连接: ws://ws.xx.com:2346/app/appid

手动授权:http://www.xxx.com/broadcasting/auth

post or get: 

Content-Type:application/json

{
  "socket_id": "105447109.191647543", 
  "channel_name": "private-client.call.user.2"
}
发送订阅消息:
ws连接窗口发送消息:
{
    "event": "pusher:subscribe",
    "data": {
        "auth": "手动授权获取的token",
        "channel": "private-client.call.user.2"
    }
}