Container

Constanze Standard: Container 是一个简单专一的 PSR-11 容器组件，它提供容器化解决方案所需的基础功能和基本组件，包括：容器（Container）和服务提供接口（Service Provider）。

如何获取组件？

请使用 composer 安装组件，这可能需要几分钟的时间。

composer require constanze-standard/container

主要功能

Container 是符合主流标准的，它是 Fig PSR-11 的一种实现。
Entity Providers 允许你针对 container 打包你的代码或配置，以便重复使用，并在一定程度上避免不必要的 entity 定义。
Make Factory 强化了控制反转的功能，使你可以根据需要通过容器创建新实例，现在你可以将对象的实例化工作完全交给容器了。

案例演示

添加和获取

通过案例演示，有助于我们研究和理解 Container 的工作方式，现在我们向 Container 中，添加一个名为 foo 的静态内容（bar），然后再将内容从 Container 中取出。

<?php declare(strict_types=1);

use ConstanzeStandard\Container\Container;
use ConstanzeStandard\Container\Entity;

$container = new Container();
$entity = new Entity('foo', 'bar');
$container->addEntity($entity);

$foo = $container->get('foo');
var_dump($foo);  // foo

以上是 Container 的一个基本使用场景，当我们从 Container 获取内容（entity）时，默认情况下，容器会将传入的内容原封不动的返回。

像大部分容器组件一样，Container 也支持 entity 的 definition, definition 是一个内容的定义，它是一个返回 entity 的可调用对象，其中定义了 entity 的创建步骤。当 get 方法被调用时，Container 会先通过 definition 对象生成 entity，然后再将 entity 放入容器并返回。

use ConstanzeStandard\Container\Container;
use ConstanzeStandard\Container\Entity;
use ConstanzeStandard\Container\Interfaces\EntityInterface;

$container = new Container();
$entity = new Entity('foo', function () {
    return 'bar';
}, EntityInterface::TYPE_DEFINITION);
$container->addEntity($entity);

$foo = $container->get('foo');
var_dump($foo);  // foo

Entity 构造方法的第三个参数设为 true 表示该 entity 是一个 definition（默认为 false）。

你也可以使用 Container 的 add 方法创建和添加 entity，它的参数与 Entity 的构造方法相同，并会返回创建的 entity 对象。以上示例的也可以用 add 方法完成。

$container->add('foo', function () {
    return 'bar';
}, EntityInterface::TYPE_DEFINITION);

$foo = $container->get('foo');
var_dump($foo);  // foo

实际上，add 方法内部分别做了与前两例相似的操作，这是一种便利且被经常使用的代理方法。

对 Entity 使用别名

我们可以为一个 entity 定义多个不同的别名，Container 将保存这些别名，并将它们指向同一个 entity.

$container->alias('aliasName', 'entityName');

从 Container 中以 aliasName 获取的值与 entityName 的内容是相同的。

判断和删除操作

Container 支持 PSR-11 中所定义的 has 方法，用来判断一个 entity 是否存在。同时 Container 也支持删除指定名称的 entity 的 remove 方法。

$container->has('foo');  // 判断名为 foo 的 entity 是否存在
$container->remove('foo');  // 从 Container 中删除名为 foo 的 entity

Definition

Definition 是很常用的功能，下面介绍一些与 Definition 相关的功能和要点。

实例化工厂 Make Factory

Container 的 make 方法允许你控制 entity 的获取方式，在通常情况下，我们用 get 方法获取的内容是全局唯一的，也就是说，entity 只会被创建一次，当我们再次获取时，Container 会直接将之前保存的值返回。如果我们希望重新生成 entity，就可以使用 make 方法。

$container->add('foo', function($foo) {
    return $foo;
}, EntityInterface::TYPE_DEFINITION);

$result = $container->make('foo', 'FOO VALUE');
var_dump($result);  // FOO VALUE

make 方法允许你为 Definition 添加任意数量的自定义参数，但需要注意的是，如果自定义参数没有默认值的话，用 get 方法获取时会出现错误。

