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

Ίκαρος發表於2017-09-18
Laravel依賴注入

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

依賴注入 設計模式非常簡單，但又很難解釋清楚。造成這個現象的主要原因是，別的介紹 依賴注入 的文章裡太多廢話，讓人混淆。下面我將透過一些更適合 PHP 的例子來講解它。

HTTP 協議是無狀態的，我們的 Web 應用程式如果需要在請求之間儲存使用者資訊，可以透過 COOKIE 或 SESSION ：

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

上述程式碼中，我們將 language 儲存在全域性變數 $_SESSION 中，因此可以這樣獲取它：

$user_language = $_SESSION['language'];

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

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 名稱寫死的話，每次想再改名，都要修改 User 類
  • 使用常量的話，User 類的變化將取決於設定的常量
  • 使用引數或者選項陣列看起來很靈活，但它把與 User 本身無關的東西摻雜在了建構函式中

透過建構函式，把一個外部的 SessionStorage 例項"注入"進 User 例項內部，而不是在 User 例項內部建立 SessionStorage 例項，就是 依賴注入。

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

    // ...
}

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

$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)。

本作品採用《CC 協議》，轉載必須註明作者和本文連結
原創。 所有 Laravel 文章均已收錄至 Github laravel-tips 專案。

相關文章