依賴注入容器

依賴注入(Dependency Injection，DI)容器就是一個物件，它知道怎樣初始化並組態物件及其依賴的所有物件。Martin 的文章已經解釋了 DI 容器為什麼很有用。這裡我們主要講解 Yii 提供的 DI 容器的使用方法。

依賴注入

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

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

構造方法注入

在引數型別提示的幫助下，DI 容器實現了構造方法注入。當容器被用於建立一個新物件時，型別提示會告訴它要依賴什麼類或介面。容器會嘗試獲取它所依賴的類或介面的範例，然後通過構造器將其注入新的物件。例如：

class Foo
{
public function __construct(Bar $bar)
{
}
}
$foo = $container->get('Foo');
// 上面的程式碼等價於：
$bar = new Bar;
$foo = new Foo($bar);

Setter 和屬性注入

Setter 和屬性注入是通過組態提供支援的。當註冊一個依賴或建立一個新物件時，你可以提供一個組態，該組態會提供給容器用於通過相應的 Setter 或屬性注入依賴。例如：

use yii\\base\\Object;
class Foo extends Object
{
public $bar;
private $_qux;
public function getQux()
{
return $this->_qux;
}
public function setQux(Qux $qux)
{
$this->_qux = $qux;
}
}
$container->get('Foo', [], [
'bar' => $container->get('Bar'),
'qux' => $container->get('Qux'),
]);

PHP 回撥注入

這種情況下，容器將使用一個註冊過的 PHP 回撥建立一個類的新範例。回撥負責解決依賴並將其恰當地注入新建立的物件。例如：

$container->set('Foo', function () {
return new Foo(new Bar);
});
$foo = $container->get('Foo');

註冊依賴關係

可以用 [[yii\di\Container::set()]] 註冊依賴關係。註冊會用到一個依賴關係名稱和一個依賴關係的定義。依賴關係名稱可以是一個類名，一個介面名或一個別名。依賴關係的定義可以是一個類名，一個組態陣列，或者一個 PHP 回撥。

$container = new \\yii\\di\\Container;
// 註冊一個同類名一樣的依賴關係，這個可以省略。
$container->set('yii\\db\\Connection');
// 註冊一個介面
// 當一個類依賴這個介面時，相應的類會被初始化作為依賴物件。
$container->set('yii\\mail\\MailInterface', 'yii\\swiftmailer\\Mailer');
// 註冊一個別名。
// 你可以使用 $container->get('foo') 建立一個 Connection 範例
$container->set('foo', 'yii\\db\\Connection');
// 通過組態註冊一個類
// 通過 get() 初始化時，組態將會被使用。
$container->set('yii\\db\\Connection', [
'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
'username' => 'root',
'password' => '',
'charset' => 'utf8',
]);
// 通過類的組態註冊一個別名
// 這種情況下，需要通過一個 “class” 元素指定這個類
$container->set('db', [
'class' => 'yii\\db\\Connection',
'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
'username' => 'root',
'password' => '',
'charset' => 'utf8',
]);
// 註冊一個 PHP 回撥
// 每次呼叫 $container->get('db') 時，回撥函式都會被執行。
$container->set('db', function ($container, $params, $config) {
return new \\yii\\db\\Connection($config);
});
// 註冊一個元件範例
// $container->get('pageCache') 每次被呼叫時都會返回同一個範例。
$container->set('pageCache', new FileCache);

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

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

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

解決依賴關係

註冊依賴關係後，就可以使用 DI 容器建立新物件了。容器會自動解決依賴關係，將依賴範例化並注入新建立的物件。依賴關係的解決是遞迴的，如果一個依賴關係中還有其他依賴關係，則這些依賴關係都會被自動解決。

可以使用 [[yii\di\Container::get()]] 建立新的物件。該方法接收一個依賴關係名稱，它可以是一個類名，一個介面名或一個別名。依賴關係名或許是通過 set() 或 setSingleton() 註冊的。你可以隨意地提供一個類的構造器引數列表和一個configuration 用於組態新建立的物件。例如：

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

程式碼背後，DI 容器做了比建立物件多的多的工作。容器首先將檢查類的構造方法，找出依賴的類或介面名，然後自動遞回解決這些依賴關係。

如下程式碼展示了一個更複雜的範例。UserLister 類依賴一個實現了 UserFinderInterface 介面的物件；UserFinder 類實現了這個介面，並依賴於一個 Connection 物件。所有這些依賴關係都是通過類構造器引數的型別提示定義的。通過屬性依賴關係的註冊，DI 容器可以自動解決這些依賴關係並能通過一個簡單的get('userLister') 呼叫建立一個新的 UserLister 範例。

namespace app\\models;
use yii\\base\\Object;
use yii\\db\\Connection;
use yii\\di\\Container;
interface UserFinderInterface
{
function findUser();
}
class UserFinder extends Object implements UserFinderInterface
{
public $db;
public function __construct(Connection $db, $config = [])
{
$this->db = $db;
parent::__construct($config);
}
public function findUser()
{
}
}
class UserLister extends Object
{
public $finder;
public function __construct(UserFinderInterface $finder, $config = [])
{
$this->finder = $finder;
parent::__construct($config);
}
}
$container = new Container;
$container->set('yii\\db\\Connection', [
'dsn' => '...',
]);
$container->set('app\\models\\UserFinderInterface', [
'class' => 'app\\models\\UserFinder',
]);
$container->set('userLister', 'app\\models\\UserLister');
$lister = $container->get('userLister');
// 等價於:
$db = new \\yii\\db\\Connection(['dsn' => '...']);
$finder = new UserFinder($db);
$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]] 中分頁按鈕的預設數量:

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

這樣如果你通過如下程式碼在一個檢視裡使用這個掛件，它的 maxButtonCount 屬性就會被初始化為 5 而不是類中定義的預設值 10。

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

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

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

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

namespace app\\controllers;
use yii\\web\\Controller;
use app\\components\\BookingInterface;
class HotelController extends Controller
{
protected $bookingService;
public function __construct($id, $module, BookingInterface $bookingService, $config = [])
{
$this->bookingService = $bookingService;
parent::__construct($id, $module, $config);
}
}

如果你從瀏覽器中存取這個控制器，你將看到一個報錯資訊，提醒你 BookingInterface 無法被範例化。這是因為你需要告訴 DI 容器怎樣處理這個依賴關係。

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

現在如果你再次存取這個控制器，一個 app\components\BookingService 的範例就會被建立並被作為第三個引數注入到控制器的構造器中。

什麼時候註冊依賴關係

由於依賴關係在建立新物件時需要解決，因此它們的註冊應該儘早完成。如下是推薦的實踐：

如果你是一個應用程式的開發者，你可以在應用程式的入口指令碼或者被入口指令碼引入的指令碼中註冊依賴關係。
如果你是一個可再分發擴充套件的開發者，你可以將依賴關係註冊到擴充套件的引導類中。

總結

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

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