后盾人

Appearance

Laravel 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' => [
    [
        '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 服务器时显式传递主机名选项:

sh
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 服务器:

sh
php artisan reverb:start

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

如果需要指定自定义主机或端口,可以在启动服务器时使用 --host 和 --port 选项:

sh
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 主机名的请求路由到在 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 选项:

sh
php artisan reverb:start --debug

重启 ​

由于 Reverb 是一个长时间运行的进程,因此不会重启服务器而不重启服务器,代码更改将不会反映出来。

reverb:restart 命令会在停止服务器之前确保所有连接都已正常终止。如果您使用 Supervisor 等进程管理器运行 Reverb,所有连接终止后,服务器将由进程管理器自动重启:

sh
php artisan reverb:restart

监控 ​

Reverb 可以通过与 Laravel Pulse 的集成来监控。启用 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>

在生产环境中运行 Reverb ​

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

NOTE

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

打开的文件 ​

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

操作系统 ​

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

sh
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 安装:

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

sh
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:

php
REVERB_SCALING_ENABLED=true

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

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

后盾人版权所有 © 2018-2024 创作不易请尊重他人劳动成果，未经授权禁止转载！