Laravel 13.x 中文文档

主题

Laravel Reverb ​

简介 ​

Laravel Reverb 直接为您的 Laravel 应用程序带来快速且可扩展的实时 WebSocket 通信，并与 Laravel 现有的事件广播工具套件无缝集成。

安装 ​

您可以使用 install:broadcasting Artisan 命令安装 Reverb：

shell
php artisan install:broadcasting

配置 ​

在幕后，install:broadcasting Artisan 命令将运行 reverb:install 命令，该命令将使用一套合理的默认配置选项安装 Reverb。如果您想进行任何配置更改，可以通过更新 Reverb 的环境变量或更新 config/reverb.php 配置文件来完成。

应用程序凭据 ​

为了建立与 Reverb 的连接，必须在客户端和服务器之间交换一组 Reverb"应用程序"凭据。这些凭据在服务器上配置，用于验证来自客户端的请求。您可以使用以下环境变量定义这些凭据：

ini
REVERB_APP_ID=my-app-id
REVERB_APP_KEY=my-app-key
REVERB_APP_SECRET=my-app-secret

允许的来源 ​

您还可以通过更新 config/reverb.php 配置文件中 apps 部分的 allowed_origins 配置值来定义客户端请求可能来自的来源。任何来自未在允许来源中列出的来源的请求将被拒绝。您可以使用 * 允许所有来源：

php
'apps' => [
    [
        'app_id' => 'my-app-id',
        'allowed_origins' => ['laravel.com'],
        // ...
    ]
]

其他应用程序 ​

通常，Reverb 为安装它的应用程序提供 WebSocket 服务器。但是，可以使用单个 Reverb 安装为多个应用程序提供服务。

例如，您可能希望维护单个 Laravel 应用程序，该应用程序通过 Reverb 为多个应用程序提供 WebSocket 连接。这可以通过在应用程序的 config/reverb.php 配置文件中定义多个 apps 来实现：

php
'apps' => [
    [
        'app_id' => 'my-app-one',
        // ...
    ],
    [
        'app_id' => 'my-app-two',
        // ...
    ],
],

SSL ​

在大多数情况下，安全 WebSocket 连接由上游 Web 服务器（Nginx 等）处理，然后再将请求代理到您的 Reverb 服务器。

但是，有时让 Reverb 服务器直接处理安全连接可能很有用，例如在本地开发期间。如果您使用 Laravel Herd 的安全站点功能，或者您使用 Laravel Valet 并已对您的应用程序运行 secure 命令，您可以使用为您的站点生成的 Herd / Valet 证书来保护您的 Reverb 连接。为此，将 REVERB_HOST 环境变量设置为您的站点主机名，或在启动 Reverb 服务器时显式传递主机名选项：

shell
php artisan reverb:start --host="0.0.0.0" --port=8080 --hostname="laravel.test"

由于 Herd 和 Valet 域解析为 localhost，运行上述命令将使您的 Reverb 服务器可通过安全 WebSocket 协议（wss）在 wss://laravel.test:8080 访问。

您还可以通过在应用程序的 config/reverb.php 配置文件中定义 tls 选项来手动选择证书。在 tls 选项数组中，您可以提供 PHP SSL 上下文选项支持的任何选项：

php
'options' => [
    'tls' => [
        'local_cert' => '/path/to/cert.pem'
    ],
],

运行服务器 ​

可以使用 reverb:start Artisan 命令启动 Reverb 服务器：

shell
php artisan reverb:start

默认情况下，Reverb 服务器将在 0.0.0.0:8080 启动，使其可从所有网络接口访问。

如果您需要指定自定义主机或端口，可以在启动服务器时通过 --host 和 --port 选项进行：

shell
php artisan reverb:start --host=127.0.0.1 --port=9000

或者，您可以在应用程序的 .env 配置文件中定义 REVERB_SERVER_HOST 和 REVERB_SERVER_PORT 环境变量。

REVERB_SERVER_HOST 和 REVERB_SERVER_PORT 环境变量不应与 REVERB_HOST 和 REVERB_PORT 混淆。前者指定运行 Reverb 服务器本身的主机和端口，而后者指示 Laravel 将广播消息发送到哪里。例如，在生产环境中，您可以将来自公共 Reverb 主机名端口 443 的请求路由到在 0.0.0.0:8080 上运行的 Reverb 服务器。在这种情况下，您的环境变量将定义如下：