make 方法在对服务创建的控制反转（IoC）中有极大的作用，它使容器有机会去控制那些非单例对象的创建，通过依赖查找的方式使系统中所有的对象创建工作，全部移交给容器完成。

静态绑定的参数

有时，一些 definition 需要额外的数据源用来生成 entity，这时，我们可以通过 addArguments 方法为 definition 提前绑定一些静态参数。

$container->add('foo', function ($container, $customArg) {
    return $customArg;
}, EntityInterface::TYPE_DEFINITION)->addArguments($container);

$container->make('foo', 'CustomArg');

addArguments 方法接受任意数量的参数，这些参数将在 definition 被调用时直接作为参数按顺序传入。这些参数将排在自定义参数之前。

我们也可以通过 Container 的 withEntityArguments 方法，为之后的每一个 Entity 添加一个或多个统一的静态参数。

$container->withEntityArguments($container);

$container->add('helloFoo', function ($container) {
    $foo = $container->get('Foo');
    return 'Hello ' . $foo;
}, EntityInterface::TYPE_DEFINITION)

需要注意的是，当我们使用 make 方法时，不需要传递静态参数，只需要按顺序传递自定义参数就可以了。

Entity 的提供者（Entity Provider）

在某些业务层面中，服务是以组的形式存在的，组与组之间有着比较独立的依赖关系，面对这种情况，将所有的 entries 和 definitions “一股脑”的装入容器是不太聪明的做法。而 Entity Provider 就是为这种场景而设计的功能。

一个 EntityProvider 承载了一系列针对 Container 的读写或配置操作：

use ConstanzeStandard\Container\AbstractEntityProvider;
use ConstanzeStandard\Container\Container;

class CustomEntityProvider extends AbstractEntityProvider
{
    protected $provides = [
        'foo'
    ];

    public function register(ContainerInterface $container)
    {
        $container->add('foo', function () {
            return 'bar';
        }, EntityInterface::TYPE_DEFINITION);
    }
}

$entityProvider = new CustomEntityProvider();
$container->addEntityProvider($entityProvider);

$container->get('foo');  // bar

定义一个 EntityProvider，你只需要继承 \ConstanzeStandard\Container\AbstractEntityProvider 然后在 register 中操作 Container. 最后，将 EntityProvider 对象通过 Container 的 addEntityProvider 方法传入即可。

需要注意的是，你必须在 provides 属性中指明当前的 provider 提供了哪些 entity，否则将不会生效。

预加载的 provider (Bootable Entity Provider)

如果你希望在 provider 放入容器时，立刻注册一些 entity，或者做一些预先的配置工作，那么你可以选择使用 BootableEntityProvider，这是一种特殊的 EntityProvider，它有一个额外的方法 boot, 在 provider 加入容器时会立刻被执行。

...
use ConstanzeStandard\Container\Interfaces\BootableEntityProviderInterface;

class CustomEntityProvider extends AbstractEntityProvider implements BootableEntityProviderInterface
{
    protected $provides = [
        'foo'
    ];

    public function boot(ContainerInterface $container)
    {
        $container->add('publicService', function () {
            return new SomeService();
        }, EntityInterface::TYPE_DEFINITION);
    }

    public function register(ContainerInterface $container)
    {
        $container->add('foo', function () {
            return 'bar';
        }, EntityInterface::TYPE_DEFINITION);
    }
}

$entityProvider = new CustomEntityProvider();
$container->addEntityProvider($entityProvider);

当 addEntityProvider 方法被调用时，publicService 就被立刻注册到容器中了，而 foo 则需要等到自身被调用时，才会进行注册。

容器也是 PHP 数组

Container 内部实现了 \ArrayAccess 接口，所以它也具有和 PHP 数组相同的特性，我们可以使用数组操作，对容器的进行读写操作（只支持静态内容，不支持 definition）。

$container = new Container;

$container['foo'] = 'bar';  // 添加一个名为 foo 的 entity
$foo = $container['foo'];  // 获取 foo 的内容
isset($container['foo']);  // 判断 foo 是否存在
unset($container['foo']);  // 从容器中删除 foo

与我取得联系

如果你对这款组件有任何疑问或建议，请与我取得联系：

Alex omytty.alex@gmail.com