yii2依赖注入-CFANZ编程社区

以下是Yii2源码中，ServiceLocator（服务定位器（配置服务的参数信息））与Container（依赖注入容器（定义并解决依赖关系））的关系解析图。

一句话总结

Application继承了ServiceLocator，是一个服务器定位器，ServiceLocator用来管理和缓存组件的实例化对象。ServiceLocator调用Yii::createObject方法创建类得实例化对象，Yii::createObject实际上又调用了Container（依赖注入容器）获取每一个类的实例化对象。Container（依赖注入容器）自动解决待实例化类的依赖关系，并返回待实例化类的实例对象。

yii2依赖注入_实例化

依赖注入：

<?php  namespace app\controllers;

use yii\web\Controller;
use yii\di\Container;

class DependencyinjectController extends Controller{

    public function actionIndex(){
        $container = new Container();
        $container->set('app\controllers\Dirver','app\controllers\ManDriver');
        $car = $container->get('app\controllers\Car');
        $car->run();
    }

}

interface Dirver{
    public function drive();
}

class ManDriver implements  Dirver{
    public function drive(){
        echo 'i am an old man';
    }
}

class  Car{
    private $driver = null;
    public function __construct(ManDriver $driver)
    {
        $this->driver = $driver;
    }

    public function run(){
        $this->driver->drive();
    }
}


/**
 * 打印：i am an old man
 */

再看看一个例子：

一个简单的例子是：一个用户类表类，依赖于一个finder类来生成这个列表。而这个finder类呢，依赖于某个db来获取数据。在不考虑依赖注入的时候，程序可能会这样写：

$db = new \yii\db\Connection(['dsn' => '...']);
$finder = new UserFinder($db);
$lister = new UserLister($finder);

可是，当db的实现发生变化的时候，会引起应用程序的变化，finder类的实现发生变化的时候，会引起应用程序的变化。如果把db，finder看做插件，就需要一套机制来告诉应用程序，lister依赖于finder和db。

依赖注入的基本理就是用一个独立的对象作为组装器，该组装器用一个合适的实例提供给应用程序来使用。有三种类型的依赖注入，

构造函数注入：就是在构造函数的参数中提供组件的实现，在构造函数中把这种实现固化到应用程序中。
Setter 注入：专门通过setter函数实现以上的注入，
接口注入：通过接口的实现，达到依赖注入。

Yii2中的依赖注入

在yii中，我们可以发现第一和第二种类型应用，也就是构造函数注入和setter注入。yii2中的组装器是容器类（Container）。依赖的声明和依赖的注入是通过调用容器类的set和get方法来实现的。

整个过程分三步，

第一步是类的声明，在类的构造函数中，声明依赖关系。
第二部是容器参数的载入，告诉容器，要生成某个对象时，是用哪些参数，以及类来实现的。这个过程通过调用 set来完成
第三部实例的获取。调用容器的get函数，获取新创建的实例。

用容器来实现上面的用户列表的例子，可能是这样的。

// 创建容器
$container = new Container;

//指定如何生成yii\db\Connection，其中，yii\db\Connection 是类的名字
$container->set('yii\db\Connection', [
    'dsn' => '...',
]);

//指定如何生成 app\models\UserFinderInterface， 所用的类是userFinder
$container->set('app\models\UserFinderInterface', [
   'class' => 'app\models\UserFinder',
]);

//指定如何生成 UserLister
$container->set('userLister', 'app\models\UserLister');

//生成lister
$lister = $container->get('userLister');

看起来最后生成lister跟前面db 和UserFinderInterface 没有任何关系。这里面的秘密在于每个类的构造函数隐式地声明了类之间的依赖关系。

//首先声明一个接口类
              interface UserFinderInterface
              {
                  function findUser();
              }

             //UserFinder 实现这个接口类
              class UserFinder extends Object implements UserFinderInterface
              {
                  public $db;
                  //注意，第一个参数是Connection $db, 包含类的名字的
                  public function __construct(Connection $db, $config = [])
                  {
                      $this->db = $db;
                      parent::__construct($config);
                  }

                  public function findUser()
                  {
                  }
              }
             // UserLists 类， 构造函数的第一个参数声明了它依赖于UserFinderInterface.
              class UserLister extends Object
              {
                  public $finder;

                  public function __construct(UserFinderInterface $finder, $config = [])
                  {
                      $this->finder = $finder;
                      parent::__construct($config);
                  }
              }

容器的作用就是

set，指明实例的生成类和参数
在get的时候，根据构造函数分析依赖，根据依赖关系，生成相应的对象。

容器类的内部实现：

数据结构：容器类有几个比较重要的内部数组

/**
                 * @var array singleton objects indexed by their types
                 */
                private $_singletons = [];
                /**
                 * @var array object definitions indexed by their types
                 */
                private $_definitions = [];
                /**
                 * @var array constructor parameters indexed by object types
                 */
                private $_params = [];
                /**
                 * @var array cached ReflectionClass objects indexed by class/interface names
                 */
                private $_reflections = [];
                /**
                 * @var array cached dependencies indexed by class/interface names. Each class name
                 * is associated with a list of constructor parameter types or default values.
                 */
                private $_dependencies = [];

容器的重要函数：
                        public function set($class, $definition = [], array $params = [])
                        public function get($class, $params = [], $config = [])

　　　　　　　　set函数的作用是把一个类注册到容器中，这样容器就知道生成一个类的实例时，应该如何找依赖信息了。 set函数可以注册一个类名字，一个接口名字， 一个别名。注册的时候，还可以指定相应的配置信息 （配置信息的目的是把这些信息赋给生成的类实例）


                     最基本的就是，第一个参数就是键值，可以是类的名字，接口的名字，别名。而第二个参数是定义，可以是字符串，比如一个类的名字，接口的名字或者是别名；可以是数组，表示相应的配置信息；
