介绍

Laravel Reverb (opens in a new tab) 为您的 Laravel 应用程序直接带来极速且可扩展的实时 WebSocket 通信，并与 Laravel 现有的事件广播工具 实现无缝集成。

安装

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

php artisan install:broadcasting

配置

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

应用程序凭据

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

REVERB_APP_ID=我的应用 ID
REVERB_APP_KEY=我的应用密钥
REVERB_APP_SECRET=我的应用机密

允许的源

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

'apps' => [
    [
        'id' => '我的应用 ID',
        'allowed_origins' => ['laravel.com'],
        //...
    ]
]

其他应用程序

通常，Reverb 为安装它的应用程序提供 WebSocket 服务器。然而，通过一次 Reverb 安装为多个应用程序提供服务是可能的。

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

'apps' => [
    [
        'app_id' => '我的应用一',
        //...
    ],
    [
        'app_id' => '我的应用二',
        //...
    ],
],

SSL

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

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

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 上下文选项 (opens in a new tab)支持的任何选项：

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

运行服务器

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

php artisan reverb:start

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

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

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 服务器。在这种情况下，您的环境变量将定义如下：

REVERB_SERVER_HOST=0.0.0.0
REVERB_SERVER_PORT=8080
 
REVERB_HOST=ws.laravel.com
REVERB_PORT=443

调试

为了提高性能，默认情况下 Reverb 不会输出任何调试信息。如果您希望查看通过您的 Reverb 服务器传递的数据流，可以在 reverb:start 命令中提供 --debug 选项：

php artisan reverb:start --debug

重新启动

由于 Reverb 是一个长期运行的进程，如果不通过 reverb:restart Artisan 命令重新启动服务器，您对代码的更改将不会得到反映。

reverb:restart 命令会确保在停止服务器之前，所有连接都被优雅地终止。如果您使用像 Supervisor 这样的进程管理器来运行 Reverb，在所有连接都被终止后，进程管理器会自动重新启动服务器：

php artisan reverb:restart

监控

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

要启用集成，您首先应该确保已经 安装了 Pulse。然后，将 Reverb 的任何记录器添加到应用程序的 config/pulse.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 仪表板：

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

在生产环境中运行 Reverb

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

[!NOTE]
如果您的站点由 Laravel Forge (opens in a new tab) 管理，您可以直接从“应用程序”面板为 Reverb 自动优化服务器。通过启用 Reverb 集成，Forge 将确保您的服务器为生产环境做好准备，包括安装任何所需的扩展并增加允许的连接数。

打开文件

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

操作系统

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

ulimit -n

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

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

事件循环

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

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

pecl install uv

Web 服务器

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

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 (opens in a new tab) 来管理您的服务器，您的 Reverb 服务器将默认正确配置。

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

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 的操作系统通常会限制服务器上可以打开的端口数量。您可以通过以下命令查看当前允许的范围：

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 服务器的连接所需的文件：

[supervisord]
...
minfds=10000

扩展

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

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

REVERB_SCALING_ENABLED=true

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

一旦您启用了 Reverb 的扩展选项并配置了 Redis 服务器，您可以在多个能够与您的 Redis 服务器通信的服务器上简单地调用 reverb:start 命令。这些 Reverb 服务器应该放置在一个负载均衡器后面，该负载均衡器将均匀地在服务器之间分配传入的请求。