依赖注入容器 - Yii2教程
依赖注入容器
依赖注入(Dependency Injection，DI)容器就是一个对象，它知道怎样初始化并配置对象及其依赖的所有对象。Martin 的文章 已经解释了 DI 容器为什么很有用。这里我们主要讲解 Yii 提供的 DI 容器的使用方法。
依赖注入
Yii 通过 yii\di\Container 类提供 DI 容器特性。它支持如下几种类型的依赖注入：
- 构造方法注入;
- Setter 和属性注入;
- PHP 回调注入.
构造方法注入
在参数类型提示的帮助下，DI 容器实现了构造方法注入。当容器被用于创建一个新对象时，类型提示会告诉它要依赖什么类或接口。容器会尝试获取它所依赖的类或接口的实例，然后通过构造器将其注入新的对象。例如：
1. class Foo
2. {
3. public function __construct(Bar $bar)
4. {
5. }
6. }
8. $foo = $container->get('Foo');
9. // 上面的代码等价于：
10. $bar = new Bar;
11. $foo = new Foo($bar);
Setter 和属性注入
Setter 和属性注入是通过配置提供支持的。当注册一个依赖或创建一个新对象时，你可以提供一个配置，该配置会提供给容器用于通过相应的 Setter 或属性注入依赖。例如：
1. use yii\\base\\Object;
3. class Foo extends Object
4. {
5. public $bar;
7. private $_qux;
9. public function getQux()
10. {
11. return $this->_qux;
12. }
14. public function setQux(Qux $qux)
15. {
16. $this->_qux = $qux;
17. }
18. }
20. $container->get('Foo', [], [
21. 'bar' => $container->get('Bar'),
22. 'qux' => $container->get('Qux'),
23. ]);
PHP 回调注入
这种情况下，容器将使用一个注册过的 PHP 回调创建一个类的新实例。回调负责解决依赖并将其恰当地注入新创建的对象。例如：
1. $container->set('Foo', function () {
2. return new Foo(new Bar);
3. });
5. $foo = $container->get('Foo');
注册依赖关系
可以用 yii\di\Container::set() 注册依赖关系。注册会用到一个依赖关系名称和一个依赖关系的定义。依赖关系名称可以是一个类名，一个接口名或一个别名。依赖关系的定义可以是一个类名，一个配置数组，或者一个 PHP 回调。
1. $container = new \\yii\\di\\Container;
3. // 注册一个同类名一样的依赖关系，这个可以省略。
4. $container->set('yii\\db\\Connection');
6. // 注册一个接口
7. // 当一个类依赖这个接口时，相应的类会被初始化作为依赖对象。
8. $container->set('yii\\mail\\MailInterface', 'yii\\swiftmailer\\Mailer');
10. // 注册一个别名。
11. // 你可以使用 $container->get('foo') 创建一个 Connection 实例
12. $container->set('foo', 'yii\\db\\Connection');
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. ]);
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. ]);
33. // 注册一个 PHP 回调
34. // 每次调用 $container->get('db') 时，回调函数都会被执行。
35. $container->set('db', function ($container, $params, $config) {
36. return new \\yii\\db\\Connection($config);
37. });
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');
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;
3. use yii\\base\\Object;
4. use yii\\db\\Connection;
5. use yii\\di\\Container;
7. interface UserFinderInterface
8. {
9. function findUser();
10. }
12. class UserFinder extends Object implements UserFinderInterface
13. {
14. public $db;
16. public function __construct(Connection $db, $config = [])
17. {
18. $this->db = $db;
19. parent::__construct($config);
20. }
22. public function findUser()
23. {
24. }
25. }
27. class UserLister extends Object
28. {
29. public $finder;
31. public function __construct(UserFinderInterface $finder, $config = [])
32. {
33. $this->finder = $finder;
34. parent::__construct($config);
35. }
36. }
38. $container = new Container;
39. $container->set('yii\\db\\Connection', [
40. 'dsn' => '...',
41. ]);
42. $container->set('app\\models\\UserFinderInterface', [
43. 'class' => 'app\\models\\UserFinder',
44. ]);
45. $container->set('userLister', 'app\\models\\UserLister');
47. $lister = $container->get('userLister');
49. // 等价于:
51. $db = new \\yii\\db\\Connection(['dsn' => '...']);
52. $finder = new UserFinder($db);
53. $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;
3. use yii\\web\\Controller;
4. use app\\components\\BookingInterface;
6. class HotelController extends Controller
7. {
8. protected $bookingService;
10. public function __construct($id, $module, BookingInterface $bookingService, $config = [])
11. {
12. $this->bookingService = $bookingService;
13. parent::__construct($id, $module, $config);
14. }
15. }
如果你从浏览器中访问这个控制器，你将看到一个报错信息，提醒你 BookingInterface 无法被实例化。这是因为你需要告诉 DI 容器怎样处理这个依赖关系。
1. \\Yii::$container->set('app\\components\\BookingInterface', 'app\\components\\BookingService');
现在如果你再次访问这个控制器，一个 app\components\BookingService 的实例就会被创建并被作为第三个参数注入到控制器的构造器中。
什么时候注册依赖关系
由于依赖关系在创建新对象时需要解决，因此它们的注册应该尽早完成。如下是推荐的实践：
总结
依赖注入和服务定位器都是流行的设计模式，它们使你可以用充分解耦且更利于测试的风格构建软件。强烈推荐你阅读 Martin 的文章 ，对依赖注入和服务定位器有个更深入的理解。
Yii 在依赖住入(DI)容器之上实现了它的服务定位器。当一个服务定位器尝试创建一个新的对象实例时，它会把调用转发到 DI 容器。后者将会像前文所述那样自动解决依赖关系。