©
This document usesPHP Chinese website manualRelease
依赖注入(Dependency Injection,DI)容器就是一个对象,它知道怎样初始化并配置对象及其依赖的所有对象。Martin 的文章 已经解释了 DI 容器为什么很有用。这里我们主要讲解 Yii 提供的 DI 容器的使用方法。
Yii 通过 yii\di\Container 类提供 DI 容器特性。它支持如下几种类型的依赖注入:
在参数类型提示的帮助下,DI 容器实现了构造方法注入。当容器被用于创建一个新对象时,类型提示会告诉它要依赖什么类或接口。容器会尝试获取它所依赖的类或接口的实例,然后通过构造器将其注入新的对象。例如:
classFoo{publicfunction__construct(Bar$bar){ } }$foo=$container->get('Foo');// 上面的代码等价于:$bar=newBar;$foo=newFoo($bar);
Setter 和属性注入是通过配置提供支持的。当注册一个依赖或创建一个新对象时,你可以提供一个配置,该配置会提供给容器用于通过相应的 Setter 或属性注入依赖。例如:
useyii\base\Object;classFooextendsObject{public$bar;private$_qux;publicfunctiongetQux(){return$this->_qux; }publicfunctionsetQux(Qux$qux){$this->_qux =$qux; } }$container->get('Foo', [], ['bar'=>$container->get('Bar'),'qux'=>$container->get('Qux'), ]);
这种情况下,容器将使用一个注册过的 PHP 回调创建一个类的新实例。回调负责解决依赖并将其恰当地注入新创建的对象。例如:
$container->set('Foo',function(){returnnewFoo(newBar); });$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){returnnew\yii\db\Connection($config); });// 注册一个组件实例// $container->get('pageCache') 每次被调用时都会返回同一个实例。$container->set('pageCache',newFileCache);
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
实例。
namespaceapp\models;useyii\base\Object;useyii\db\Connection;useyii\di\Container;interfaceUserFinderInterface{functionfindUser(); }classUserFinderextendsObjectimplementsUserFinderInterface{public$db;publicfunction__construct(Connection$db,$config= []){$this->db =$db;parent::__construct($config); }publicfunctionfindUser(){ } }classUserListerextendsObject{public$finder;publicfunction__construct(UserFinderInterface$finder,$config= []){$this->finder =$finder;parent::__construct($config); } }$container=newContainer;$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=newUserFinder($db);$lister=newUserLister($finder);
当在应用程序的入口脚本中引入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 容器帮你自动解决这个依赖关系。
namespaceapp\controllers;useyii\web\Controller;useapp\components\BookingInterface;classHotelControllerextendsController{protected$bookingService;publicfunction__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 的文章 ,对依赖注入和服务定位器有个更深入的理解。