依賴注入容器


依賴注入容器

依賴注入(Dependency Injection,DI)容器就是一個對象,它知道怎樣初始化並配置對象及其依賴的所有對象。Martin 的文章 已經解釋了 DI 容器爲什麼很有用。這裏我們主要講解 Yii 提供的 DI 容器的使用方法。

依賴注入

Yii 通過 [[yii\di\Container]] 類提供 DI 容器特性。它支持如下幾種類型的依賴注入:

  • 構造方法注入;
  • Setter 和屬性注入;
  • PHP 回調注入.

構造方法注入

在參數類型提示的幫助下,DI 容器實現了構造方法注入。當容器被用於創建一個新對象時,類型提示會告訴它要依賴什麼類或接口。容器會嘗試獲取它所依賴的類或接口的實例,然後通過構造器將其注入新的對象。例如:

  1. class Foo 
  2.     public function __construct(Bar $bar) 
  3.     { 
  4.     } 
  5.  
  6. $foo = $container->get('Foo'); 
  7. // 上面的代碼等價於: 
  8. $bar = new Bar; 
  9. $foo = new Foo($bar);

Setter 和屬性注入

Setter 和屬性注入是通過配置提供支持的。當註冊一個依賴或創建一個新對象時,你可以提供一個配置,該配置會提供給容器用於通過相應的 Setter 或屬性注入依賴。例如:

  1. use yii\\base\\Object; 
  2.  
  3. class Foo extends Object 
  4.     public $bar; 
  5.  
  6.     private $_qux; 
  7.  
  8.     public function getQux() 
  9.     { 
  10.         return $this->_qux; 
  11.     } 
  12.  
  13.     public function setQux(Qux $qux) 
  14.     { 
  15.         $this->_qux = $qux; 
  16.     } 
  17.  
  18. $container->get('Foo', [], [ 
  19.     'bar' => $container->get('Bar'), 
  20.     'qux' => $container->get('Qux'), 
  21. ]);

PHP 回調注入

這種情況下,容器將使用一個註冊過的 PHP 回調創建一個類的新實例。回調負責解決依賴並將其恰當地注入新創建的對象。例如:

  1. $container->set('Foo', function () { 
  2.     return new Foo(new Bar); 
  3. }); 
  4.  
  5. $foo = $container->get('Foo');

註冊依賴關係

可以用 [[yii\di\Container::set()]] 註冊依賴關係。註冊會用到一個依賴關係名稱和一個依賴關係的定義。依賴關係名稱可以是一個類名,一個接口名或一個別名。依賴關係的定義可以是一個類名,一個配置數組,或者一個 PHP 回調。

  1. $container = new \\yii\\di\\Container; 
  2.  
  3. // 註冊一個同類名一樣的依賴關係,這個可以省略。 
  4. $container->set('yii\\db\\Connection'); 
  5.  
  6. // 註冊一個接口 
  7. // 當一個類依賴這個接口時,相應的類會被初始化作爲依賴對象。 
  8. $container->set('yii\\mail\\MailInterface', 'yii\\swiftmailer\\Mailer'); 
  9.  
  10. // 註冊一個別名。 
  11. // 你可以使用 $container->get('foo') 創建一個 Connection 實例 
  12. $container->set('foo', 'yii\\db\\Connection'); 
  13.  
  14. // 通過配置註冊一個類 
  15. // 通過 get() 初始化時,配置將會被使用。 
  16. $container->set('yii\\db\\Connection', [ 
  17.     'dsn' => 'mysql:host=127.0.0.1;dbname=demo', 
  18.     'username' => 'root', 
  19.     'password' => '', 
  20.     'charset' => 'utf8', 
  21. ]); 
  22.  
  23. // 通過類的配置註冊一個別名 
  24. // 這種情況下,需要通過一個 「class」 元素指定這個類 
  25. $container->set('db', [ 
  26.     'class' => 'yii\\db\\Connection', 
  27.     'dsn' => 'mysql:host=127.0.0.1;dbname=demo', 
  28.     'username' => 'root', 
  29.     'password' => '', 
  30.     'charset' => 'utf8', 
  31. ]); 
  32.  
  33. // 註冊一個 PHP 回調 
  34. // 每次調用 $container->get('db') 時,回調函數都會被執行。 
  35. $container->set('db', function ($container, $params, $config) { 
  36.     return new \\yii\\db\\Connection($config); 
  37. }); 
  38.  
  39. // 註冊一個組件實例 
  40. // $container->get('pageCache') 每次被調用時都會返回同一個實例。 
  41. $container->set('pageCache', new FileCache);