ini
REVERB_SERVER_HOST=0.0.0.0
REVERB_SERVER_PORT=8080

REVERB_HOST=ws.laravel.com
REVERB_PORT=443

调试 ​

为了提高性能，Reverb 默认不输出任何调试信息。如果您想查看通过 Reverb 服务器的数据流，可以向 reverb:start 命令提供 --debug 选项：

shell
php artisan reverb:start --debug

重启 ​

由于 Reverb 是一个长时间运行的进程，代码更改不会反映，除非通过 reverb:restart Artisan 命令重启服务器。

reverb:restart 命令确保所有连接在停止服务器之前优雅终止。如果您使用进程管理器（如 Supervisor）运行 Reverb，服务器将在所有连接终止后由进程管理器自动重启：

shell
php artisan reverb:restart

监控 ​

可以通过与 Laravel Pulse 的集成来监控 Reverb。通过启用 Reverb 的 Pulse 集成，您可以跟踪服务器处理的连接数和消息数。

要启用集成，您应该首先确保已安装 Pulse。然后，将任何 Reverb 的记录器添加到应用程序的 config/pulse.php 配置文件：

php
use Laravel\Reverb\Pulse\Recorders\ReverbConnections;
use Laravel\Reverb\Pulse\Recorders\ReverbMessages;

'recorders' => [
    ReverbConnections::class => [
        'sample_rate' => 1,
    ],

    ReverbMessages::class => [
        'sample_rate' => 1,
    ],

    // ...
],

接下来，将每个记录器的 Pulse 卡添加到您的 Pulse 仪表板：

blade
<x-pulse>
    <livewire:reverb.connections cols="full" />
    <livewire:reverb.messages cols="full" />
    ...
</x-pulse>

连接活动通过定期轮询新更新来记录。为确保此信息在 Pulse 仪表板上正确呈现，您必须在 Reverb 服务器上运行 pulse:check 守护进程。如果您以水平扩展配置运行 Reverb，您应该只在其中一台服务器上运行此守护进程。

在生产环境中运行 Reverb ​

由于 WebSocket 服务器的长时间运行特性，您可能需要对服务器和托管环境进行一些优化，以确保您的 Reverb 服务器能够有效地处理服务器上可用资源的最佳连接数。

NOTE

Laravel Cloud 提供由 Laravel Reverb 集群驱动的完全托管 WebSocket 基础设施，让您无需管理基础设施即可扩展和交付启用 Reverb 的应用程序。

打开文件 ​

每个 WebSocket 连接都保存在内存中，直到客户端或服务器断开连接。在 Unix 和类 Unix 环境中，每个连接由文件表示。但是，在操作系统和应用程序级别，通常对允许的打开文件数量有限制。

操作系统 ​

在基于 Unix 的操作系统上，您可以使用 ulimit 命令确定允许的打开文件数：

shell
ulimit -n

此命令将显示不同用户允许的打开文件限制。您可以通过编辑 /etc/security/limits.conf 文件来更新这些值。例如，将 forge 用户的最大打开文件数更新为 10,000 将如下所示：

ini
# /etc/security/limits.conf
forge        soft  nofile  10000
forge        hard  nofile  10000

事件循环 ​

在底层，Reverb 使用 ReactPHP 事件循环来管理服务器上的 WebSocket 连接。默认情况下，此事件循环由 stream_select 驱动，不需要任何额外的扩展。但是，stream_select 通常限制为 1,024 个打开文件。因此，如果您计划处理超过 1,000 个并发连接，您需要使用不受相同限制的替代事件循环。

当可用时，Reverb 将自动切换到 ext-uv 驱动的循环。此 PHP 扩展可通过 PECL 安装：

shell
pecl install uv

Web 服务器 ​

在大多数情况下，Reverb 在服务器上的非面向 Web 的端口上运行。因此，为了将流量路由到 Reverb，您应该配置反向代理。假设 Reverb 在主机 0.0.0.0 和端口 8080 上运行，并且您的服务器使用 Nginx Web 服务器，可以使用以下 Nginx 站点配置为您的 Reverb 服务器定义反向代理：

