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「應用程式」憑證。這些憑證在伺服器上設定，用於驗證來自客戶端的請求。您可以使用以下環境變數來定義這些憑證：
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',
// ...
],
],SSL
在大多數情況下，安全的 WebSocket 連線由上游網頁伺服器（Nginx 等）處理，然後請求才會代理到您的 Reverb 伺服器。
然而，有時讓 Reverb 伺服器直接處理安全連線會很有用，例如在本地開發期間。如果您正在使用 Laravel Herd 的安全站點功能，或者您正在使用 Laravel Valet 並已對您的應用程式執行 secure command，您可以使用為您的站點產生的 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 將廣播訊息傳送到何處。例如，在正式環境中，您可能將來自公共 Reverb 主機名稱（連接埠 443）的請求路由到在 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:restart監控
Reverb 可以透過與 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，則只應在其中一個伺服器上執行此常駐程式。
在正式環境中執行 Reverb
由於 WebSocket 伺服器長時間執行的特性，您可能需要對伺服器和託管環境進行一些最佳化，以確保您的 Reverb 伺服器能夠有效處理伺服器上可用資源的最佳連接數。
📌 備註
如果您的網站由 Laravel Forge 管理，您可以直接從「應用程式」面板為 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 在您伺服器上的一個非網路對外連接埠上執行。因此，為了將流量路由到 Reverb，您應該設定反向代理。假設 Reverb 在主機 0.0.0.0 和連接埠 8080 上執行，並且您的伺服器使用 Nginx 網頁伺服器，則可以使用以下 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 監聽 /app 上的 WebSocket 連線，並處理 /apps 上的 API 請求。您應該確保處理 Reverb 請求的網頁伺服器能夠提供這兩個 URI。如果您使用 Laravel Forge 來管理您的伺服器，您的 Reverb 伺服器預設會正確設定。
通常，網頁伺服器會設定為限制允許的連接數，以防止伺服器過載。要將 Nginx 網頁伺服器上允許的連接數增加到 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 將傳入的訊息發布到所有其他伺服器。
要啟用水平擴展，您應該將應用程式的 .env 設定檔中的 REVERB_SCALING_ENABLED 環境變數設定為 true：
REVERB_SCALING_ENABLED=true接下來，您應該有一個專用的中央 Redis 伺服器，所有 Reverb 伺服器都將與之通訊。Reverb 將使用為您的應用程式設定的 預設 Redis 連線 向所有 Reverb 伺服器發布訊息。
一旦您啟用 Reverb 的擴展選項並設定了 Redis 伺服器，您就可以在多個能夠與您的 Redis 伺服器通訊的伺服器上簡單地呼叫 reverb:start 命令。這些 Reverb 伺服器應該放置在負載平衡器後方，該負載平衡器會將傳入的請求平均分發到各個伺服器。