IoC 容器, laravel 的核心

IoC 容器,根据文档,称其为“服务容器”,顾名思义,该容器提供了整个框架中需要的一系列服务。作为初学者,很多人会在这一个概念上犯难,因此,我打算从一些基础的内容开始讲解,通过理解面向对象开发中依赖的产生和解决方法,来逐渐揭开“依赖注入”的面纱,逐渐理解这一神奇的设计理念。本文一大半内容都是通过举例来让读者去理解什么是 IoC(控制反转) 和 DI(依赖注入),通过理解这些概念,来更加深入。更多关于 laravel 服务容器的用法建议阅读文档即可。

IoC 容器诞生的故事

讲解 IoC 容器有很多的文章,我之前也写过。但现在我打算利用当下的灵感重新来过,那么开始吧。

超人和超能力,依赖的产生!

接口还有对象。这其中,接口是类的原型,一个类必须要遵守其实现的接口;对象则是一个类实例化后的产物,我们称其为一个实例。当然这样说肯定不利于理解,我们就实际的写点中看不中用的代码辅助学习。

怪物横行的世界,总归需要点超级人物来摆平。

我们把一个“超人”作为一个类,

    1. class Superman {}


    我们可以想象,一个超人诞生的时候肯定拥有至少一个超能力,这个超能力也可以抽象为一个对象,为这个对象定义一个描述他的类吧。一个超能力肯定有多种属性、(操作)方法,这个尽情的想象,但是目前我们先大致定义一个只有属性的“超能力”,至于能干啥,我们以后再丰富:

    1. class Power {
    2.     /**
    3.      * 能力值
    4.      */
    5.     protected $ability;
    6.  
    7.     /**
    8.      * 能力范围或距离
    9.      */
    10.     protected $range;
    11.  
    12.     public function __construct($ability, $range)
    13.     {
    14.         $this->ability = $ability;
    15.         $this->range = $range;
    16.     }
    17. }


    这时候我们回过头,修改一下之前的“超人”类,让一个“超人”创建的时候被赋予一个超能力:

    1. class Superman
    2. {
    3.     protected $power;
    4.  
    5.     public function __construct()
    6.     {
    7.         $this->power = new Power(999, 100);
    8.     }
    9. }


    这样的话,当我们创建一个“超人”实例的时候,同时也创建了一个“超能力”的实例,但是,我们看到了一点,“超人”和“超能力”之间不可避免的产生了一个依赖。

    所谓“依赖”,就是 “我若依赖你,我就不能离开你”。

    在一个贯彻面向对象编程的项目中,这样的依赖随处可见。少量的依赖并不会有太过直观的影响,我们随着这个例子逐渐铺开,让大家慢慢意识到,当依赖达到一个量级时,是怎样一番噩梦般的体验。当然,我也会自然而然的讲述如何解决问题。

    一堆乱麻 —— 可怕的依赖

    之前的例子中,超能力类实例化后是一个具体的超能力,但是我们知道,超人的超能力是多元化的,每种超能力的方法、属性都有不小的差异,没法通过一种类描述完全。我们现在进行修改,我们假设超人可以有以下多种超能力:

    • 飞行,属性有:飞行速度、持续飞行时间
    • 蛮力,属性有:力量值
    • 能量弹,属性有:伤害值、射击距离、同时射击个数

    我们创建了如下类:

    1. class Flight
    2. {
    3.     protected $speed;
    4.     protected $holdtime;
    5.     public function __construct($speed, $holdtime) {}
    6. }
    7.  
    8. class Force
    9. {
    10.     protected $force;
    11.     public function __construct($force) {}
    12. }
    13.  
    14. class Shot
    15. {
    16.     protected $atk;
    17.     protected $range;
    18.     protected $limit;
    19.     public function __construct($atk, $range, $limit) {}
    20. }

    为了省事儿我没有详细写出 __construct()

    好了,这下我们的超人有点“忙”了。在超人初始化的时候,我们会根据需要来实例化其拥有的超能力吗,大致如下:

    1. class Superman
    2. {
    3.     protected $power;
    4.  
    5.     public function __construct()
    6.     {
    7.         $this->power = new Fight(9, 100);
    8.         // $this->power = new Force(45);
    9.         // $this->power = new Shot(99, 50, 2);
    10.         /*
    11.         $this->power = array(
    12.             new Force(45),
    13.             new Shot(99, 50, 2)
    14.         );
    15.         */
    16.     }
    17. }


    新的 超能力,或者需要 变更 超能力的方法,我们必须 重新改造 超人。换句话说就是,改变超能力的同时,我还得重新制造个超人。效率太低了!新超人还没创造完成世界早已被毁灭。

    这时,灵机一动的人想到:为什么不可以这样呢?超人的能力可以被随时更换,只需要添加或者更新一个芯片或者其他装置啥的(想到钢铁侠没)。这样的话就不要整个重新来过了。

    对,就是这样的。

    控制反转(IoC)”。

    工厂模式,依赖转移!

    当然,实现控制反转的方法有几种。在这之前,不如我们先了解一些好玩的东西。

    我们可以想到,组件、工具(或者超人的模组),是一种可被生产的玩意儿,生产的地方当然是 “工厂(Factory)”,于是有人就提出了这样一种模式: 工厂模式。

    工厂模式”。

    我们为了给超人制造超能力模组,我们创建了一个工厂,它可以制造各种各样的模组,且仅需要通过一个方法:

    1. class SuperModuleFactory
    2. {
    3.     public function makeModule($moduleName, $options)
    4.     {
    5.         switch ($moduleName) {
    6.             case 'Fight':   return new Fight($options[0], $options[1]);
    7.             case 'Force':   return new Force($options[0]);
    8.             case 'Shot':    return new Shot($options[0], $options[1], $options[2]);
    9.         }
    10.     }
    11. }

    这时候,超人 创建之初就可以使用这个工厂!

    1. class Superman
    2. {
    3.     protected $power;
    4.  
    5.     public function __construct()
    6.     {
    7.         // 初始化工厂
    8.         $factory = new SuperModuleFactory;
    9.  
    10.         // 通过工厂提供的方法制造需要的模块
    11.         $this->power = $factory->makeModule('Fight', [9, 100]);
    12.         // $this->power = $factory->makeModule('Force', [45]);
    13.         // $this->power = $factory->makeModule('Shot', [99, 50, 2]);
    14.         /*
    15.         $this->power = array(
    16.             $factory->makeModule('Force', [45]),
    17.             $factory->makeModule('Shot', [99, 50, 2])
    18.         );
    19.         */
    20.     }
    21. }


    new

    1. class Superman
    2. {
    3.     protected $power;
    4.  
    5.     public function __construct(array $modules)
    6.     {
    7.         // 初始化工厂
    8.         $factory = new SuperModuleFactory;
    9.  
    10.         // 通过工厂提供的方法制造需要的模块
    11.         foreach ($modules as $moduleName => $moduleOptions) {
    12.             $this->power[] = $factory->makeModule($moduleName, $moduleOptions);
    13.         }
    14.     }
    15. }
    16.  
    17. // 创建超人
    18. $superman = new Superman([
    19.     'Fight' => [9, 100], 
    20.     'Shot' => [99, 50, 2]
    21.     ]);


    SuperModuleFactory

    再进一步!IoC 容器的重要组成 —— 依赖注入!

    由 “超人” 对 “超能力” 的依赖变成 “超人” 对 “超能力模组工厂” 的依赖后,对付小怪兽们变得更加得心应手。但这也正如你所看到的,依赖并未解除,只是由原来对多个外部的依赖变成了对一个 “工厂” 的依赖。假如工厂出了点麻烦,问题变得就很棘手。

    其实大多数情况下,工厂模式已经足够了。工厂模式的缺点就是:接口未知(即没有一个很好的契约模型,关于这个我马上会有解释)、产生对象类型单一。总之就是,还是不够灵活。虽然如此,工厂模式依旧十分优秀,并且适用于绝大多数情况。不过我们为了讲解后面的 依赖注入

    我们知道,超人依赖的模组,我们要求有统一的接口,这样才能和超人身上的注入接口对接,最终起到提升超能力的效果。

    事实上,我之前说谎了,不仅仅只有一堆小怪兽,还有更多的大怪兽。嘿嘿。额,这时候似乎工厂的生产能力显得有些不足 —— 由于工厂模式下,所有的模组都已经在工厂类中安排好了,如果有新的、高级的模组加入,我们必须修改工厂类(好比增加新的生产线):

    1. class SuperModuleFactory
    2. {
    3.     public function makeModule($moduleName, $options)
    4.     {
    5.         switch ($moduleName) {
    6.             case 'Fight':   return new Fight($options[0], $options[1]);
    7.             case 'Force':   return new Force($options[0]);
    8.             case 'Shot':    return new Shot($options[0], $options[1], $options[2]);
    9.             // case 'more': .......
    10.             // case 'and more': .......
    11.             // case 'and more': .......
    12.             // case 'oh no! its too many!': .......
    13.         }
    14.     }
    15. }


    看到没。。。噩梦般的感受!

    其实灵感就差一步!你可能会想到更为灵活的办法!对,下一步就是我们今天的主要配角 —— DI (依赖注入)

    由于对超能力模组的需求不断增大,我们需要集合整个世界的高智商人才,一起解决问题,不应该仅仅只有几个工厂垄断负责。不过高智商人才们都非常自负,认为自己的想法是对的,创造出的超能力模组没有统一的接口,自然而然无法被正常使用。这时我们需要提出一种契约,这样无论是谁创造出的模组,都符合这样的接口,自然就可被正常使用。

    1. interface SuperModuleInterface
    2. {
    3.     /**
    4.      * 超能力激活方法
    5.      *
    6.      * 任何一个超能力都得有该方法,并拥有一个参数
    7.      *@param array $target 针对目标,可以是一个或多个,自己或他人
    8.      */
    9.     public function activate(array $target);
    10. }

    上文中,我们定下了一个接口 (超能力模组的规范、契约),所有被创造的模组必须遵守该规范,才能被生产。

    其实,这就是 php 中 接口( interface ) 的用处和意义!很多人觉得,为什么 php 需要接口这种东西?难道不是 java 、 C# 之类的语言才有的吗?这么说,只要是一个正常的面向对象编程语言(虽然 php 可以面向过程),都应该具备这一特性。因为一个 对象(object) 本身是由他的模板或者原型 —— 类 (class)

    虽然有些绕,但通过我们接下来的实例,大家会慢慢领会接口带来的好处。

    这时候,那些提出更好的超能力模组的高智商人才,遵循这个接口,创建了下述(模组)类:

    1. /**
    2.  * X-超能量
    3.  */
    4. class XPower implements SuperModuleInterface
    5. {
    6.     public function activate(array $target)
    7.     {
    8.         // 这只是个例子。。具体自行脑补
    9.     }
    10. }
    11.  
    12. /**
    13.  * 终极炸弹 (就这么俗)
    14.  */
    15. class UltraBomb implements SuperModuleInterface
    16. {
    17.     public function activate(array $target)
    18.     {
    19.         // 这只是个例子。。具体自行脑补
    20.     }
    21. }


    同时,为了防止有些 “砖家” 自作聪明,或者一些叛徒恶意捣蛋,不遵守契约胡乱制造模组,影响超人,我们对超人初始化的方法进行改造:

    1. class Superman
    2. {
    3.     protected $module;
    4.  
    5.     public function __construct(SuperModuleInterface $module)
    6.     {
    7.         $this->module = $module
    8.     }
    9. }


    SuperModuleInterface

    正是由于超人的创造变得容易,一个超人也就不需要太多的超能力,我们可以创造多个超人,并分别注入需要的超能力模组即可。这样的话,虽然一个超人只有一个超能力,但超人更容易变多,我们也不怕怪兽啦!

    现在有人疑惑了,你要讲的 依赖注入

    其实,上面讲的内容,正是依赖注入。

    依赖注入__construct 中通过工厂方法、自行手动 new 的),而是由外部以参数或其他形式注入的,都属于 依赖注入(DI)

      1. // 超能力模组
      2. $superModule = new XPower;
      3.  
      4. // 初始化一个超人,并注入一个超能力模组依赖
      5. $superMan = new Superman($superModule);


      关于依赖注入这个本文的主要配角,也就这么多需要讲的。理解了依赖注入,我们就可以继续深入问题。慢慢走近今天的主角……

      更为先进的工厂 —— IoC 容器!

      刚刚列了一段代码:

      1. $superModule = new XPower;
      2.  
      3. $superMan = new Superman($superModule);


      读者应该看出来了,手动的创建了一个超能力模组、手动的创建超人并注入了刚刚创建超能力模组。呵呵,手动。

      现代社会,应该是高效率的生产,干净的车间,完美的自动化装配。

      IoC 容器

      1. class Container
      2. {
      3.     protected $binds;
      4.  
      5.     protected $instances;
      6.  
      7.     public function bind($abstract, $concrete)
      8.     {
      9.         if ($concrete instanceof Closure) {
      10.             $this->binds[$abstract] = $concrete;
      11.         } else {
      12.             $this->instances[$abstract] = $concrete;
      13.         }
      14.     }
      15.  
      16.     public function make($abstract, $parameters = [])
      17.     {
      18.         if (isset($this->instances[$abstract])) {
      19.             return $this->instances[$abstract];
      20.         }
      21.  
      22.         array_unshift($parameters, $this);
      23.  
      24.         return call_user_func_array($this->binds[$abstract], $parameters);
      25.     }
      26. }


      这时候,一个十分粗糙的容器就诞生了。现在的确很简陋,但不妨碍我们进一步提升他。先着眼现在,看看这个容器如何使用吧!

      1. // 创建一个容器(后面称作超级工厂)
      2. $container = new Container;
      3.  
      4. // 向该 超级工厂 添加 超人 的生产脚本
      5. $container->bind('superman', function($container, $moduleName) {
      6.     return new Superman($container->make($moduleName));
      7. });
      8.  
      9. // 向该 超级工厂 添加 超能力模组 的生产脚本
      10. $container->bind('xpower', function($container) {
      11.     return new XPower;
      12. });
      13.  
      14. // 同上
      15. $container->bind('ultrabomb', function($container) {
      16.     return new UltraBomb;
      17. });
      18.  
      19. // ******************  华丽丽的分割线  **********************
      20. // 开始启动生产
      21. $superman_1 = $container->make('superman', ['xpower']);
      22. $superman_2 = $container->make('superman', ['ultrabomb']);
      23. $superman_3 = $container->make('superman', ['xpower']);
      24. // ...随意添加


      绑定(bind) 操作,我们向 超级工厂 注册了一些生产脚本,这些生产脚本在生产指令下达之时便会执行。发现没有?我们彻底的解除了 超人 与 超能力模组 的依赖关系,更重要的是,容器类也丝毫没有和他们产生任何依赖!我们通过注册、绑定的方式向容器中添加一段可以被执行的回调(可以是匿名函数、非匿名函数、类的方法)作为生产一个类的实例的 脚本 ,只有在真正的 生产(make)

      这样一种方式,使得我们更容易在创建一个实例的同时解决其依赖关系,并且更加灵活。当有新的需求,只需另外绑定一个“生产脚本”即可。

      实际上,真正的 IoC 容器更为高级。我们现在的例子中,还是需要手动提供超人所需要的模组参数,但真正的 IoC 容器会根据类的依赖需求,自动在注册、绑定的一堆实例中搜寻符合的依赖需求,并自动注入到构造函数参数中去。Laravel 框架的服务容器正是这么做的。实现这种功能其实理论上并不麻烦,但我并不会在本文中写出,因为……我懒得写。

      不过我告诉大家,这种自动搜寻依赖需求的功能,是通过 反射(Reflection)

      http://php.net/manual/zh/book.reflection.php

      现在,到目前为止,我们已经不再惧怕怪兽们了。高智商人才集思广益,井井有条,根据接口契约创造规范的超能力模组。超人开始批量产出。最终,人人都是超人,你也可以是哦 !

      回归正常世界。我们开始重新审视 laravel 的核心。

      现在,我们开始慢慢解读 laravel 的核心。其实,laravel 的核心就是一个 IoC 容器,也恰好是我之前所说的高级的 IoC 容器。

      Route(路由)Eloquent ORM(数据库 ORM 组件)Request and Response(请求和响应)等等等等,实际上都是与核心无关的类模块提供的,这些类从注册到实例化,最终被你所使用,其实都是 laravel 的服务容器负责的。Route


      1. Route::get('/', function() {
      2.     // bla bla bla...
      3. });


      Route 类被定义在这个命名空间:Illuminate\Routing\Router,文件vendor/laravel/framework/src/Illuminate/Routing/Router.phpgetpostany

      服务提供者

      我们在前文介绍 IoC 容器的部分中,提到了,一个类需要绑定、注册至容器中,才能被“制造”。

      服务提供者(ServiceProvider)

      虽然,绑定一个类到容器不一定非要通过 服务提供者(ServiceProvider)但是,我们知道,有时候我们的类、模块会有需要其他类和组件的情况,为了保证初始化阶段不会出现所需要的模块和组件没有注册的情况,laravel 将注册和初始化行为进行拆分,注册的时候就只能注册,初始化的时候就是初始化。拆分后的产物就是现在的服务提供者。

      register(注册) 和 boot(引导、初始化),具体参考文档。register 负责进行向容器注册“脚本”,但要注意注册部分不要有对未知事物的依赖,如果有,就要移步至 boot

      Facade

      Route 的方法为何能以静态方法访问的问题。实际上这个问题文档上有写,简单说来就是模拟一个类,提供一个静态魔术方法__callStatic,并将该静态方法映射到真正的方法上。Route 类实际上是 Illuminate\Support\Facades\Route 通过 class_alias() 函数创造的 别名 而已,这个类被定义在文件vendor/laravel/framework/src/Illuminate/Support/Facades/Route.php

      我们打开文件一看……诶?怎么只有这么简单的一段代码呢?

      1. <?php namespace Illuminate\Support\Facades;
      2.  
      3. /**
      4.  * @see \Illuminate\Routing\Router
      5.  */
      6. class Route extends Facade {
      7.  
      8.     /**
      9.      * Get the registered name of the component.
      10.      *
      11.      * @return string
      12.      */
      13.     protected static function getFacadeAccessor()
      14.     {
      15.         return 'router';
      16.     }
      17.  
      18. }

      FacadegetFacadeAccessor 方法返回了一个 route,这是什么意思呢?事实上,这个值被一个 ServiceProvider