Laravel神奇的IoC容器

原创

tiancityycf 2022-11-21 13:22:29 博主文章分类：PHP ©著作权

©著作权归作者所有：来自51CTO博客作者tiancityycf的原创作品，请联系作者获取转载授权，否则将追究法律责任

Laravel 的核心就是一个 IoC 容器，根据文档，称其为“服务容器”

通过举例来让读者去理解什么是 IoC（控制反转）和 DI（依赖注入）

超人和超能力，依赖的产生！

我们把一个“超人”作为一个类，一个超人肯定拥有至少一个超能力，这个超能力也可以抽象为一个对象。

class Power {
    /**
     * 能力值
     */
    protected $ability;
 
    /**
     * 能力范围或距离
     */
    protected $range;
 
    public function __construct($ability, $range)
    {
        $this->ability = $ability;
        $this->range = $range;
    }
}

让一个“超人”创建的时候被赋予一个超能力

class Superman
{
    protected $power;
 
    public function __construct()
    {
        $this->power = new Power(999, 100);
    }
}

“超人”和“超能力”之间不可避免的产生了一个依赖。

我们假设超人可以有以下多种超能力：

飞行，属性有：飞行速度、持续飞行时间
蛮力，属性有：力量值

我们创建了如下类：

class Flight
{
    protected $speed;
    protected $holdtime;
    public function __construct($speed, $holdtime) {}
}
 
class Force
{
    protected $force;
    public function __construct($force) {}
}

在超人初始化的时候，我们会根据需要来实例化其拥有的超能力

class Superman
{
    protected $power;
 
    public function __construct()
    {
        $this->power = new Fight(9, 100);
        // $this->power = new Force(45);
    }
}

我们需要自己手动的在构造函数内实例化一系列需要的类，如果我们要改变超人的超能力，我还得重新制造个超人。

为什么不可以这样呢？超人的能力可以被随时更换，只需要添加或者更新一个芯片。外部创造超能力芯片，植入超人体内的某一个接口，这个接口是一个既定的，只要这个 “芯片” 满足这个接口的都可以被超人所利用。

这种由外部负责其依赖需求的行为，我们可以称其为 “控制反转（IoC）”。

工厂模式，依赖转移！

我们可以想到，芯片是一种可被生产的玩意儿，生产的地方当然是 “工厂（Factory）”。

我们为了给超人制造芯片，我们创建了一个工厂，它可以制造各种各样的芯片，且仅需要通过一个方法：

class SuperModuleFactory
{
    public function makeModule($moduleName, $options)
    {
        switch ($moduleName) {
            case 'Fight':   return new Fight($options[0], $options[1]);
            case 'Force':   return new Force($options[0]);
        }
    }
}

超人创建之初就可以使用这个工厂

class Superman
{
    protected $power;
 
    public function __construct()
    {
        // 初始化工厂
        $factory = new SuperModuleFactory;
 
        // 通过工厂提供的方法制造需要的模块
        $this->power = $factory->makeModule('Fight', [9, 100]);
        // $this->power = $factory->makeModule('Force', [45]);
    }
}

我们不再需要在超人初始化之初，去初始化许多第三方类，只需初始化一个工厂类，即可满足需求。但这样似乎和以前区别不大，只是没有那么多 new 关键字。其实我们稍微改造一下这个类，你就明白，工厂类的真正意义和价值了。

class Superman
{
    protected $power;
 
    public function __construct(array $modules)
    {
        // 初始化工厂
        $factory = new SuperModuleFactory;
        // 通过工厂提供的方法制造需要的模块
        foreach ($modules as $moduleName => $moduleOptions) {
            $this->power[] = $factory->makeModule($moduleName, $moduleOptions);
        }
    }
}
 
// 创建超人
$superman = new Superman([
    'Fight' => [9, 100], 
    'Shot' => [99, 50, 2]
    ]);

