Soli Dependency Injection Container

v2.0.2 2018-11-01 07:55 UTC

This package is auto-updated.

Last update: 2021-04-18 13:23:17 UTC


README

当前项目参考了 Phalcon 框架的依赖注入与服务定位器 和 Laravel 框架的服务容器 实现。

服务容器的目的为了降低代码的耦合度,提高应用的可维护性;是用于管理类依赖和执行依赖注入的工具。

Build Status Coverage Status License

Table of Contents

安装

使用 composer 进行安装:

composer require soliphp/di

先看一个简单的例子

use Psr\Log\LoggerInterface;

class ExceptionHandler
{
    /**
     * 日志记录器
     *
     * @var \Psr\Log\LoggerInterface
     */
    protected $logger;

    public function __construct(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    /**
     * 异常报告
     */
    public function report(\Throwable $e)
    {
        $this->logger->error($e->getMessage());
    }
}

异常处理类 ExceptionHandler 需要 logger 记录(报告)异常, 因此,我们需要注入实现了 Psr\Log\LoggerInterface 接口的类。 而 logger 的实现是要发短信、发邮件或进日志系统,这个 ExceptionHandler 是不关心的,所以我们可以轻易地将 logger 切换为另一个实现。 在为应用编写测试时,也可以轻松的模拟 Psr\Log\LoggerInterface 的实现。

注册服务

服务的注册阶段,仅仅是存储服务定义的格式,并不会调用服务的定义; 而在获取服务(即使用服务)时,对服务定义进行调用,得到服务定义的执行结果。 这样便实现了对服务的延迟加载,避免实例化请求中未用到的服务。

以下 $container 变量均为 Soli\Di\Container 实例。

类名

use Soli\Di\Container;

$container = new Container();

$container->set('someService', \SomeNamespace\SomeService::class);

类实例

$container->set('someService', new \SomeNamespace\SomeService());

闭包/匿名函数

// 注册服务,存储服务的定义
$container->set('someService', function () {
    return new SomeService();
});

使用 $this 访问容器中的其他服务

当使用匿名函数注册服务时,函数体内可以使用 $this 表示当前的 $container 容器类实例, 直接访问容器中的其他服务,便于服务之间进行交互。

// 注册服务,存储服务的定义
$container->set('someService', function () {
    // 此处的 $tihs 即是当前的 $container 容器类实例
    // 通过 $this 直接访问容器中的其他服务
    var_dump($this->otherService);
});

注册接口到实现

注册接口到实现类

$container->set('Database\AdapterInterface', 'Database\Adapter\Mysql');

如果一个类需要处理后才会得到一个适用的实例,那么这里的实现就是一个匿名函数, 可以注册接口到匿名函数,注意匿名函数的返回实例即可:

use Monolog\Logger;
use Monolog\Handler\StreamHandler;

$container->set('Psr\Log\LoggerInterface', function () {
    // create a log channel
    $log = new Logger('name');
    $log->pushHandler(new StreamHandler('/path/to/your.log', Logger::WARNING));

    return $log;
});

共享(单例)服务

共享服务意味着让服务以单例模式运行,之后的每次请求都会从容器取到同一个实例。 否则每次都会执行服务解析,返回新的服务实例。

默认使用 set() 注册的服务都为共享服务

如果需要每次都使用新的实例,则需要将第三个参数 $shared 设置为 false

$container->set('newInstance', 'SomeNamespace\SomeService', false);

获取服务

获取服务时,调用服务定义,返回服务实例。

获取服务有多种方法:

get() 服务ID

服务ID或者叫服务名称,使用 get() 方法获取已注册服务ID提供的服务:

$service = $container->get('someService');

get() 类名

对于类名无论是否已注册为服务,都可以直接通过容器的 get() 方法获取到它的单例:

$service = $container->get('SomeNamespace\UnregisteredClass');

这对于我们日常开发中经常用到的单例模式,将格外的方便。

如果某些类的依赖项不能通过容器去解析,可以通过将它们作为关联数组传递到 get() 方法的第二个参数注入它们。

$service = $container->get('SomeNamespace\UnregisteredClass', ['id' => 1]);

对象属性

使用访问对象属性的方式,获取服务:

$service = $container->someService;

数组下标

使用访问数组下标的方式,获取服务:

$service = $container['someService'];

$this

匿名函数注册服务时使用 $this 访问容器中的其他服务

静态方式访问容器

$container = Container::instance();

$container->get('someService');

这里需要注意一下,在调用 Container::instance() 之前,一定已经执行过 new Container() 实例化操作。

容器感知

如果某个服务实现了 Soli\Di\ContainerAwareInterface 容器感知接口, 在获取服务时,会自动调用 setContainer() 为其设置容器实例。

别名

别名是用来给服务起不同的名字,以便可以使用不同的名字获取同一个服务。

注意不要定义与服务名称相同的别名。

为已注册服务定义别名

首先注册以 container 为名称的服务:

$container->set('container', $container);

container 服务定义三个别名 Soli\Di\Container, Soli\Di\ContainerInterface, Psr\Container\ContainerInterface

$container->alias('Soli\Di\Container', 'container');
$container->alias('Soli\Di\ContainerInterface', 'container');
$container->alias('Psr\Container\ContainerInterface', 'container');

如果容器中其他服务的构造函数使用了以上三个别名的「类型提示」,则会为其「自动注入」对应服务实例。

use Psr\Container\ContainerInterface;

class Component
{
    protected $container;

    public function __construct(ContainerInterface $container)
    {
        $this->container = $container;
    }
}

// 将自动注入 $container 参数
$component = $container->get(Component::class);

为类名定义别名

由于类名可直接通过容器获取其实例,所以类名是无需定义的服务名称。

那么我们便可以直接为类名定义别名:

$container->alias('Soli\Di\ContainerInterface', 'Soli\Di\Container');
$container->alias('Psr\Container\ContainerInterface', 'Soli\Di\Container');

示例

examples 文件夹下提供了一个类似 Laravel 框架的服务提供者的例子,感兴趣的同学可以前去翻看。

运行方法:

$ cd /path/to/soliphp/di/
$ composer install
$ php examples/index.php

API 参考

API 参考

测试

$ cd /path/to/soliphp/di/
$ composer install
$ phpunit

License

MIT Public License