Symfony 6.2后如何覆写或修改已排除的服务定义？

问题背景 #

在Symfony 6.2之前，我们可以通过应用的services.yaml排除特定类，再在Bundle的Extension类中动态注册这些类为自定义服务。但Symfony 6.2的#46279号变更修改了FileLoader.php的逻辑，导致被排除的类仍会被自动添加到服务定义中——Bundle虽能正常注册服务，但会在MergeExtensionConfigurationPass环节被自动生成的服务定义覆盖。

旧版本（6.2之前）实现方式 #

1. Bundle Extension类注册服务 #

在Bundle的Extension类中手动注册目标类：

class MyExtension extends Extension
{
    public function load(array $configs, ContainerBuilder $container): void
    {
        $classes = ['App\Handlers\UserClass'];

        foreach ($classes as $class) {
            $container->register($class)
                ->setAutowired(true)
                ->addTag('messenger.message_handler', ['bus' => 'my.bus']);
        }
    }
}

2. 应用services.yaml排除配置 #

在应用的services.yaml中排除目标类所在目录，避免自动注册：

services:
  App\:
    resource: '../src/'
    exclude:
      - '../src/Kernel.php'
      - '../src/Handlers/*'

Symfony 6.2的变更影响 #

#46279号变更在FileLoader.php中新增逻辑，即使配置了排除规则，被排除的类仍会被生成带有container.excluded标签的服务定义。后续的MergeExtensionConfigurationPass会用这些自动生成的定义覆盖Bundle中手动注册的服务。

可行解决方案 #

方案1：使用Compiler Pass修改排除的服务定义 #

创建Compiler Pass，在容器编译阶段找到被标记为排除的服务，修改其定义并移除排除标签：

namespace App\DependencyInjection\Compiler;

use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;

class OverrideExcludedHandlersPass implements CompilerPassInterface
{
    public function process(ContainerBuilder $container): void
    {
        $targetClasses = ['App\Handlers\UserClass'];

        foreach ($targetClasses as $class) {
            if (!$container->hasDefinition($class)) {
                continue;
            }

            $definition = $container->getDefinition($class);
            $definition->setAutowired(true);
            $definition->addTag('messenger.message_handler', ['bus' => 'my.bus']);
            // 移除排除标签，防止被自动定义覆盖
            $definition->clearTag('container.excluded');
        }
    }
}

在Kernel类中注册该Compiler Pass：

protected function build(ContainerBuilder $container): void
{
    $container->addCompilerPass(new OverrideExcludedHandlersPass());
}

方案2：拆分services.yaml的资源注册 #

避免全局注册包含目标类的目录，拆分配置只注册需要的部分，让Bundle完全负责目标类的服务注册：

services:
  # 仅注册除Handlers外的src目录内容
  App\:
    resource: '../src/'
    exclude:
      - '../src/Kernel.php'
      - '../src/Handlers/'
  # 不在这里注册Handlers目录，交给Bundle处理

方案3：直接覆写服务定义并设置优先级 #

在Bundle的Extension类中，检查服务是否已存在，若存在则直接覆写其配置并设置更高优先级：

class MyExtension extends Extension
{
    public function load(array $configs, ContainerBuilder $container): void
    {
        $classes = ['App\Handlers\UserClass'];

        foreach ($classes as $class) {
            // 优先获取已存在的定义，不存在则创建
            $definition = $container->hasDefinition($class) 
                ? $container->getDefinition($class) 
                : $container->register($class);
            
            $definition->setAutowired(true);
            $definition->addTag('messenger.message_handler', ['bus' => 'my.bus']);
            // 设置高优先级，确保不会被自动生成的定义覆盖
            $definition->setPriority(100);
        }
    }
}

内容的提问来源于stack exchange，提问作者SteNafH