现在，“超人” 的创建不再依赖任何一个 “超能力” 的类，我们如若修改了或者增加了新的超能力，只需要针对修改 SuperModuleFactory 即可

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

由 “超人” 对 “超能力” 的依赖变成 “超人” 对 “超能力芯片工厂” 的依赖后，依赖并未解除，只是由原来对多个外部的依赖变成了对一个 “工厂” 的依赖。

工厂模式的缺点就是：接口未知、产生对象类型单一，还是不够灵活。虽然如此，工厂模式依旧十分优秀，并且适用于绝大多数情况。

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

如果有新的、高级的芯片加入，我们必须修改工厂类（好比增加新的生产线）：

class SuperModuleFactory
{
    public function makeModule($moduleName, $options)
    {
        switch ($moduleName) {
            case 'Fight':   return new Fight($options[0], $options[1]);
            case 'Force':   return new Force($options[0]);
            // case 'more': .......
            // case 'and more': .......
            // case 'and more': .......
            // case 'oh no! its too many!': .......
        }
    }
}

下一步就是我们今天的主要配角 —— DI （依赖注入）

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

interface SuperModuleInterface
{
    /**
     * 超能力激活方法
     *
     * 任何一个超能力都得有该方法，并拥有一个参数
     *@param array $target 针对目标，可以是一个或多个，自己或他人
     */
    public function activate(array $target);
}

我们定下了一个接口（超能力芯片的规范、契约），所有被创造的芯片必须遵守该规范，才能被生产。

其实，这就是 php 中接口（ interface ）的用处和意义！这种由编程语言本身提出的硬性规范，会增加更多优秀的特性。

这时候，那些提出更好的超能力芯片的高智商人才，遵循这个接口，创建了下述芯片类：

/**
 * X-超能量
 */
class XPower implements SuperModuleInterface
{
    public function activate(array $target)
    {
        // 这只是个例子。。具体自行脑补
    }
}
 
/**
 * 终极炸弹 （就这么俗）
 */
class UltraBomb implements SuperModuleInterface
{
    public function activate(array $target)
    {
        // 这只是个例子。。具体自行脑补
    }
}

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

class Superman
{
    protected $module;
 
    public function __construct(SuperModuleInterface $module)
    {
        $this->module = $module
    }
}

现在，当我们初始化 “超人” 类的时候，提供的芯片实例必须是一个 SuperModuleInterface 接口的实现。否则就会提示错误。

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

这就是依赖注入的实现方式。

什么叫做依赖注入？

本文从开头到现在提到的一系列依赖，只要不是由内部生产（比如初始化、构造函数 __construct 中通过工厂方法、自行手动 new 的），而是由外部以参数或其他形式注入的，都属于依赖注入（DI）。是不是豁然开朗？事实上，就是这么简单。下面就是一个典型的依赖注入：

// 超能力芯片 $superModule = new XPower; // 初始化一个超人，并注入一个超能力芯片依赖 $superMan = new Superman($superModule);

大家应该看出来了，手动的创建了一个超能力芯片、手动的创建超人并注入了刚刚创建超能力芯片。一切都是手动。

如此低效率产出超人是不现实，我们需要自动化，更为先进的工厂 —— IoC 容器

class Container
{
    protected $binds;
 
    protected $instances;
 
    public function bind($abstract, $concrete)
    {
        if ($concrete instanceof Closure) {
            $this->binds[$abstract] = $concrete;
        } else {
            $this->instances[$abstract] = $concrete;
        }
    }
 
    public function make($abstract, $parameters = [])
    {
        if (isset($this->instances[$abstract])) {
            return $this->instances[$abstract];
        }
 
        array_unshift($parameters, $this);
 
        return call_user_func_array($this->binds[$abstract], $parameters);
    }
}

这时候，一个十分粗糙的容器就诞生了。看看这个容器如何使用吧！

// 创建一个容器（后面称作超级工厂）
$container = new Container;
 
// 向该 超级工厂 添加 超人 的生产脚本
$container->bind('superman', function($container, $moduleName) {
    return new Superman($container->make($moduleName));
});
 
