Laravel Dependency Injection (依賴注入) 概念詳解

時間 2019-12-05

標籤 laravel dependency injection 依賴注入概念詳解欄目設計模式简体版

原文原文鏈接

本文翻譯自 Symfony 做者 Fabien Potencier 的《Dependency Injection in general and the implementation of a Dependency Injection Container in PHP》系列文章。php

依賴注入 設計模式很是簡單，但又很難解釋清楚。形成這個現象的主要緣由是，別的介紹 依賴注入 的文章裏太多廢話，讓人混淆。下面我將經過一些更適合 PHP 的例子來說解它。html

HTTP 協議是無狀態的，咱們的 Web 應用程序若是須要在請求之間存儲用戶信息，能夠經過 COOKIE 或 SESSION ：laravel

$_SESSION['language'] = 'fr';

上述代碼中，咱們將 language 存儲在全局變量 $_SESSION 中，所以能夠這樣獲取它：git

$user_language = $_SESSION['language'];

只有在 OOP 開發時中才會遇到 依賴注入 ，所以假設咱們有一個封裝 SESSION 的 SessionStorage 類：github

class SessionStorage
{
    function __construct($cookieName='PHPSESSID')
    {
        session_name($cookieName);
        session_start();
    }

    function set($key, $value)
    {
        $_SESSION[$key] = $value;
    }

    function get($key)
    {
        return $_SESSION[$key];
    }

    // ...
}

以及一個更高層的 User 類:設計模式

class User
{
    protected $storage;

    function __construct()
    {
        $this->storage = new SessionStorage();
    }

    function setLanguage($language)
    {
        $this->storage->set('language', $language);
    }

    function getLanguage()
    {
        return $this->storage->get('language');
    }

    // ...
}

這兩個類很簡單，而且用起來也很方便：數組

$user = new User();
$user->setLanguage('fr');
$user_language = $user->getLanguage();

這種方式看起來很完美，可是並不夠靈活。好比：如今想修改會話的 COOKIE 名稱（默認爲 PHPSESSID），怎麼辦？這時有一大堆辦法：緩存

把會話的 COOKIE 名稱寫死在 User 類中 SessionStorage 的構造函數中 (Hardcode)：

class User
{
    function __construct()
    {
        $this->storage = new SessionStorage('SESSION_ID');
    }

    // ...
}

或者在 User 類外面定義一個常量：

class User
{
    function __construct()
    {
        $this->storage = new SessionStorage(SESSION_COOKIE_NAME);
    }

    // ...
}

define('SESSION_COOKIE_NAME', 'SESSION_ID');

或者把會話的 COOKIE 名稱做爲 User 類構造函數的一個參數傳進去：

class User
{
    function __construct($cookieName)
    {
        $this->storage = new SessionStorage($cookieName);
    }

    // ...
}

$user = new User('SESSION_ID');

或者給 SessionStorage 類加個選項數組：

class User
{
    function __construct($storageOptions)
    {
        $this->storage = new SessionStorage($storageOptions['cookie_name']);
    }

    // ...
}

$user = new User(['cookie_name' => 'SESSION_ID']);

上述方法都很糟糕：cookie

把會話的 COOKIE 名稱寫死的話，每次想再更名，都要修改 User 類
使用常量的話，User 類的變化將取決於設置的常量
使用參數或者選項數組看起來很靈活，但它把與 User 自己無關的東西摻雜在了構造函數中

經過構造函數，把一個外部的 `SessionStorage` 實例"注入"進 `User` 實例內部，而不是在 `User` 實例內部建立 `SessionStorage` 實例，就是 `依賴注入`。

class User
{
    function __construct($storage)
    {
        $this->storage = $storage;
    }

    // ...
}

很清爽吧！只需先建立 SessionStorage 實例，再建立 User 實例：session

$storage = new SessionStorage('SESSION_ID');
$user = new User($storage);

用這個方法，配置 SessionStorage 很簡單，給 User 替換 $storage 類型也很簡單，都不須要去修改 User 類。這就實現瞭解耦。

依賴注入 並不限於構造函數：

Constructor Injection:

class User
{
    function __construct($storage)
    {
        $this->storage = $storage;
    }

    // ...
}

Setter Injection:

class User
{
    function setSessionStorage($storage)
    {
        $this->storage = $storage;
    }

    // ...
}

Property Injection:

class User
{
    public $sessionStorage;
}

$user->sessionStorage = $storage;

做爲經驗， Constructor 注入 最適合必須的依賴關係，好比示例中的狀況； Setter 注入 最適合可選依賴關係，好比緩存一個對象實例。

如今，大多數現代 PHP 框架都大量使用依賴注入來提供一組 去耦 但 粘合 的組件：

// symfony: A constructor injection example
$dispatcher = new sfEventDispatcher();
$storage = new sfMySQLSessionStorage([
    'database' => 'session',
    'db_table' => 'session',
]);
$user = new sfUser($dispatcher, $storage, ['default_culture' => 'en']);

// Zend Framework: A setter injection example
$transport = new Zend_Mail_Transport_Smtp('smtp.gmail.com', [
  'auth'     => 'login',
  'username' => 'foo',
  'password' => 'bar',
  'ssl'      => 'ssl',
  'port'     => 465,
]);

$mailer = new Zend_Mail();
$mailer->setDefaultTransport($transport);

若是你有興趣瞭解更多有關 依賴注入 的信息，我強烈建議你閱讀 Martin Fowler 的介紹或 Jeff Moore 的 PPT。你還能夠看看我去年關於 依賴注入 的 PPT，其中我詳細了介紹本文中所討論的示例。

但願本文能讓你更好的理解 依賴注入，在本系列的下一部分中，我將討論 依賴注入容器 (Dependency Injection Containers)。

原創。全部 Laravel 文章均已收錄至 laravel-tips 項目。