Laravel Reverb
介绍
Laravel Reverb将超快且可扩展的实时 WebSocket 通信直接带入您的 Laravel 应用程序,并与 Laravel 现有的事件广播工具套件无缝集成。
安装
您可以使用 Artisan 命令安装 Reverb install:broadcasting
:
1php artisan install:broadcasting
配置
在后台,install:broadcasting
Artisan 命令会运行以下reverb:install
命令,使用一组合理的默认配置选项来安装 Reverb。如果您需要更改任何配置,可以通过更新 Reverb 的环境变量或config/reverb.php
配置文件来实现。
应用程序凭证
为了与 Reverb 建立连接,必须在客户端和服务器之间交换一组 Reverb“应用程序”凭据。这些凭据在服务器上配置,用于验证来自客户端的请求。您可以使用以下环境变量定义这些凭据:
1REVERB_APP_ID=my-app-id2REVERB_APP_KEY=my-app-key3REVERB_APP_SECRET=my-app-secret
允许的来源
您还可以通过更新配置文件中相应部分allowed_origins
中的配置值来定义客户端请求的来源。任何来自未列入允许来源列表的来源的请求都将被拒绝。您可以使用以下命令允许所有来源:apps
config/reverb.php
*
1'apps' => [2 [3 'app_id' => 'my-app-id',4 'allowed_origins' => ['laravel.com'],5 // ...6 ]7]
其他应用
通常,Reverb 会为安装它的应用程序提供一个 WebSocket 服务器。但是,一个 Reverb 安装也可以为多个应用程序提供服务。
例如,你可能希望维护一个 Laravel 应用程序,并通过 Reverb 为多个应用程序提供 WebSocket 连接。这可以通过apps
在应用程序的config/reverb.php
配置文件中定义多个来实现:
1'apps' => [ 2 [ 3 'app_id' => 'my-app-one', 4 // ... 5 ], 6 [ 7 'app_id' => 'my-app-two', 8 // ... 9 ],10],
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"
由于 Herd 和 Valet 域名解析为localhost
,运行上述命令将导致您的 Reverb 服务器可通过安全 WebSocket 协议 ( wss
)访问wss://laravel.test:8080
。
tls
您也可以通过在应用程序的配置文件中定义选项来手动选择证书config/reverb.php
。在选项数组中,您可以提供PHP SSL 上下文选项tls
支持的任何选项:
1'options' => [2 'tls' => [3 'local_cert' => '/path/to/cert.pem'4 ],5],
运行服务器
可以使用 Artisan 命令启动 Reverb 服务器reverb:start
:
1php artisan reverb:start
默认情况下,Reverb 服务器将在 启动0.0.0.0:8080
,从而可以从所有网络接口访问它。
如果您需要指定自定义主机或端口,您可以在启动服务器时通过--host
和选项进行指定:--port
1php artisan reverb:start --host=127.0.0.1 --port=9000
或者,您可以在应用程序的配置文件中定义REVERB_SERVER_HOST
环境变量。REVERB_SERVER_PORT
.env
请勿将REVERB_SERVER_HOST
和环境变量与和混淆。前者指定运行 Reverb 服务器本身的主机和端口,而后者指示 Laravel 将广播消息发送到何处。例如,在生产环境中,您可以将来自公共 Reverb 主机名 上的端口 的请求路由到在 上运行的 Reverb 服务器。在这种情况下,您的环境变量应定义如下:REVERB_SERVER_PORT
REVERB_HOST
REVERB_PORT
443
0.0.0.0:8080
1REVERB_SERVER_HOST=0.0.0.02REVERB_SERVER_PORT=80803 4REVERB_HOST=ws.laravel.com5REVERB_PORT=443
调试
为了提高性能,Reverb 默认不输出任何调试信息。如果您想查看流经 Reverb 服务器的数据流,可以--debug
在reverb:start
命令中添加以下选项:
1php artisan reverb:start --debug
重启
由于 Reverb 是一个长期运行的过程,如果不通过 Artisan 命令重新启动服务器,代码的更改将不会反映出来reverb:restart
。
该reverb:restart
命令确保在停止服务器之前正常终止所有连接。如果您使用进程管理器(例如 Supervisor)运行 Reverb,则所有连接终止后,进程管理器将自动重启服务器:
1php 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],
接下来,将每个记录器的 Pulse 卡添加到您的Pulse 仪表板:
1<x-pulse>2 <livewire:reverb.connections cols="full" />3 <livewire:reverb.messages cols="full" />4 ...5</x-pulse>
连接Events通过定期轮询更新来记录。为了确保这些信息在 Pulse 仪表板上正确呈现,您必须在 Reverb 服务器上运行守护程序。如果您在水平扩展pulse:check
配置中运行 Reverb ,则应仅在其中一台服务器上运行此守护程序。
在生产中运行Reverb
由于 WebSocket 服务器的长期运行特性,您可能需要对服务器和托管环境进行一些优化,以确保您的 Reverb 服务器能够有效地处理服务器上可用资源的最佳连接数。
如果您的网站由Laravel Forge 管理,您可以直接从“应用程序”面板自动优化服务器以支持 Reverb。启用 Reverb 集成后,Forge 将确保您的服务器已准备好投入生产,包括安装所有必要的扩展程序并增加允许的连接数。
打开文件
每个 WebSocket 连接都会保留在内存中,直到客户端或服务器断开连接。在 Unix 和类 Unix 环境中,每个连接都由一个文件表示。然而,操作系统和应用程序级别通常对允许打开的文件数量有限制。
操作系统
在基于 Unix 的操作系统上,您可以使用以下ulimit
命令确定允许打开的文件数:
1ulimit -n
此命令将显示不同用户允许的打开文件数限制。您可以通过编辑/etc/security/limits.conf
文件来更新这些值。例如,将用户的最大打开文件数更新为 10,000,forge
如下所示:
1# /etc/security/limits.conf2forge soft nofile 100003forge hard nofile 10000
事件循环
在底层,Reverb 使用 ReactPHP 事件循环来管理服务器上的 WebSocket 连接。默认情况下,此事件循环由 提供支持stream_select
,无需任何额外扩展。但是,stream_select
通常限制打开 1,024 个文件。因此,如果您计划处理超过 1,000 个并发连接,则需要使用不受相同限制的替代事件循环。
Reverb会在可用时自动切换到ext-uv
有源循环。此 PHP 扩展可通过 PECL 安装:
1pecl 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}
Reverb 监听 WebSocket 连接,/app
并处理 API 请求/apps
。您应该确保处理 Reverb 请求的 Web 服务器能够同时处理这两个 URI。如果您使用Laravel Forge管理服务器,则您的 Reverb 服务器将默认配置正确。
通常,Web 服务器会配置为限制允许的连接数,以防止服务器过载。要将 Nginx Web 服务器上允许的连接数增加到 10,000,应更新该文件的worker_rlimit_nofile
和值:worker_connections
nginx.conf
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}
上述配置将允许每个进程最多创建 10,000 个 Nginx 工作进程。此外,此配置还将 Nginx 的打开文件数量限制设置为 10,000。
端口
Unix 操作系统通常会限制服务器上可打开的端口数量。您可以通过以下命令查看当前允许的范围:
1cat /proc/sys/net/ipv4/ip_local_port_range2# 32768 60999
上面的输出显示,由于每个连接都需要一个空闲端口,服务器最多可以处理 28,231 个连接(60,999 - 32,768)。虽然我们建议通过水平扩展来增加允许的连接数,但您也可以通过更新服务器配置文件中允许的端口范围来增加可用的开放端口数/etc/sysctl.conf
。
Processes管理
在大多数情况下,您应该使用进程管理器(例如 Supervisor)来确保 Reverb 服务器持续运行。如果您使用 Supervisor 运行 Reverb,则应更新minfds
服务器supervisor.conf
文件的设置,以确保 Supervisor 能够打开处理与 Reverb 服务器连接所需的文件:
1[supervisord]2...3minfds=10000
缩放
如果您需要处理的连接数超出单个服务器的容量,您可以水平扩展 Reverb 服务器。利用 Redis 的发布/订阅功能,Reverb 能够管理跨多个服务器的连接。当您应用程序的某个 Reverb 服务器收到消息时,该服务器将使用 Redis 将传入消息发布到所有其他服务器。
要启用水平扩展,您应该在应用程序的配置文件中将REVERB_SCALING_ENABLED
环境变量设置为:true
.env
1REVERB_SCALING_ENABLED=true
接下来,您应该拥有一个专用的中央 Redis 服务器,所有 Reverb 服务器都将与其通信。Reverb 将使用为您的应用程序配置的默认 Redis 连接向所有 Reverb 服务器发布消息。
启用 Reverb 的扩展选项并配置 Redis 服务器后,您只需reverb:start
在多台能够与 Redis 服务器通信的服务器上调用该命令即可。这些 Reverb 服务器应放置在负载均衡器之后,该负载均衡器会在服务器之间均匀分配传入请求。