Symfony Messenger 監控簡介-php教程-PHP中文網

使用 Symfony Messenger 和 Inspector Bundle 增強 Symfony 應用程式可擴充性

作為 Symfony 開發人員，優化應用程式效能和可擴展性至關重要。 Symfony Messenger 元件為非同步任務處理提供了強大的解決方案，但監視這些後台操作可能具有挑戰性。本文介紹了 Inspector 套件中的一項新功能，該功能提供對 Symfony Messenger 後台作業的全面可見性，無需手動日誌分析或自訂監控程式碼。

這項新功能可以自動監控後台任務的各個面向。從執行時間和記憶體消耗到資料庫查詢、錯誤和潛在瓶頸，您可以透過使用者友好的儀表板獲得即時洞察 - 所有這些都需要零配置。

典型的開發人員挑戰仍然是：部署非同步訊息處理並希望後台操作順利。雖然 Symfony Messenger 很強大，但監控後台進程歷來是個盲點。本文深入探討了實現細節，以強調對日常開發的顯著好處。

什麼是隊列系統？

Introducing Symfony Messenger Monitoring

佇列系統是現代 Web 應用程式中的關鍵元素，可以將時間密集型任務與主請求回應週期分開。這些任務不是在使用者請求期間處理資源密集型操作（例如發送電子郵件、影像處理、報告產生），而是排隊等待後台工作人員非同步處理。這提高了應用程式的回應能力，因為使用者不必等待冗長的操作，並透過控制並發任務處理來增強資源管理。佇列系統通常包含重試機制，以確保任務失敗時的可靠性。隨著應用程式的擴展，採用這種方法對於在不增加基礎設施成本的情況下為更多用戶提供服務變得至關重要。

Symfony Messenger 組件

Symfony Messenger 元件是 Symfony 框架內的一個內建的、強大的排隊系統。它有助於從各種佇列提供者（AMQP、Redis、Doctrine）發布和使用訊息。訊息是包含表示任務的資料的簡單類別。

這是一則範例訊息：

<code class="language-php">namespace App\Messenger;

class SmsNotification
{
    public function __construct(private string $content) {}
    public function getContent(): string { return $this->content; }
}</code>

登入後複製

從佇列中檢索訊息時，對應的處理程序會處理此訊息：

<code class="language-php">namespace App\Messenger;

class SmsNotification
{
    public function __construct(private string $content) {}
    public function getContent(): string { return $this->content; }
}</code>

登入後複製

請注意 #[AsMessageHandler] 屬性以及 SmsNotification 方法中 __invoke 的型別提示。這些是 Symfony 如何識別特定訊息的處理程序。 messenger:consume 命令執行後台工作程序來處理排隊的訊息並在請求-回應週期之外執行適當的處理程序。非同步發送訊息：

<code class="language-php">namespace App\Messenger;

use Symfony\Component\Messenger\Attribute\AsMessageHandler;

#[AsMessageHandler]
class SmsNotificationHandler
{
    public function __invoke(SmsNotification $message)
    {
        // ... send SMS message ...
    }
}</code>

登入後複製

Messenger 透過自動訊息序列化、中介軟體支援和重試策略等功能簡化了複雜的非同步處理。

Symfony Messenger 監控中間件

監控在使用者和開發人員視圖之外運行的後台進程帶來了獨特的挑戰。問題出現了：處理程序需要多長時間？是否正在執行昂貴的資料庫操作？後台作業是否會默默失敗？

Inspector 透過提供使用者友善的介面來監控後台進程，其效率與主應用程式相同，從而解決了這些問題。

Symfony Messenger 中介軟體架構

Inspector 套件註冊了一個 Messenger 中間件來追蹤訊息處理的開始和結束。它利用現有功能在訊息處理期間收集資料庫查詢和其他操作。 Symfony Messenger 中的中間件充當訊息處理的包裝器，允許在處理之前和之後執行操作。這利用了責任鏈設計模式。

檢查器中間件實作

中間件的實作是為了在訊息處理之前和之後執行程式碼：

<code class="language-php">namespace App\Controller;

use App\Messenger\SmsNotification;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Messenger\MessageBusInterface;
use Symfony\Component\Routing\Attribute\Route;

class HomeController extends AbstractController
{
    #[Route('/', name: 'home')]
    public function home(MessageBusInterface $bus)
    {
        $bus->dispatch(new SmsNotification("New Message!"));
        return new Response('SMS notification dispatched.');
    }
}</code>

登入後複製

這個即插即用元件簡化了更新應用程式相依性時的背景處理監控。

升級到版本1.5

版本 1.5 是一個次要版本，可以透過 composer update 輕鬆安裝。 Messenger 監控自動集成，無需更改程式碼。

忽略訊息

為了減少噪音，Inspector 允許使用 ignore_messages 中的 inspector.yaml 屬性忽略特定訊息或模式：

<code class="language-php">namespace App\Messenger\Middlewares;

use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
use Symfony\Component\Messenger\Middleware\StackInterface;

class MessengerMonitoringMiddleware implements MiddlewareInterface
{
    public function handle(Envelope $envelope, StackInterface $stack): Envelope
    {
        // Before handling
        $this->beforeHandle($envelope);

        // Handle the message
        $envelope = $stack->next()->handle($envelope, $stack);

        // After handling
        $this->afterHandle($envelope);
    }
}</code>

登入後複製