Tip: 如果依賴關係名稱和依賴關係的定義相同,則不需要通過 DI 容器註冊該依賴關係。

通過 set() 註冊的依賴關係,在每次使用時都會產生一個新實例。可以使用 [[yii\di\Container::setSingleton()]] 註冊一個單例的依賴關係:

  1. $container->setSingleton('yii\\db\\Connection', [ 
  2.     'dsn' => 'mysql:host=127.0.0.1;dbname=demo', 
  3.     'username' => 'root', 
  4.     'password' => '', 
  5.     'charset' => 'utf8', 
  6. ]);

解決依賴關係

註冊依賴關係後,就可以使用 DI 容器創建新對象了。容器會自動解決依賴關係,將依賴實例化並注入新創建的對象。依賴關係的解決是遞歸的,如果一個依賴關係中還有其他依賴關係,則這些依賴關係都會被自動解決。

可以使用 [[yii\di\Container::get()]] 創建新的對象。該方法接收一個依賴關係名稱,它可以是一個類名,一個接口名或一個別名。依賴關係名或許是通過 set() 或 setSingleton() 註冊的。你可以隨意地提供一個類的構造器參數列表和一個configuration 用於配置新創建的對象。例如:

  1. // "db" 是前面定義過的一個別名 
  2. $db = $container->get('db'); 
  3.  
  4. // 等價於: $engine = new \\app\\components\\SearchEngine($apiKey, ['type' => 1]); 
  5. $engine = $container->get('app\\components\\SearchEngine', [$apiKey], ['type' => 1]);

代碼背後,DI 容器做了比創建對象多的多的工作。容器首先將檢查類的構造方法,找出依賴的類或接口名,然後自動遞歸解決這些依賴關係。

如下代碼展示了一個更復雜的示例。UserLister 類依賴一個實現了 UserFinderInterface 接口的對象;UserFinder 類實現了這個接口,並依賴於一個 Connection 對象。所有這些依賴關係都是通過類構造器參數的類型提示定義的。通過屬性依賴關係的註冊,DI 容器可以自動解決這些依賴關係並能通過一個簡單的get('userLister') 調用創建一個新的 UserLister 實例。

  1. namespace app\\models; 
  2.  
  3. use yii\\base\\Object; 
  4. use yii\\db\\Connection; 
  5. use yii\\di\\Container; 
  6.  
  7. interface UserFinderInterface 
  8.     function findUser(); 
  9.  
  10. class UserFinder extends Object implements UserFinderInterface 
  11.     public $db; 
  12.  
  13.     public function __construct(Connection $db, $config = []) 
  14.     { 
  15.         $this->db = $db; 
  16.         parent::__construct($config); 
  17.     } 
  18.  
  19.     public function findUser() 
  20.     { 
  21.     } 
  22.  
  23. class UserLister extends Object 
  24.     public $finder; 
  25.  
  26.     public function __construct(UserFinderInterface $finder, $config = []) 
  27.     { 
  28.         $this->finder = $finder; 
  29.         parent::__construct($config); 
  30.     } 
  31.  
  32. $container = new Container; 
  33. $container->set('yii\\db\\Connection', [ 
  34.     'dsn' => '...', 
  35. ]); 
  36. $container->set('app\\models\\UserFinderInterface', [ 
  37.     'class' => 'app\\models\\UserFinder', 
  38. ]); 
  39. $container->set('userLister', 'app\\models\\UserLister'); 
  40.  
  41. $lister = $container->get('userLister'); 
  42.  
  43. // 等價於: 
  44.  
  45. $db = new \\yii\\db\\Connection(['dsn' => '...']); 
  46. $finder = new UserFinder($db); 
  47. $lister = new UserLister($finder);

