# 依賴注入容器
依賴注入（Dependency Injection，DI）容器就是一個對象，它知道怎樣初始化并配置對象及其依賴的所有對象。[Martin 的文章](http://martinfowler.com/articles/injection.html)?已經解釋了 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 和屬性注入是通過[配置](http://www.yiichina.com/doc/guide/2.0/concept-configurations)提供支持的。當注冊一個依賴或創建一個新對象時，你可以提供一個配置，該配置會提供給容器用于通過相應的 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](http://www.yiichina.com/doc/guide/2.0/concept-configurations)?用于配置新創建的對象。例如：
~~~
// "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);
~~~
## 實踐中的運用
當在應用程序的[入口腳本](http://www.yiichina.com/doc/guide/2.0/structure-entry-scripts)中引入?`Yii.php`?文件時，Yii 就創建了一個 DI 容器。這個 DI 容器可以通過 Yii::$container 訪問。當調用 Yii::createObject() 時，此方法實際上會調用這個容器的 yii\di\Container::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`?的實例就會被創建并被作為第三個參數注入到控制器的構造器中。
## 什么時候注冊依賴關系
由于依賴關系在創建新對象時需要解決，因此它們的注冊應該盡早完成。如下是推薦的實踐：
* 如果你是一個應用程序的開發者，你可以在應用程序的[入口腳本](http://www.yiichina.com/doc/guide/2.0/structure-entry-scripts)或者被入口腳本引入的腳本中注冊依賴關系。
* 如果你是一個可再分發[擴展](http://www.yiichina.com/doc/guide/2.0/structure-extensions)的開發者，你可以將依賴關系注冊到擴展的引導類中。
## 總結
依賴注入和[服務定位器](http://www.yiichina.com/doc/guide/2.0/concept-service-locator)都是流行的設計模式，它們使你可以用充分解耦且更利于測試的風格構建軟件。強烈推薦你閱讀?[Martin 的文章](http://martinfowler.com/articles/injection.html)，對依賴注入和服務定位器有個更深入的理解。
Yii 在依賴住入（DI）容器之上實現了它的[服務定位器](http://www.yiichina.com/doc/guide/2.0/concept-service-locator)。當一個服務定位器嘗試創建一個新的對象實例時，它會把調用轉發到 DI 容器。后者將會像前文所述那樣自動解決依賴關系。
- 介紹（Introduction）
- 關于 Yii（About Yii）
- 從 Yii 1.1 升級（Upgrading from Version 1.1）
- 入門（Getting Started）
- 安裝 Yii（Installing Yii）
- 運行應用（Running Applications）
- 第一次問候（Saying Hello）
- 使用 Forms（Working with Forms）
- 玩轉 Databases（Working with Databases）
- 用 Gii 生成代碼（Generating Code with Gii）
- 更上一層樓（Looking Ahead）
- 應用結構（Application Structure）
- 結構概述（Overview）
- 入口腳本（Entry Scripts）
- 應用（Applications）
- 應用組件（Application Components）
- 控制器（Controllers）
- 模型（Models）
- 視圖（Views）
- 模塊（Modules）
- 過濾器（Filters）
- 小部件（Widgets）
- 前端資源（Assets）
- 擴展（Extensions）
- 請求處理（Handling Requests）
- 運行概述（Overview）
- 引導（Bootstrapping）
- 路由引導與創建 URL（Routing and URL Creation）
- 請求（Requests）
- 響應（Responses）
- Sessions and Cookies
- 錯誤處理（Handling Errors）
- 日志（Logging）
- 關鍵概念（Key Concepts）
- 組件（Components）
- 屬性（Properties）
- 事件（Events）
- 行為（Behaviors）
- 配置（Configurations）
- 別名（Aliases）
- 類自動加載（Class Autoloading）
- 服務定位器（Service Locator）
- 依賴注入容器（Dependency Injection Container）
- 配合數據庫工作（Working with Databases）
- 數據庫訪問（Data Access Objects）: 數據庫連接、基本查詢、事務和模式操作
- 查詢生成器（Query Builder）: 使用簡單抽象層查詢數據庫
- 活動記錄（Active Record）: 活動記錄對象關系映射（ORM），檢索和操作記錄、定義關聯關系
- 數據庫遷移（Migrations）: 在團體開發中對你的數據庫使用版本控制
- Sphinx
- Redis
- MongoDB
- ElasticSearch
- 接收用戶數據（Getting Data from Users）
- 創建表單（Creating Forms）
- 輸入驗證（Validating Input）
- 文件上傳（Uploading Files）
- 收集列表輸入（Collecting Tabular Input）
- 多模型同時輸入（Getting Data for Multiple Models）
- 顯示數據（Displaying Data）
- 格式化輸出數據（Data Formatting）
- 分頁（Pagination）
- 排序（Sorting）
- 數據提供器（Data Providers）
- 數據小部件（Data Widgets）
- 操作客戶端腳本（Working with Client Scripts）
- 主題（Theming）
- 安全（Security）
- 認證（Authentication）
- 授權（Authorization）
- 處理密碼（Working with Passwords）
- 客戶端認證（Auth Clients）
- 安全領域的最佳實踐（Best Practices）
- 緩存（Caching）
- 概述（Overview）
- 數據緩存（Data Caching）
- 片段緩存（Fragment Caching）
- 分頁緩存（Page Caching）
- HTTP 緩存（HTTP Caching）
- RESTful Web 服務
- 快速入門（Quick Start）
- 資源（Resources）
- 控制器（Controllers）
- 路由（Routing）
- 格式化響應（Response Formatting）
- 授權驗證（Authentication）
- 速率限制（Rate Limiting）
- 版本化（Versioning）
- 錯誤處理（Error Handling）
- 開發工具（Development Tools）
- 調試工具欄和調試器（Debug Toolbar and Debugger）
- 使用 Gii 生成代碼（Generating Code using Gii）
- TBD 生成 API 文檔（Generating API Documentation）
- 測試（Testing）
- 概述（Overview）
- 搭建測試環境（Testing environment setup）
- 單元測試（Unit Tests）
- 功能測試（Functional Tests）
- 驗收測試（Acceptance Tests）
- 測試夾具（Fixtures）
- 高級專題（Special Topics）
- 高級應用模版（Advanced Project Template）
- 從頭構建自定義模版（Building Application from Scratch）
- 控制臺命令（Console Commands）
- 核心驗證器（Core Validators）
- 國際化（Internationalization）
- 收發郵件（Mailing）
- 性能優化（Performance Tuning）
- 共享主機環境（Shared Hosting Environment）
- 模板引擎（Template Engines）
- 集成第三方代碼（Working with Third-Party Code）
- 小部件（Widgets）
- Bootstrap 小部件（Bootstrap Widgets）
- jQuery UI 小部件（jQuery UI Widgets）
- 助手類（Helpers）
- 助手一覽（Overview）
- Array 助手（ArrayHelper）
- Html 助手（Html）
- Url 助手（Url）