」工欲善其事,必先利其器。「—孔子《論語.錄靈公》
首頁 > 程式設計 > 將值物件注入到自動組裝的 Symfony 服務中

將值物件注入到自動組裝的 Symfony 服務中

發佈於2024-08-16
瀏覽:771

Inject Value Objects Into An Autowired Symfony Service

與我的團隊一起開發 Symfony 專案時,我需要將特定的值物件實例注入到我的一項服務中。在這種特殊情況下,值本身需要根據 .env 檔案中提供的值進行設定。

當然,我可以將字串值直接傳遞到我的服務中,並讓服務在建構函式中實例化值對象,但我想看看是否可以在services.yaml 檔案中配置它並注入而是完全實例化的物件。這將允許我將這些物件實例傳遞給多個服務,而不必在每個服務中重複建立值物件。

這就是我的做法...

背景

我們的應用程式使用 Twilio SDK。我們有各種封裝 SDK 呼叫的服務,它們需要使用我們特定於環境的配置值(我們公司針對每個環境的 API 金鑰等)。

Twilio API 使用字串識別碼或 SID。每種類型的 SID 都有一個不同的與之關聯的 2 個字母前綴,後面跟著由數字 0 到 9 以及字母 A 到 F(大寫和小寫)組成的 32 個字元。

例如:

  • ConferenceSid 有前綴 CF,看起來像 CFabcdef0123456789abcdef0123456789
  • CallSid 具有前綴 CA,看起來像 CAabcdef0123456789abcdef0123456789
  • 還有其他類型的SID,它們都使用相同的格式,僅透過前綴區分

我想確保每個 SID 類型的值物件都驗證傳入的值具有該 SID 類型的正確前綴,同時確保字串的長度正確並且僅由允許的字元組成.

值對象

我的每個 SID 類型都使用相同的驗證邏輯和功能,僅透過 SID 類型的前綴進行區分,因此建立基本 Trait 是有意義的。如果您願意,這可以是一個抽象類別。我不需要應用程式中的 TwilioStringIdentifier 概念作為參數類型或類似的東西,所以我在這裡更喜歡 Trait 而不是 Abstract Class。

此 Trait 確實定義了每個 SID 類型必須實作的抽象方法 getPrefixForSidType(),為該給定類型提供正確的前綴。它還執行驗證邏輯。

namespace App\Domain\Model\Twilio\Sid;

use Assert\Assert;

trait TwilioStringIdentifier
{
    private readonly string $sid;

    abstract private function getPrefixForSidType(): string;

    public static function fromString(string $string): self
    {
        return new self($string);
    }

    public function __construct(string $sid)
    {
        Assert::that($sid)
            ->startsWith($this->getPrefixForSidType())
            ->length(34)
            ->regex('/^[a-zA-Z]{2}[0-9a-fA-F]{32}$/')
        ;

        $this->sid = $sid;
    }

    public function asString(): string
    {
        return $this->sid;
    }
}    

SID 類

代表每種 SID 類型的值物件類別都很簡單。他們只需要使用 TwilioStringIdentifier Trait 並透過 getPrefixForSidType() 方法定義正確的前綴。

namespace App\Domain\Model\Twilio\Sid;

final readonly class AccountSid
{
    use TwilioStringIdentifier;

    private function getPrefixForSidType(): string
    {
        return 'AC';
    }
}

除了定義的前綴之外,其他 SID 類型類別是相同的。

注入實例化物件

因為這些值物件將在整個應用程式中使用並與各種相關的值一起使用,而不僅僅是我們公司的全域值,所以我需要一種方法將已使用定義的值實例化的特定類型的物件注入到服務中在我們的.env 檔案中

我知道 Symfony 能夠定義透過工廠實例化的服務,但從未真正見過(我記得)任何關於注入一個物件的內容,該物件是從其他地方呼叫方法的結果。我還知道這些工廠方法可以將參數傳遞給它們,我只是不確定如何使用一個值物件實例來執行此操作。

定義特定值物件實例

Symfony 的服務定義可讓您命名每個服務。通常它是透過服務類別的名稱完成的:

App\Path\To\My\Service:
    class: App\Path\To\My\Service
    arguments: []

但是,該服務名稱不必與類別名稱相符。它可以是 app.my_service 或 Foo\Bar\Baz\Service 或其他。

那麼,如果我建立一個具有唯一名稱的服務,該名稱是我需要的值物件的實例化實例,該怎麼辦?我可以將 .env 值作為參數傳遞,然後將該物件實例注入到我的服務類別中!

服務.yaml

# Create services named with a Global "namespace"
Global\Twilio\Sid\Account:
    factory: ['App\Domain\Model\Twilio\Sid\AccountSid', 'fromString']
    arguments: ['%env(TWILIO_ACCOUNT_SID)%']

Global\Twilio\Sid\Api:
    factory: ['App\Domain\Model\Twilio\Sid\ApiSid', 'fromString']
    arguments: ['%env(TWILIO_API_SID)%']

Global\Twilio\Sid\Application:
    factory: ['App\Domain\Model\Twilio\Sid\ApplicationSid', 'fromString']
    arguments: ['%env(TWILIO_APP_SID)%']

然後透過它們的命名參數將這些服務(物件)傳遞到我的 Twilio 服務:

App\Service\Vendor\Twilio\TwilioService:
    arguments:
        $accountSid: '@Global\Twilio\Sid\Account'
        $apiSid: '@Global\Twilio\Sid\Api'
        $applicationSid: '@Global\Twilio\Sid\Application'
        $apiSecret: '%env(TWILIO_API_SECRET)%'

現在我的服務類別可以接收完全實例化的值物件實例:

Twilio服務

namespace App\Service\Vendor\Twilio;

use App\Domain\Model\Twilio\Sid\AccountSid;
use App\Domain\Model\Twilio\Sid\ApiSid;
use App\Domain\Model\Twilio\Sid\ApplicationSid;

final readonly class TwilioService
{
    public function __construct(
        private AccountSid $accountSid,
        private ApiSid $apiSid,
        private ApplicationSid $applicationSid,
        private string $apiSecret
    ) {}
}

瞧!

Symfony 足夠靈活且足夠直觀,很容易弄清楚如何做到這一點。由於我在其他地方找不到執行此操作的快速參考,因此我想我應該將其寫下來作為未來我和其他可能需要執行類似操作的人的參考

乾杯,祝編碼愉快!

版本聲明 本文轉載於:https://dev.to/mbadolato/inject-value-objects-into-an-autowired-symfony-service-3an2?1如有侵犯,請聯絡[email protected]刪除
最新教學 更多>

免責聲明: 提供的所有資源部分來自互聯網,如果有侵犯您的版權或其他權益,請說明詳細緣由並提供版權或權益證明然後發到郵箱:[email protected] 我們會在第一時間內為您處理。

Copyright© 2022 湘ICP备2022001581号-3