實踐中的運用

當在應用程序的入口腳本中引入 Yii.php 文件時,Yii 就創建了一個 DI 容器。這個 DI 容器可以通過 [[Yii::$container]] 訪問。當調用 [[Yii::createObject()]] 時,此方法實際上會調用這個容器的 [[yii\di\Container::get()|get()]] 方法創建新對象。如上所述,DI 容器會自動解決依賴關係(如果有)並將其注入新創建的對象中。因爲 Yii 在其多數核心代碼中都使用了 [[Yii::createObject()]] 創建新對象,所以你可以通過 [[Yii::$container]] 全局性地自定義這些對象。

例如,你可以全局性自定義 [[yii\widgets\LinkPager]] 中分頁按鈕的默認數量:

  1. \\Yii::$container->set('yii\\widgets\\LinkPager', ['maxButtonCount' => 5]);

這樣如果你通過如下代碼在一個視圖裏使用這個掛件,它的 maxButtonCount 屬性就會被初始化爲 5 而不是類中定義的默認值 10。

  1. echo \\yii\\widgets\\LinkPager::widget();

然而你依然可以覆蓋通過 DI 容器設置的值:

  1. echo \\yii\\widgets\\LinkPager::widget(['maxButtonCount' => 20]);

另一個例子是借用 DI 容器中自動構造方法注入帶來的好處。假設你的控制器類依賴一些其他對象,例如一個旅館預訂服務。你可以通過一個構造器參數聲明依賴關係,然後讓 DI 容器幫你自動解決這個依賴關係。

  1. namespace app\\controllers; 
  2.  
  3. use yii\\web\\Controller; 
  4. use app\\components\\BookingInterface; 
  5.  
  6. class HotelController extends Controller 
  7.     protected $bookingService; 
  8.  
  9.     public function __construct($id, $module, BookingInterface $bookingService, $config = []) 
  10.     { 
  11.         $this->bookingService = $bookingService; 
  12.         parent::__construct($id, $module, $config); 
  13.     } 
  14. }

如果你從瀏覽器中訪問這個控制器,你將看到一個報錯信息,提醒你 BookingInterface 無法被實例化。這是因爲你需要告訴 DI 容器怎樣處理這個依賴關係。

  1. \\Yii::$container->set('app\\components\\BookingInterface', 'app\\components\\BookingService');

現在如果你再次訪問這個控制器,一個 app\components\BookingService 的實例就會被創建並被作爲第三個參數注入到控制器的構造器中。

什麼時候註冊依賴關係

由於依賴關係在創建新對象時需要解決,因此它們的註冊應該儘早完成。如下是推薦的實踐:

  • 如果你是一個應用程序的開發者,你可以在應用程序的入口腳本或者被入口腳本引入的腳本中註冊依賴關係。
  • 如果你是一個可再分發擴展的開發者,你可以將依賴關係註冊到擴展的引導類中。

總結

依賴注入和服務定位器都是流行的設計模式,它們使你可以用充分解耦且更利於測試的風格構建軟件。強烈推薦你閱讀 Martin 的文章 ,對依賴注入和服務定位器有個更深入的理解。

Yii 在依賴住入(DI)容器之上實現了它的服務定位器。當一個服務定位器嘗試創建一個新的對象實例時,它會把調用轉發到 DI 容器。後者將會像前文所述那樣自動解決依賴關係。