使用 Symfony 的 HeaderBag 作為服務：API 上下文中的調試超級能力

介紹

建立 API 意味著處理複雜的快取、中間件和效能最佳化層。雖然這些層有助於生產，但它們也可能掩蓋實際的資料流。您如何知道特定請求中快取是否已命中或遺失？一種簡單的方法是為回應添加自訂標頭，為您提供寶貴的見解。

在本文中，我將向您展示 Symfony 的 HeaderBag 在註冊為服務時如何成為在生產中調試 API 的強大工具。透過附加指示快取命中和未命中的自訂標頭，您可以立即了解 API 中發生的情況，而無需添加不必要的日誌記錄或破壞執行流程。

為什麼選擇標題包？

Symfony 的 HeaderBag 是 HttpFoundation 元件的一部分，由 Symfony 的請求和回應物件在內部使用。它提供了一種與 HTTP 標頭互動的結構化方法，可讓您以乾淨、物件導向的方式新增、修改和檢索標頭。這使得它非常適合在 API 執行期間管理自訂標頭，尤其是在偵錯場景中。

但還有更多：您可以將 HeaderBag 註冊為服務並在您的應用程式中使用它，保持程式碼整潔和調試一致。

第 1 步：將 HeaderBag 註冊為服務

您可以透過以下兩種方式之一輕鬆將 HeaderBag 註冊為服務。

選項 1：在自訂服務中擴充 HeaderBag

您可以建立擴充 HeaderBag 的自訂服務，然後在您的應用程式中使用它：

<?php
declare(strict_types=1);

namespace App\Service;

use Symfony\Component\HttpFoundation\HeaderBag;

class ResponseHeaderService extends HeaderBag
{
}

選項 2：在 services.yaml 中定義它

或者，您可以直接在 services.yaml 中將 HeaderBag 註冊為服務：

my.awesome.headerbag:
    class: 'Symfony\Component\HttpFoundation\HeaderBag'

這兩種方法都實現了相同的目標：允許 HeaderBag 在整個應用程式中作為服務提供。

第 2 步：透過事件訂閱者新增自訂標頭

將 HeaderBag 註冊為服務後，下一步就是使其與 Symfony 的回應物件進行互動。這就是事件訂閱者發揮作用的地方。透過訂閱 KernelEvents::RESPONSE 事件，您可以在將回應傳送回客戶端之前將自訂標頭注入到回應中。

以下是如何建立事件訂閱者的範例，該事件訂閱者會新增儲存在 HeaderBag 中的標頭：

<?php
declare(strict_types=1);

namespace App\EventSubscriber;

use App\Service\ResponseHeaderService;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\ResponseEvent;
use Symfony\Component\HttpKernel\KernelEvents;

readonly class ResponseHeadersEventSubscriber implements EventSubscriberInterface
{
    public function __construct(
        private ResponseHeaderService $responseHeaderService
    )
    {}

    public static function getSubscribedEvents(): array
    {
        return [
            KernelEvents::RESPONSE => 'onKernelResponse'
        ];
    }

    public function onKernelResponse(ResponseEvent $event): void
    {
        $response = $event->getResponse();

        $response->headers->add($this->responseHeaderService->all());
    }
}

如果您希望在 services.yaml 中將 HeaderBag 註冊為服務，則需要使用 Autowire 屬性：

<?php
declare(strict_types=1);

namespace App\Service;

use Symfony\Component\HttpFoundation\HeaderBag;

class ResponseHeaderService extends HeaderBag
{
}

第 3 步：實施快取診斷

現在有趣的部分來了：使用此服務來追蹤快取命中和未命中。以下是計算某些結果、檢查快取命中並向回應添加自訂標頭以指示快取是否命中或遺失的服務範例：

my.awesome.headerbag:
    class: 'Symfony\Component\HttpFoundation\HeaderBag'

在這個例子中，每次UniverseService與快取互動時，它都會設定一個X-Universe-Cache標頭，指示快取是否命中或錯過。然後，事件訂閱者會自動將該標頭新增至回應。結果呢？每個 API 回應都將包含一個簡單、資訊豐富的標頭，讓您可以立即了解是否使用了快取。

您的回覆可能如下圖所示：

<?php
declare(strict_types=1);

namespace App\EventSubscriber;

use App\Service\ResponseHeaderService;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\ResponseEvent;
use Symfony\Component\HttpKernel\KernelEvents;

readonly class ResponseHeadersEventSubscriber implements EventSubscriberInterface
{
    public function __construct(
        private ResponseHeaderService $responseHeaderService
    )
    {}

    public static function getSubscribedEvents(): array
    {
        return [
            KernelEvents::RESPONSE => 'onKernelResponse'
        ];
    }

    public function onKernelResponse(ResponseEvent $event): void
    {
        $response = $event->getResponse();

        $response->headers->add($this->responseHeaderService->all());
    }
}

結論

使用 Symfony 的 HeaderBag 作為服務是 API 開發中的強大工具，特別是當您在具有複雜快取層的生產環境中執行時。透過為 API 回應新增自訂標頭，您可以快速確定快取狀態，從而改善偵錯和最佳化流程。

下次您發現自己想知道特定請求是否已快取時，請查看您新增的標頭 - 您就會在那裡得到答案！

以上是使用 Symfony 的 HeaderBag 作為服務：API 上下文中的調試超級能力的詳細內容。更多資訊請關注PHP中文網其他相關文章！