// 向该 超级工厂 添加 超能力芯片 的生产脚本
$container->bind('xpower', function($container) {
    return new XPower;
});
 
// 同上
$container->bind('ultrabomb', function($container) {
    return new UltraBomb;
});
 
// ******************  华丽丽的分割线  **********************
// 开始启动生产
$superman_1 = $container->make('superman', ['xpower']);
$superman_2 = $container->make('superman', ['ultrabomb']);
$superman_3 = $container->make('superman', ['xpower']);
// ...随意添加

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

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

实际上，真正的 IoC 容器更为高级。我们现在的例子中，还是需要手动提供超人所需要的芯片参数，但真正的 IoC 容器会根据类的依赖需求，自动在注册、绑定的一堆实例中搜寻符合的依赖需求，并自动注入到构造函数参数中去。Laravel 框架的服务容器正是这么做的。

不过我告诉大家，这种自动搜寻依赖需求的功能，是通过反射（Reflection）实现的，恰好的，php 完美的支持反射机制！

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

现在，到目前为止，我们已经不再惧怕怪兽们了。高智商人才集思广益，井井有条，根据接口契约创造规范的超能力芯片。

类需要绑定、注册至容器中，才能被“制造”。既然 laravel 称这个容器叫做服务容器，那么我们需要某个服务，就得先注册、绑定这个服务到容器，那么提供服务并绑定服务至容器的东西，就是服务提供者（ServiceProvider）。

为了保证初始化阶段不会出现所需要的模块和组件没有注册的情况，laravel 将注册和初始化行为进行拆分，注册的时候就只能注册，初始化的时候就是初始化。拆分后的产物就是现在的服务提供者。

服务提供者主要分为两个部分，register（注册）和 boot（引导、初始化），具体参考文档。register 负责进行向容器注册“脚本”，但要注意注册部分不要有对未知事物的依赖，如果有，就要移步至 boot 部分。

常用的绑定服务到容器的方法有instance, bind, singleton, alias。下面我们分别来看一下。

instance

将一个已存在的对象绑定到服务容器里，随后通过名称解析该服务时，容器将总返回这个绑定的实例。

$api = new HelpSpot\API(new HttpClient);
$this->app->instance('HelpSpot\Api', $api);

会把对象注册到服务容器的$instnces属性里

［ 'HelpSpot\Api' => $api//$api是API类的对象，这里简写了］

bind

绑定服务到服务容器

有三种绑定方式:

1、绑定自身

$this->app->bind('HelpSpot\API', null);

2、绑定闭包

$this->app->bind('HelpSpot\API', function () {
    return new HelpSpot\API();
});//闭包直接提供类实现方式
$this->app->bind('HelpSpot\API', function ($app) {
    return new HelpSpot\API($app->make('HttpClient'));
});//闭包返回需要依赖注入的类

3、绑定接口和实现

$this->app->bind('Illuminate\Tests\Container\IContainerContractStub', 'Illuminate\Tests\Container\ContainerImplementationStub');

针对第一种情况，其实在bind方法内部会在绑定服务之前通过getClosure()为服务生成闭包

alias 方法在上面讲bind方法里有用到过，它会把把服务别名和服务类的对应关系注册到服务容器的$aliases属性里。

例如:

$this->app->alias('\Illuminate\ServiceName', 'service_alias');

绑定完服务后在使用时就可以通过

$this->app->make('service_alias');

将服务对象解析出来，这样make的时候就不用写那些比较长的类名称了，对make方法的使用体验上有很大提升。

上一篇：innodb中内存管理机制BufferPool

下一篇：lumen项目集成laravelS后sentry无法上报的问题

提问和评论都可以，用心的回复会被更多人看到评论

发布评论

相关文章

官方博客	全部文章	热门标签	班级博客
了解我们	网站地图	意见反馈

鸿蒙开发者社区	51CTO学堂
51CTO	软考资讯