还可以可以是一个PHP的可调用对象，该对象的参数为function ($container, $params, $config)。该对象在get()调用的时候被执行。$params 是构造函数的参数，$config 是对象的配置信息，常常是个数组。
 而$container是容器对象。 返回值是生成的对象，被get()返回。 set函数的第三个参数是生成对象的时候提供给构造函数的参数。


                    从set函数的源代码可以看出，第一个参数，即class，是作为前文提到的几个关键数组的键值的。定义放在_definitions中，参数放在_params中，

public function set($class, $definition = [], array $params = [])
                        {
                            $this->_definitions[$class] = $this->normalizeDefinition($class, $definition);
                            $this->_params[$class] = $params;
                            unset($this->_singletons[$class]);
                            return $this;
                        }

et函数负责根据set设置的依赖关系生成响应的对象实例。其中第一个参数class是用来访问容器中不同数组的键值，第二个参数是$params，跟set中提供的params合并以后，提供给类的构造函数。第三个参数config是配置信息(注 配置就是要给新生成的对象赋一些属性，
而参数是类的构造函数处理要处理的参数）

                    get函数首先从_definition中取出定义，根据其类型，做不同的处理，比如，如果它是一个函数，则把参数合并以后，调用set提供的函数。

                    新创建的对象实例是调用build方法来构建的。在这个build函数中， 首先要获取依赖。那么这个依赖从哪里来呢?


                    依赖从类的构造函数的反射分析中来。


                    方法是根据类的名字空间创建反射对象，取得构造函数，逐个分析构造函数的参数。某个参数有缺省的值，则把缺省值记录到依赖中来。如果一个参数有类，则根据类的名字，生成一个Instance 对象，记录类的名字，为后面依赖的解析作准备。

                    生成的反射信息放到_reflection数组中，依赖放到_dependency数组中。依赖需要解析，解析的过程就是生成实例的过程，递归调用get的过程。
                    处理过的依赖数组，作为参数，传给反射对象的newInstanceArgs，进而生成类的实例。其实质就是把带有类的指示的参数实例化了，而实例化是根据set函数预先定义的方法。


                    以上介绍的整个过程就是Yii2中利用container实现依赖注入的过程。可以看到，对依赖的注入是通过分析类的构造函数参数来实现的。 


依赖注入的使用：


                在yii中，主程序的配置就使用了这种基于容器的依赖注入。

                在yii/config/web.php 中config数组中组件 (components) 就是在指定元素的定义。在application的 preInit方法中，用户指定的这些components会跟系统的核心components融合。
                这些组件可以通过     \Yii::$app->componentID 的形式访问， 比如 \Yii::$app->cache. (这属于service locator 概念了) 组件在第一次访问的时候通过Yii::createObject静态函数实例化，实例化的过程就遵循了上文所说的依赖注入的过程。
                当然了，如果你指定要bootstrap某个组件, 比如下面。这样每一个请求来的时候，都会实例化该log组件。

'bootstrap' => [
        'log',
    ],），   
                

              以下是配置中components中的内容示例。

'components' => [
                    'request' => [
                        // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
                        'cookieValidationKey' => '...',
                    ],
                    'cache' => [
                        'class' => 'yii\caching\FileCache',
                    ],
                    'user' => [
                        'identityClass' => 'app\models\User',
                        'enableAutoLogin' => true,
                    ],
                    'errorHandler' => [
                        'errorAction' => 'site/error',
                    ],
                    'mailer' => [
                        'class' => 'yii\swiftmailer\Mailer',
                        // send all mails to a file by default. You have to set
                        // 'useFileTransport' to false and configure a transport
                        // for the mailer to send real emails.
                        'useFileTransport' => true,
                    ],
                    'log' => [
                        'traceLevel' => YII_DEBUG ? 3 : 0,
                        'targets' => [
                            [
                                'class' => 'yii\log\FileTarget',
                                'levels' => ['error', 'warning','profile'],
                            ],
                        ],
                    ],
                    'db' => require(__DIR__ . '/db.php'),

我把yii2的核心代码整合了一下，来说php实现依赖注入的过程。

在使用过yii2开发的同学，对Yii::createObject不陌生，他就是依赖注入的一个“入口”，我把它提出来改一下：

//$p 可以想象的yii2的配置文件，如$p = ['class'=>'sdk/Test', 'file'=>'xxxx'];
// 'class' 是将要实现的类，‘file’是将要实现的对象的属性
function createObject($p){
    $class = $p['class'];
    unset($p['class']);
    $obj = new $class;//require 使用的是 autoload 实现的
    foreach($p as $f => $v){
        $class->$f = $v;    
    }
 
    return $obj;
}

Yii框架php反射类的使用

//创建$class类的反射类实例对象

    $reflection = new ReflectionClass($class);

    //获取$class类的构造器对象

    $constructor = $reflection->getConstructor();

    if ($constructor !== null) {

       //获取构造方法参数列表$constructor->getParameters()

       foreach ($constructor->getParameters() as $param) {

       //构造参数是否有可利用默认值

          if ($param->isDefaultValueAvailable()) {

              $dependencies[] = $param->getDefaultValue();

          } else {

             //获取参数的类名称

              $c = $param->getClass();

              $dependencies[] = Instance::of($c === null ? null : $c->getName());

          }

       }

    }

         

    $reflection->isInstantiable();//对象是否可实例化

    $reflection->newInstanceArgs($dependencies);//实例化反射对象