[DependencyInjection] Add #[AutowireLocator] attribute

alexandre-daubois · alexandre-daubois · commit 53853395b510 · 2023-08-21T15:04:45.000+02:00
diff --git a/reference/attributes.rst b/reference/attributes.rst
@@ -38,6 +38,7 @@ Dependency Injection
 * :ref:`Autowire <autowire-attribute>`
 * :ref:`AutowireCallable <autowiring_closures>`
 * :doc:`AutowireDecorated </service_container/service_decoration>`
+* :ref:`AutowireLocator <service-locator_autowire-locator>`
 * :ref:`AutowireServiceClosure <autowiring_closures>`
 * :ref:`Exclude <service-psr4-loader>`
 * :ref:`TaggedIterator <tags_reference-tagged-services>`
diff --git a/service_container/service_subscribers_locators.rst b/service_container/service_subscribers_locators.rst
@@ -297,6 +297,84 @@ This is done by having ``getSubscribedServices()`` return an array of
 
     The above example requires using ``3.2`` version or newer of ``symfony/service-contracts``.
 
+.. _service-locator_autowire-locator:
+
+The AutowireLocator attribute
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Another way to define a service locator is to use the
+:class:`Symfony\\Component\\DependencyInjection\\Attribute\\AutowireLocator`
+attribute::
+
+    // src/CommandBus.php
+    namespace App;
+
+    use App\CommandHandler\BarHandler;
+    use App\CommandHandler\FooHandler;
+    use Psr\Container\ContainerInterface;
+    use Symfony\Component\DependencyInjection\Attribute\AutowireLocator;
+    use Symfony\Contracts\Service\ServiceSubscriberInterface;
+
+    class CommandBus implements ServiceSubscriberInterface
+    {
+        public function __construct(
+            #[AutowireLocator(FooHandler::class, BarHandler::class)]
+            private ContainerInterface $locator,
+        ) {
+        }
+
+        public function handle(Command $command): mixed
+        {
+            $commandClass = get_class($command);
+
+            if ($this->locator->has($commandClass)) {
+                $handler = $this->locator->get($commandClass);
+
+                return $handler->handle($command);
+            }
+        }
+    }
+
+Just like with the ``getSubscribedServices()`` method, it is possible
+to define aliased services thanks to named argument, as well as optional
+services::
+
+    // src/CommandBus.php
+    namespace App;
+
+    use App\CommandHandler\BarHandler;
+    use App\CommandHandler\BazHandler;
+    use App\CommandHandler\FooHandler;
+    use Psr\Container\ContainerInterface;
+    use Symfony\Component\DependencyInjection\Attribute\AutowireLocator;
+    use Symfony\Contracts\Service\ServiceSubscriberInterface;
+
+    class CommandBus implements ServiceSubscriberInterface
+    {
+        public function __construct(
+            #[AutowireLocator(
+                fooHandlerAlias: FooHandler::class,
+                barHandlerAlias: BarHandler::class,
+                optionalBazHandlerAlias: '?'.BazHandler::class
+            )]
+            private ContainerInterface $locator,
+        ) {
+        }
+
+        public function handle(Command $command): mixed
+        {
+            $fooHandler = $this->locator->get('fooHandlerAlias');
+
+            // ...
+        }
+    }
+
+.. versionadded:: 6.4
+
+    The
+    :class:`Symfony\\Component\\DependencyInjection\\Attribute\\AutowireLocator`
+    attribute was introduced in Symfony 6.4.
+
 .. _service-subscribers-locators_defining-service-locator:
 
 Defining a Service Locator
