Symfony - получить сервис по имени класса из итерируемых - внедренных тегированных сервисов

Question

Я изо всех сил пытаюсь получить определенную услугу через имя класса из группы внедренных помеченных служб.

Вот пример: я помечаю все службы, которые реализуют DriverInterface 'app.driver', и связываю его с переменной $drivers.

В каком-то другом сервисе мне нужно получить все те драйверы, которые помечены как "app.driver", создать и использовать только несколько из них. Но то, что драйверы будут необходимы, является динамическим.

services.yml

_defaults:
        autowire: true
        autoconfigure: true
        public: false
        bind:
            $drivers: [!tagged app.driver]

_instanceof:
        DriverInterface:
            tags: ['app.driver']

какой-то другой сервис:

/**
 * @var iterable
 */
private $drivers;

/**
 * @param iterable $drivers
 */
public function __construct(iterable $drivers) 
{
    $this->drivers = $drivers;
}

public function getDriverByClassName(string $className): DriverInterface
{
    ????????
}

Таким образом, сервисы, реализующие интерфейс Driver, вставляются в параметр $this->drivers как итеративный результат. Я могу только проповедовать через них, но тогда все службы будут созданы.

Есть ли какой-то другой способ внедрить эти сервисы, чтобы получить от них определенный сервис по имени класса, не создавая экземпляры других?

PS Я знаю, что есть возможность сделать эти драйверы общедоступными и использовать вместо них контейнеры, но я бы хотел избежать внедрения в сервис монетоприемника, если это возможно сделать иначе.

Answer 1

Вам больше не нужно (начиная с Symfony 4) создавать проход компилятора для настройки локатора служб.

Можно сделать все через конфигурацию и позволить Symfony творить "волшебство".

Вы можете обойтись следующими дополнениями к вашей конфигурации:

services:
  _instanceof:
    DriverInterface:
      tags: ['app.driver']
      lazy: true

  DriverConsumer:
    arguments:
      - !tagged_locator
        tag: 'app.driver'

Служба, которая должна получить к ним доступ вместо получения iterable, получает ServiceLocatorInterface:

class DriverConsumer
{
    private $drivers;
    
    public function __construct(ServiceLocatorInterface $locator) 
    {
        $this->locator = $locator;
    }
    
    public function foo() {
        $driver = $this->locator->get(Driver::class);
        // where Driver is a concrete implementation of DriverInterface
    }
}

Вот и все. Больше ничего не нужно, просто работает^тм.

---

Полный пример

Полный пример со всеми задействованными классами.

У нас есть:

FooInterface:

interface FooInterface
{
    public function whoAmI(): string;
}

AbstractFoo

Чтобы упростить реализацию, абстрактный класс, который мы расширим в наших конкретных сервисах:

abstract class AbstractFoo implements FooInterface
{
    public function whoAmI(): string {
        return get_class($this);
    }   
}

Реализации сервисов

Пара сервисов, реализующих FooInterface

class FooOneService extends AbstractFoo { }
class FooTwoService extends AbstractFoo { }

Потребитель услуг

И еще один сервис, которому требуется локатор сервиса для использования этих двух, которые мы только что определили:

class Bar
{
    /**
     * @var \Symfony\Component\DependencyInjection\ServiceLocator
     */
    private $service_locator;

    public function __construct(ServiceLocator $service_locator) {
        $this->service_locator = $service_locator;
    }

    public function handle(): string {
        /** @var \App\Test\FooInterface $service */
        $service = $this->service_locator->get(FooOneService::class);

        return $service->whoAmI();
    }
}

Конфигурация

Единственная необходимая конфигурация:

services:
  _instanceof:
    App\Test\FooInterface:
      tags: ['test_foo_tag']
      lazy: true
    
  App\Test\Bar:
      arguments:
        - !tagged_locator
          tag: 'test_foo_tag'
            

Альтернатива FQCN для названий служб

Если вместо использования имени класса вы хотите определить свои собственные имена служб, вы можете использовать статический метод для определения имени службы. Конфигурация изменится на:

App\Test\Bar:
        arguments:
          - !tagged_locator
            tag: 'test_foo_tag'
            default_index_method: 'fooIndex'

где fooIndex- это общедоступный статический метод, определенный для каждой из служб, возвращающих строку. Внимание: если вы воспользуетесь этим методом, вы не сможете получать сервисы по именам их классов.

Answer 2

ServiceLocator позволит получить доступ к сервису по имени, не создавая экземпляры остальных из них. Это требует прохождения компилятора, но это не слишком сложно для установки.

use Symfony\Component\DependencyInjection\ServiceLocator;
class DriverLocator extends ServiceLocator
{
    // Leave empty
}
# Some Service
public function __construct(DriverLocator $driverLocator) 
{
    $this->driverLocator = $driverLocator;
}

public function getDriverByClassName(string $className): DriverInterface
{
    return $this->driverLocator->get($fullyQualifiedClassName);
}

Теперь приходит волшебство:

# src/Kernel.php
# Make your kernel a compiler pass
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
class Kernel extends BaseKernel implements CompilerPassInterface {
...
# Dynamically add all drivers to the locator using a compiler pass
public function process(ContainerBuilder $container)
{
    $driverIds = [];
    foreach ($container->findTaggedServiceIds('app.driver') as $id => $tags) {
        $driverIds[$id] = new Reference($id);
    }
    $driverLocator = $container->getDefinition(DriverLocator::class);
    $driverLocator->setArguments([$driverIds]);
}

И престо. Это должно работать, если вы исправите любые синтаксические ошибки или опечатки, которые я мог ввести.

А за дополнительную плату вы можете автоматически зарегистрировать классы драйверов и избавиться от этого экземпляра записи в файле служб.

# Kernel.php
protected function build(ContainerBuilder $container)
{
    $container->registerForAutoconfiguration(DriverInterface::class)
        ->addTag('app.driver');
}