[Перевод] Как создать свой собственный Dependency Injection Container27.02.2016 13:18

Класс контейнера

Настало время создать наш контейнер. Мы собираемся начать с базовой схемы нашего класса контейнера, и мы будем добавлять методы в него по ходу дела.

Основная идея принимать два массива в конструктор нашего контейнера. Первый массив должен содержать определения сервиса, а второй определения параметров.

В src/Container.php поместите следующий код:

services     = $services;
        $this->parameters   = $parameters;
        $this->serviceStore = [];
    }
}

Все что мы здесь сделали это реализовали интерфейс ContainerInterface из container-interop и загрузили определения в свойства к которым можно получить доступ позднее. Так же мы создали свойство serviceStore и инициализировали его пустым массивом. Когда контейнер попросят создать сервисы, мы сохраним их в этом массиве так чтобы они могли быть восстановлены позже без необходимости пересоздания их.

Сейчас позвольте нам начать писать методы объявленные в container-interop. Начнем с get ($name), добавим следующий метод в класс:

use SitePoint\Container\Exception\ServiceNotFoundException;

// ...
    public function get($name)
    {
        if (!$this->has($name)) {
            throw new ServiceNotFoundException('Service not found: '.$name);
        }

        if (!isset($this->serviceStore[$name])) {
            $this->serviceStore[$name] = $this->createService($name);
        }

        return $this->serviceStore[$name];
    }
// ...

Обязательно добавьте use в начале файла. Наш get ($name) метод это простая проверка на наличие в контейнере определения сервиса. Если его нет будет выброшен ServiceNotFoundException который мы создали ранее. Если он есть, возвращает его, создает его и сохраняет в хранилище если он не был уже создан.

Пока мы находимся в нем, нам следует создать метод для извлечения параметров из контейнера. Принимая параметры преданные в конструктор из n-мерного ассоциативного массива, нам необходим способ чистого доступа к любому элементу в пределах массива используя единственную строку. Простой способ сделать это, использовать точку как разделитель, так чтобы строка foo.bar ссылалась на ключ bar в ключе foo из корня массива параметров.

use SitePoint\Container\Exception\ParameterNotFoundException;

// ...
    public function getParameter($name)
    {
        $tokens  = explode('.', $name);
        $context = $this->parameters;

        while (null !== ($token = array_shift($tokens))) {
            if (!isset($context[$token])) {
                throw new ParameterNotFoundException('Parameter not found: '.$name);
            }

            $context = $context[$token];
        }

        return $context;
    }
// ...

Сейчас мы использовали пару методов которые мы еще не написали. Первый из них has ($name), который объявлен в container-interop. Это довольно простой метод и ему просто нужно проверить если массив определений предоставляемый конструктору содержит $name сервис.

// ...
    public function has($name)
    {
        return isset($this->services[$name]);
    }
// ...

Другой метод который нам предстоит написать createService ($name). Это метод будет использовать определения предоставленные для создания сервиса. Поскольку мы не хотим чтобы этот метод был вызван снаружи контейнера, мы сделаем его приватным.

Первая вещь которую нужно сделать в этом методе это некоторые разумные проверки.
Для каждого объявленного сервиса мы требуем массив содержащий ключ class и необязательные ключи arguments и calls. Они будут использоваться для внедрения конструктора и сеттера соответственно. Мы можем так же добавить защиту от зацикливания ссылок, проверив, попытались ли мы уже создать сервис.

Если ключ arguments существует мы хотим преобразовать тот массив определений аргумента в массив PHP значений который можно предать конструктору. Для того чтобы сделать это нам необходимо преобразовать справочник объектов который мы объявили ранее в значения на которые ссылаются в контейнере. На данный момент мы будем использовать эту логику в методе resolveArguments ($name, array $argumentDefinitons).
Мы используем метод ReflectionClass: newInstanceArgs () для создания сервиса используя массив arguments. Это внедрение конструктора.

Если ключ calls существует, мы хотим использовать массив call definitions и применить его к сервису который мы только что создали. Снова мы будем использовать логику в отдельном методе определенном как initializeService ($service, $name, array $callDefinitions). Это внедрение сеттера.

use SitePoint\Container\Exception\ContainerException;

// ...
    private function createService($name)
    {
        $entry = &$this->services[$name];

        if (!is_array($entry) || !isset($entry['class'])) {
            throw new ContainerException($name.' service entry must be an array containing a \'class\' key');
        } elseif (!class_exists($entry['class'])) {
            throw new ContainerException($name.' service class does not exist: '.$entry['class']);
        } elseif (isset($entry['lock'])) {
            throw new ContainerException($name.' service contains a circular reference');
        }

        $entry['lock'] = true;

        $arguments = isset($entry['arguments']) ? $this->resolveArguments($name, $entry['arguments']) : [];

        $reflector = new \ReflectionClass($entry['class']);
        $service = $reflector->newInstanceArgs($arguments);

        if (isset($entry['calls'])) {
            $this->initializeService($service, $name, $entry['calls']);
        }

        return $service;
    }
// ...

Нам осталось создать два финальных метода. Первый должен преобразовать массив аргументов объявлений в массив PHP значений. Чтобы это сделать нужно заменить объекты ParameterReference и ServiceReference соответствующими параметрами и сервисами из контейнера.

use SitePoint\Container\Reference\ParameterReference;
use SitePoint\Container\Reference\ServiceReference;

// ...
    private function resolveArguments($name, array $argumentDefinitions)
    {
        $arguments = [];

        foreach ($argumentDefinitions as $argumentDefinition) {
            if ($argumentDefinition instanceof ServiceReference) {
                $argumentServiceName = $argumentDefinition->getName();

                $arguments[] = $this->get($argumentServiceName);
            } elseif ($argumentDefinition instanceof ParameterReference) {
                $argumentParameterName = $argumentDefinition->getName();

                $arguments[] = $this->getParameter($argumentParameterName);
            } else {
                $arguments[] = $argumentDefinition;
            }
        }

        return $arguments;
    }

Последний метод выполняет внедрение сеттера в экземпляр объекта сервиса. Чтобы сделать это необходимо перебрать массив определений при вызове метода. Ключ method используется для указания метода и необязательный ключ arguments может быть использован для предоставления аргументов этому методу. Мы можем использовать метод который мы только что написали, для перевода его аргументов в PHP значения.

private function initializeService($service, $name, array $callDefinitions)
    {
        foreach ($callDefinitions as $callDefinition) {
            if (!is_array($callDefinition) || !isset($callDefinition['method'])) {
                throw new ContainerException($name.' service calls must be arrays containing a \'method\' key');
            } elseif (!is_callable([$service, $callDefinition['method']])) {
                throw new ContainerException($name.' service asks for call to uncallable method: '.$callDefinition['method']);
            }

            $arguments = isset($callDefinition['arguments']) ? $this->resolveArguments($name, $callDefinition['arguments']) : [];

            call_user_func_array([$service, $callDefinition['method']], $arguments);
        }
    }
}

И сейчас мы имеем готовый dependency injection container! Чтобы увидеть примеры использования, проверьте репозиторий на GitHub.

Окончание мысли

Мы изучили как создать простой dependency injection container, но есть множество контейнеров с замечательными функциями которые наш еще не имеет.

Некоторые dependency injection containers, такие как PHP-DI и Aura.DI предоставляют особенность которая называется автоматическое подключение. Это где контейнер догадывается какие сервисы из контейнера следует внедрить в другие. Чтобы сделать это они используют reflection API для поиска информации о параметрах конструктора.

© Habrahabr.ru