[FrameworkBundle] Auto-register #[Route] attributes found on services tagged with routing.controller

nicolas-grekas · nicolas-grekas · commit efeefc64d549 · 2025-08-21T18:01:13.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 7.4
 ---
 
+ * Auto-register `#[Route]` attributes found on services tagged with `routing.controller`
  * Add `ControllerHelper`; the helpers from AbstractController as a standalone service
  * Allow using their name without added suffix when using `#[Target]` for custom services
  * Deprecate `Symfony\Bundle\FrameworkBundle\Console\Application::add()` in favor of `Symfony\Bundle\FrameworkBundle\Console\Application::addCommand()`
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/RoutingControllerPass.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/RoutingControllerPass.php
@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\Compiler\PriorityTaggedServiceTrait;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+class RoutingControllerPass implements CompilerPassInterface
+{
+    use PriorityTaggedServiceTrait;
+
+    public function process(ContainerBuilder $container): void
+    {
+        if (!$container->hasDefinition('routing.loader.attribute')) {
+            return;
+        }
+
+        $resolve = $container->getParameterBag()->resolveValue(...);
+        $taggedClasses = [];
+        foreach ($this->findAndSortTaggedServices('routing.controller', $container) as $id) {
+            $taggedClasses[$resolve($container->getDefinition($id)->getClass())] = true;
+        }
+
+        $container->getDefinition('routing.loader.attribute')
+            ->replaceArgument(1, array_keys($taggedClasses));
+    }
+}
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php
@@ -78,6 +78,7 @@ class UnusedTagsPass implements CompilerPassInterface
         'proxy',
         'remote_event.consumer',
         'routing.condition_service',
+        'routing.controller',
         'routing.expression_language_function',
         'routing.expression_language_provider',
         'routing.loader',
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -692,7 +692,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->registerForAutoconfiguration(ValueResolverInterface::class)
             ->addTag('controller.argument_value_resolver');
         $container->registerForAutoconfiguration(AbstractController::class)
-            ->addTag('controller.service_arguments');
+            ->addTag('controller.service_arguments')->addTag('routing.controller');
         $container->registerForAutoconfiguration(DataCollectorInterface::class)
             ->addTag('data_collector');
         $container->registerForAutoconfiguration(FormTypeInterface::class)
@@ -765,10 +765,10 @@ public function load(array $configs, ContainerBuilder $container): void
             $definition->addTag('kernel.event_listener', $tagAttributes);
         });
         $container->registerAttributeForAutoconfiguration(AsController::class, static function (ChildDefinition $definition, AsController $attribute): void {
-            $definition->addTag('controller.service_arguments');
+            $definition->addTag('controller.service_arguments')->addTag('routing.controller');
         });
         $container->registerAttributeForAutoconfiguration(Route::class, static function (ChildDefinition $definition, Route $attribute, \ReflectionClass|\ReflectionMethod $reflection): void {
-            $definition->addTag('controller.service_arguments');
+            $definition->addTag('controller.service_arguments')->addTag('routing.controller');
         });
         $container->registerAttributeForAutoconfiguration(AsRemoteEventConsumer::class, static function (ChildDefinition $definition, AsRemoteEventConsumer $attribute): void {
             $definition->addTag('remote_event.consumer', ['consumer' => $attribute->name]);
diff --git a/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php b/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php
@@ -18,6 +18,7 @@
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ErrorLoggerCompilerPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ProfilerPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\RemoveUnusedSessionMarshallingHandlerPass;
+use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\RoutingControllerPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TestServiceContainerRealRefPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TestServiceContainerWeakRefPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslationLintCommandPass;
@@ -146,6 +147,7 @@ public function build(ContainerBuilder $container): void
         $container->addCompilerPass(new RegisterControllerArgumentLocatorsPass());
         $container->addCompilerPass(new RemoveEmptyControllerArgumentLocatorsPass(), PassConfig::TYPE_BEFORE_REMOVING);
         $container->addCompilerPass(new RoutingResolverPass());
+        $container->addCompilerPass(new RoutingControllerPass());
         $this->addCompilerPassIfExists($container, DataCollectorTranslatorPass::class);
         $container->addCompilerPass(new ProfilerPass());
         // must be registered before removing private services as some might be listeners/subscribers
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/routing.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/routing.php
@@ -95,6 +95,7 @@
         ->set('routing.loader.attribute', AttributeRouteControllerLoader::class)
             ->args([
                 '%kernel.environment%',
+                abstract_arg('classes tagged with "routing.controller"'),
             ])
             ->tag('routing.loader', ['priority' => -10])
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Routing/AttributeRouteControllerLoader.php b/src/Symfony/Bundle/FrameworkBundle/Routing/AttributeRouteControllerLoader.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Routing\Loader\AttributeClassLoader;
 use Symfony\Component\Routing\Route;
+use Symfony\Component\Routing\RouteCollection;
 
 /**
  * AttributeRouteControllerLoader is an implementation of AttributeClassLoader
@@ -23,6 +24,36 @@
  */
 class AttributeRouteControllerLoader extends AttributeClassLoader
 {
+    /**
+     * @param class-string[] $taggedClasses
+     */
+    public function __construct(
+        ?string $env = null,
+        private array $taggedClasses = [],
+    ) {
+        parent::__construct($env);
+    }
+
+    public function load(mixed $class, ?string $type = null): RouteCollection
+    {
+        if (['tag' => 'routing.controller'] !== $class) {
+            return parent::load($class, $type);
+        }
+
+        $collection = new RouteCollection();
+
+        foreach ($this->taggedClasses as $class) {
+            $collection->addCollection(parent::load($class, $type));
+        }
+
+        return $collection;
+    }
+
+    public function supports(mixed $resource, ?string $type = null): bool
+    {
+        return parent::supports($resource, $type) || 'attribute' === $type && ['tag' => 'routing.controller'] === $resource;
+    }
+
     /**
      * Configures the _controller default parameter of a given Route instance.
      */
