Laravel Reverb 带来了超高速且可扩展的实时 WebSocket 通信,直接集成到您的 Laravel 应用程序中,并提供与 Laravel 现有的一整套 事件广播工具 的无缝集成。
您可以使用 install:broadcasting Artisan 命令来安装 Reverb:
php artisan install:broadcasting在幕后,该 install:broadcasting Artisan 命令将运行该 reverb:install 命令,该命令将安装 Reverb 并带有一组合理的默认配置选项。如果您想进行任何配置更改,可以通过更新 Reverb 的环境变量或更新 config/reverb.php 配置文件来完成。
为了建立与 Reverb 的连接,必须在客户端和服务器之间交换一组 Reverb "应用程序" 凭据。这些凭据在服务器上配置,并用于验证来自客户端的请求。您可以使用以下环境变量定义这些凭据:
REVERB_APP_ID=my-app-id
REVERB_APP_KEY=my-app-key
REVERB_APP_SECRET=my-app-secret您还可以通过更新 config/reverb.php 配置文件中 apps 部分下的 allowed_origins 配置值来定义客户端请求的来源. 任何来自未在您允许的来源中列出的源的请求都将被拒绝. 您可以使用 * 来允许所有来源:
'apps' => [
[
'app_id' => 'my-app-id',
'allowed_origins' => ['laravel.com'],
// ...
]
]通常,Reverb 为其安装所在的应用程序提供一个 WebSocket 服务器。然而,可以使用单个 Reverb 安装来服务多个应用程序。
例如,您可能希望维护一个 Laravel 应用程序,通过 Reverb,为多个应用程序提供 WebSocket 连接。这可以通过在您的应用程序的 config/reverb.php 配置文件中定义多个 apps 来实现:
'apps' => [
[
'app_id' => 'my-app-one',
// ...
],
[
'app_id' => 'my-app-two',
// ...
],
],大多数情况下,安全 WebSocket 连接由上游 Web 服务器(Nginx 等)处理,然后请求才被代理到你的 Reverb 服务器。
然而,有时让 Reverb 服务器直接处理安全连接会很有用,例如在本地开发期间。如果您正在使用 Laravel Herd 的安全站点功能,或者您正在使用 Laravel Valet 并已对您的应用程序运行 secure 命令,您可以使用为您的站点生成的 Herd / Valet 证书来保护您的 Reverb 连接。为此,请将 REVERB_HOST 环境变量设置为您站点的域名,或者在启动 Reverb 服务器时显式传递 hostname 选项:
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 上下文选项 支持的任何选项:
'options' => [
'tls' => [
'local_cert' => '/path/to/cert.pem'
],
],Reverb 服务器可以通过 reverb:start Artisan 命令启动:
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 将广播消息发送到何处。例如,在生产环境中,您可能将来自端口 443 上的公共 Reverb 主机名的请求路由到在 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:restartReverb 可以通过与 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>连接活动通过定期轮询新的更新来记录。为确保此信息在 Pulse 仪表板上正确显示,您必须在 Reverb 服务器上运行 pulse:check 守护程序。如果您在 水平扩展 配置中运行 Reverb,您应只在您的其中一台服务器上运行此守护程序。
由于 WebSocket 服务器的长期运行特性,您可能需要对服务器和托管环境进行一些优化,以确保您的 Reverb 服务器能够有效处理其可用资源所能支持的最佳连接数。
[!NOTE]
如果您的网站由 Laravel Forge 管理,您可以直接从“Application”面板自动优化您的服务器以支持 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 通常限制为 1,024 个打开的文件。因此,如果你计划处理超过 1,000 个并发连接,你将需要使用一个不受相同限制的替代事件循环。
Reverb 将在可用时自动切换到 ext-uv 驱动的循环。这个 PHP 扩展可以通过 PECL 安装:
pecl install uv在大多数情况下,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;
}
...
}[!警告]
Reverb 监听 WebSocket 连接,路径为/app,并处理 API 请求,路径为/apps。你应确保处理 Reverb 请求的 Web 服务器可以提供这两个 URI 的服务。如果你使用 Laravel Forge 来管理你的服务器,你的 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 将接收到的消息发布到所有其他服务器。
要启用水平扩展,您应该将 REVERB_SCALING_ENABLED 环境变量设置为 true 在您的应用程序的 .env 配置文件中:
REVERB_SCALING_ENABLED=true接下来,你应该有一个专用的中央 Redis 服务器,所有 Reverb 服务器都将与其通信。Reverb 将使用 为你的应用配置的默认 Redis 连接 来发布消息到你所有的 Reverb 服务器。
启用 Reverb 的扩展选项并配置了 Redis 服务器后,您只需在能够与您的 Redis 服务器通信的多台服务器上调用 reverb:start 命令。这些 Reverb 服务器应放置在负载均衡器后面,该负载均衡器将传入请求均匀地分配到各服务器。