如何仅在开发环境注册Symfony 4.4 Bundle中的命令

针对你的需求，有两种层级的解决方案，从根源到额外保险，确保开发测试命令不会在生产环境生效：

1. 从根源控制Bundle的加载（最彻底） #

直接在项目的Kernel类中，仅在开发环境下注册你的测试Bundle，这样生产环境根本不会加载该Bundle的任何代码，自然也不会注册相关命令。

修改src/Kernel.php的registerBundles方法：

public function registerBundles()
{
    $bundles = [
        // 项目核心Bundle（如FrameworkBundle、DoctrineBundle等）
        new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
        // ... 其他必须的生产环境Bundle
    ];

    // 仅在dev环境加载测试Bundle
    if ($this->getEnvironment() === 'dev') {
        $bundles[] = new Your\DevTestBundle\YourDevTestBundle();
    }

    return $bundles;
}

2. 给Bundle命令添加全局环境约束（额外保险） #

如果担心Bundle被误加载到生产环境，可以通过配置或编译器Pass，让Bundle内的所有命令自动仅在开发环境注册，无需逐个修改命令代码。

方式一：通过服务配置添加标签约束 #

在你的测试Bundle的Resources/config/services.yaml中，给所有命令服务的console.command标签添加env参数：

services:
    _defaults:
        autowire: true
        autoconfigure: true
        public: false

    # 匹配Bundle下所有命令类
    Your\DevTestBundle\Command\:
        resource: '../../Command/*'
        tags:
            - { name: 'console.command', env: 'dev' }

Symfony会识别这个env参数，只有在指定环境下才会注册该命令。

方式二：通过CompilerPass移除非开发环境的命令 #

在Bundle类中添加编译器Pass，遍历本Bundle的命令服务，在非dev环境直接移除这些服务定义：

// YourDevTestBundle/YourDevTestBundle.php
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\HttpKernel\Bundle\AbstractBundle;

class YourDevTestBundle extends AbstractBundle implements CompilerPassInterface
{
    public function build(ContainerBuilder $container)
    {
        parent::build($container);
        $container->addCompilerPass($this);
    }

    public function process(ContainerBuilder $container)
    {
        if ($container->getParameter('kernel.environment') !== 'dev') {
            // 筛选出本Bundle下的所有命令服务
            $commandServiceIds = array_filter(
                array_keys($container->findTaggedServiceIds('console.command')),
                fn($id) => str_starts_with($id, 'Your\DevTestBundle\Command\\')
            );

            // 移除这些命令服务
            foreach ($commandServiceIds as $serviceId) {
                $container->removeDefinition($serviceId);
            }
        }
    }
}

方案组合建议 #

优先使用Kernel控制Bundle加载的方案，这是最直接的隔离方式；再配合服务标签约束或CompilerPass作为双重保险，彻底避免生产环境出现测试命令。

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