nginx
server {
    ...

    location / {
        proxy_http_version 1.1;
        proxy_set_header Host $http_host;
        proxy_set_header Scheme $scheme;
        proxy_set_header SERVER_PORT $server_port;
        proxy_set_header REMOTE_ADDR $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";

        proxy_pass http://0.0.0.0:8080;
    }

    ...
}

WARNING

Reverb 在 /app 监听 WebSocket 连接，并在 /apps 处理 API 请求。您应确保处理 Reverb 请求的 Web 服务器可以同时服务这两个 URI。如果您使用 Laravel Forge 管理服务器，您的 Reverb 服务器将默认正确配置。

通常，Web 服务器配置为限制允许的连接数，以防止服务器过载。要将 Nginx Web 服务器上允许的连接数增加到 10,000，应更新 nginx.conf 文件的 worker_rlimit_nofile 和 worker_connections 值：

nginx
user forge;
worker_processes auto;
pid /run/nginx.pid;
include /etc/nginx/modules-enabled/*.conf;
worker_rlimit_nofile 10000;

events {
  worker_connections 10000;
  multi_accept on;
}

上述配置将允许每个进程生成最多 10,000 个 Nginx 工作进程。此外，此配置将 Nginx 的打开文件限制设置为 10,000。

端口 ​

基于 Unix 的操作系统通常限制服务器上可以打开的端口数。您可以通过以下命令查看当前允许的范围：

shell
cat /proc/sys/net/ipv4/ip_local_port_range
# 32768	60999

上述输出显示服务器可以处理最多 28,231 (60,999 - 32,768) 个连接，因为每个连接需要一个空闲端口。虽然我们建议通过水平扩展来增加允许的连接数，但您可以通过更新服务器 /etc/sysctl.conf 配置文件中的允许端口范围来增加可用打开端口数。

进程管理 ​

在大多数情况下，您应该使用进程管理器（如 Supervisor）来确保 Reverb 服务器持续运行。如果您使用 Supervisor 运行 Reverb，您应该更新服务器 supervisor.conf 文件的 minfds 设置，以确保 Supervisor 能够打开处理 Reverb 服务器连接所需的文件：

ini
[supervisord]
...
minfds=10000

扩展 ​

如果您需要处理单台服务器所允许的更多连接，可以水平扩展您的 Reverb 服务器。利用 Redis 的发布/订阅功能，Reverb 能够跨多个服务器管理连接。当您的应用程序的一个 Reverb 服务器收到消息时，该服务器将使用 Redis 将传入消息发布到所有其他服务器。

要启用水平扩展，您应该在应用程序的 .env 配置文件中将 REVERB_SCALING_ENABLED 环境变量设置为 true：

env
REVERB_SCALING_ENABLED=true

接下来，您应该有一个专用的中央 Redis 服务器，所有 Reverb 服务器都将与之通信。Reverb 将使用为您的应用程序配置的默认 Redis 连接向所有 Reverb 服务器发布消息。

启用 Reverb 的扩展选项并配置 Redis 服务器后，您只需在能够与您的 Redis 服务器通信的多台服务器上调用 reverb:start 命令。这些 Reverb 服务器应放置在负载均衡器后面，将传入请求均匀分配到各服务器。

事件 ​

Reverb 在连接和消息处理的生命周期内分发内部事件。您可以监听这些事件以在管理连接或交换消息时执行操作。

Reverb 分发以下事件：

Laravel\Reverb\Events\ChannelCreated ​

当创建频道时分发。这通常发生在第一个连接订阅特定频道时。事件接收 Laravel\Reverb\Protocols\Pusher\Channel 实例。

Laravel\Reverb\Events\ChannelRemoved ​

当移除频道时分发。这通常发生在最后一个连接取消订阅频道时。事件接收 Laravel\Reverb\Protocols\Pusher\Channel 实例。

Laravel\Reverb\Events\ConnectionPruned ​

当服务器修剪陈旧连接时分发。事件接收 Laravel\Reverb\Contracts\Connection 实例。

Laravel\Reverb\Events\MessageReceived ​

当从客户端连接收到消息时分发。事件接收 Laravel\Reverb\Contracts\Connection 实例和原始字符串 $message。

Laravel\Reverb\Events\MessageSent ​

当向客户端连接发送消息时分发。事件接收 Laravel\Reverb\Contracts\Connection 实例和原始字符串 $message。