Laravel Reverb

介绍
安装
配置
运行服务器
- 调试
- 重启
监控
在生产中运行 Reverb

介绍

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

安装

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

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 服务器时显式传递主机名选项：

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 服务器：

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

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 选项：

php artisan reverb:start --debug

重启

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

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

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 服务器能够有效处理可用资源的最佳连接数量。

注意

如果您的站点由 Laravel Forge 管理，您可以直接从“应用程序”面板自动优化您的服务器以适应 Reverb。通过启用 Reverb 集成，Forge 将确保您的服务器为生产就绪，包括安装任何所需的扩展并增加允许的连接数量。

打开文件

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

操作系统

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

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 安装：

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

    ...
}

警告

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

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：

REVERB_SCALING_ENABLED=true

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

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

Laravel Reverb ​

介绍 ​

安装 ​

配置 ​

应用凭证 ​

允许的来源 ​

附加应用 ​

SSL ​

运行服务器 ​

调试 ​

重启 ​

监控 ​

在生产中运行 Reverb ​

打开文件 ​

操作系统 ​

事件循环 ​

Web 服务器 ​

端口 ​

进程管理 ​

扩展 ​