【譯文】PHP-DI和依賴注入的最佳實踐

PHP-DI是用PHP編寫的、強大的和實用的、框架無關的依賴注入容器。這是一個關於如何使用PHP-DI和依賴注入的最佳實踐指南。

文章來源於PHP-DI，做者：Matthieu Napoli和貢獻者。PHP-DI是用PHP編寫的、強大的和實用的、框架無關的依賴注入容器。

原文地址（英文）：http://php-di.org/doc/best-pr...

PHP-DI在【本站實用開源目錄】連接：http://www.worldlink.com.cn/o...
這是一個關於如何使用PHP-DI和依賴注入的最佳實踐指南。

雖然它可能不包括每一個案例，並知足每一個人，但它可做爲拋磚引玉，以幫助您開始依賴注入。

若是你不一樣意該指南中解釋的任何內容，那不要緊。你應該對這些問題提出本身的看法:)。它不會阻止你以你想要的方式使用PHP-DI。

使用容器和依賴注入的規則

如下是一些基本規則：

不要直接從容器中獲取一個條目（老是使用依賴注入）
更廣泛的是，編寫代碼解耦的容器
針對接口的類型約束，要在容器的配置中配置使用哪一種實現
＃編寫控制器
在控制器中使用依賴注入一般是最痛苦的。

若是咱們以Symfony 2爲例（但這一般適用於每一個框架），這裏有你的選擇：

在容器中注入控制器，並調用 $container->get(...)
這是很差的，見規則n°1。

在構造函數中注入依賴性（在Symfony中做爲服務的控制器）
這是痛苦的，當你有5個以上的依賴項，你的構造函數是15行樣板代碼

在屬性中注入依賴性
這是咱們建議的解決方案。

例如:

class UserController
{
    /**
     * @Inject
     * @var FormFactoryInterface
     */
    private $formFactory;
    public function createForm($type, $data, $options)
    {
        // $this->formFactory->...
    }
}

如你所見，這個解決方案須要不多的代碼，很容易理解和利於IDE支持（自動完成，重構，...）。

屬性注入一般讓人皺眉頭，這是有必定的緣由的：

注入私有屬性破壞了封裝
它不是一個顯式的依賴：沒有約定，說你的類須要設置屬性以工做
若是使用PHP-DI的註解來標記要注入的依賴關係，那麼您的類依賴於容器（請參見上面的第2條規則）
但

若是您遵循關於如何編寫應用程序的通常最佳實踐，您的控制器將不包含業務邏輯（僅對模型進行路由調用並綁定返回的值以查看）。

所以：

你不會對它進行單元測試（這並不意味着你不會在接口上寫功能測試）
你不須要在別處重用它
若是你改變框架，你可能不得不重寫它（或其部分）（由於大多數依賴，如請求、響應、模板系統等將改變）
此解決方案提供了許多優勢，沒有主要的缺點，所以咱們建議在控制器中使用註解。

編寫服務

給定一個服務旨在被重用、測試和獨立於你的框架，咱們不建議使用註解注入依賴。 相反，咱們建議使用構造函數注入和自動裝配：

class OrderService implements OrderServiceInterface
{
    private $paymentService;
    public function __construct(PaymentServiceInterface $paymentService)
    {
        $this->paymentService = $paymentService;
    }
    public function processOrder($order)
    {
        $this->paymentService->...
    }
}

經過使用自動裝配（默認狀況下啓用），您本身保存綁定配置中的構造函數的每一個參數。 PHP-DI將經過檢查您的參數的類型來猜想它須要注入哪一個對象。

在某些狀況下，使用自動裝配還不夠，由於一些參數將是一個標量（string，int，...）。 此時，您須要明肯定義要在該標量參數中注入的內容，爲此，您能夠：

定義方法/類的所有注入（即，每一個參數）。
例如：

<?php // config.php return [

// ...
OrderService::class => DI\object()
    ->constructor(DI\get(SomeOtherService::class), 'a value'),

];
或者只定義標量參數，讓PHP-DI使用自動裝配。
例如:

<?php // config.php return [
    // ...
    OrderService::class => DI\object()
        ->constructorParameter('paramName', 'a value'),
];

這個解決方案一般是優選的，避免從新定義一切。

旁註：如規則n°3中所述，咱們建議對接口進行類型約束。 在這種狀況下，您將須要將接口映射到容器在配置中應該使用的實現：

使用庫

當使用庫，如日誌記錄器，ORM，...有時須要配置它們。

在這種狀況下，咱們建議您在配置文件中定義這些依賴關係。 咱們還建議在配置有點複雜時使用匿名函數。

匿名函數容許你編寫真正的PHP代碼，這是偉大的，由於你可使用庫的文檔，獲得IDE支持，做爲一個PHP開發人員，你懂的:)。

這裏是一個例子，Monolog，一個PHP記錄器：

<?php // config.php
use Monolog\Logger;
use Monolog\Handler\StreamHandler;
return [
    // ...
    Psr\Log\LoggerInterface::class => DI\factory(function () {
        $logger = new Logger('mylog');
        $fileHandler = new StreamHandler('path/to/your.log', Logger::DEBUG);
        $fileHandler->setFormatter(new LineFormatter());
        $logger->pushHandler($fileHandler);
        return $logger;
    }),
];

固然，如你所見，咱們使用PSR-3接口進行注入。 這樣，咱們能夠隨時用任何PSR-3記錄器替換Monolog，只需更改此配置便可。