Laravel Reverb

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

简介

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

安装

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

1php artisan install:broadcasting

php artisan install:broadcasting

配置

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

应用凭据

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

1REVERB_APP_ID=my-app-id
2REVERB_APP_KEY=my-app-key
3REVERB_APP_SECRET=my-app-secret

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

允许的来源

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

1'apps' => [
2    [
3        'app_id' => 'my-app-id',
4        'allowed_origins' => ['laravel.com'],
5        // ...
6    ]
7]

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

其他应用

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

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

 1'apps' => [
 2    [
 3        'app_id' => 'my-app-one',
 4        // ...
 5    ],
 6    [
 7        'app_id' => 'my-app-two',
 8        // ...
 9    ],
10],

'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 服务器时显式传递 hostname 选项

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

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 上下文选项支持的任何选项

1'options' => [
2    'tls' => [
3        'local_cert' => '/path/to/cert.pem'
4    ],
5],

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

运行服务器

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

1php artisan reverb:start

php artisan reverb:start

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

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

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

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 将广播消息发送到哪里。例如，在生产环境中，您可以将来自端口 443 上公共 Reverb 主机名的请求路由到在 0.0.0.0:8080 上运行的 Reverb 服务器。在这种情况下，您的环境变量将定义如下

1REVERB_SERVER_HOST=0.0.0.0
2REVERB_SERVER_PORT=8080
3 
4REVERB_HOST=ws.laravel.com
5REVERB_PORT=443

REVERB_SERVER_HOST=0.0.0.0
REVERB_SERVER_PORT=8080

REVERB_HOST=ws.laravel.com
REVERB_PORT=443

调试

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

1php artisan reverb:start --debug

php artisan reverb:start --debug

重启

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

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

1php artisan reverb:restart

php artisan reverb:restart

监控

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

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

 1use Laravel\Reverb\Pulse\Recorders\ReverbConnections;
 2use Laravel\Reverb\Pulse\Recorders\ReverbMessages;
 3 
 4'recorders' => [
 5    ReverbConnections::class => [
 6        'sample_rate' => 1,
 7    ],
 8 
 9    ReverbMessages::class => [
10        'sample_rate' => 1,
11    ],
12 
13    // ...
14],

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 仪表板

1<x-pulse>
2    <livewire:reverb.connections cols="full" />
3    <livewire:reverb.messages cols="full" />
4    ...
5</x-pulse>

<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 命令确定允许的打开文件数

1ulimit -n

ulimit -n

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

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

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

事件循环

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

Reverb 将在 ext-uv 支持的循环可用时自动切换到该循环。此 PHP 扩展程序可通过 PECL 安装

1pecl install uv

pecl install uv

Web 服务器

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

 1server {
 2    ...
 3 
 4    location / {
 5        proxy_http_version 1.1;
 6        proxy_set_header Host $http_host;
 7        proxy_set_header Scheme $scheme;
 8        proxy_set_header SERVER_PORT $server_port;
 9        proxy_set_header REMOTE_ADDR $remote_addr;
10        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
11        proxy_set_header Upgrade $http_upgrade;
12        proxy_set_header Connection "Upgrade";
13 
14        proxy_pass http://0.0.0.0:8080;
15    }
16 
17    ...
18}

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 值

 1user forge;
 2worker_processes auto;
 3pid /run/nginx.pid;
 4include /etc/nginx/modules-enabled/*.conf;
 5worker_rlimit_nofile 10000;
 6 
 7events {
 8  worker_connections 10000;
 9  multi_accept on;
10}

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

1cat /proc/sys/net/ipv4/ip_local_port_range
2# 32768    60999

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

1[supervisord]
2...
3minfds=10000

[supervisord]
...
minfds=10000

扩展

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

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

1REVERB_SCALING_ENABLED=true

REVERB_SCALING_ENABLED=true

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

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

前言

入门指南

架构概念

基础知识

深入了解

安全

数据库

Eloquent ORM

测试

软件包

Laravel Reverb

简介

安装

配置

应用凭据

允许的来源

其他应用

SSL

运行服务器

调试

重启

监控

在生产环境中运行 Reverb

打开文件

操作系统

事件循环

Web 服务器

端口

进程管理

扩展

产品

软件包

资源