如何为Symfony已启用Bundle动态添加Twig模板查找路径？

你可以通过以下两种标准Symfony扩展方式，实现自动扫描所有已启用Bundle的templates目录并添加到Twig路径中：

方法1：利用Bundle扩展类 #

每个Symfony Bundle都对应一个Extension类，你可以在这个类中注入Kernel实例，遍历所有已启用Bundle并动态添加模板路径：

// src/DependencyInjection/YourBundleExtension.php
namespace YourBundle\DependencyInjection;

use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Extension\Extension;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
use Symfony\Component\HttpKernel\KernelInterface;

class YourBundleExtension extends Extension
{
    private $kernel;

    public function __construct(KernelInterface $kernel)
    {
        $this->kernel = $kernel;
    }

    public function load(array $configs, ContainerBuilder $container)
    {
        $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
        $loader->load('services.yaml');

        // 初始化Twig路径参数（如果未配置）
        if (!$container->hasParameter('twig.paths')) {
            $container->setParameter('twig.paths', []);
        }

        $twigPaths = $container->getParameter('twig.paths');

        // 遍历所有已启用的Bundle
        foreach ($this->kernel->getBundles() as $bundle) {
            $templateDir = $bundle->getPath().'/templates';
            // 检查目录存在且未被添加过
            if (is_dir($templateDir) && !in_array($templateDir, $twigPaths)) {
                $twigPaths[] = $templateDir;
            }
        }

        // 更新Twig路径参数
        $container->setParameter('twig.paths', array_unique($twigPaths));
    }
}

需要确保你的Bundle类返回该Extension实例：

// src/YourBundle.php
namespace YourBundle;

use YourBundle\DependencyInjection\YourBundleExtension;
use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
use Symfony\Component\HttpKernel\Bundle\Bundle;

class YourBundle extends Bundle
{
    public function getContainerExtension(): ?ExtensionInterface
    {
        return new YourBundleExtension($this->container->get('kernel'));
    }
}

方法2：使用Compiler Pass（推荐） #

Compiler Pass是Symfony中用于容器编译阶段动态修改配置的标准方式，更符合框架设计理念：

1. 创建Compiler Pass类 #

// src/DependencyInjection/Compiler/AddTwigTemplatePathsPass.php
namespace YourBundle\DependencyInjection\Compiler;

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

class AddTwigTemplatePathsPass implements CompilerPassInterface
{
    private $kernel;

    public function __construct(KernelInterface $kernel)
    {
        $this->kernel = $kernel;
    }

    public function process(ContainerBuilder $container)
    {
        // 初始化Twig路径参数
        $twigPaths = $container->getParameter('twig.paths') ?? [];

        foreach ($this->kernel->getBundles() as $bundle) {
            $templateDir = $bundle->getPath().'/templates';
            if (is_dir($templateDir) && !in_array($templateDir, $twigPaths)) {
                $twigPaths[] = $templateDir;
            }
        }

        $container->setParameter('twig.paths', array_unique($twigPaths));
    }
}

2. 注册Compiler Pass到Bundle #

// src/YourBundle.php
namespace YourBundle;

use YourBundle\DependencyInjection\Compiler\AddTwigTemplatePathsPass;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\HttpKernel\Bundle\Bundle;

class YourBundle extends Bundle
{
    public function build(ContainerBuilder $container)
    {
        parent::build($container);
        $container->addCompilerPass(new AddTwigTemplatePathsPass($container->get('kernel')));
    }
}

关键说明 #

• 两种方法核心逻辑一致：遍历已启用Bundle，检查templates目录是否存在，存在则添加到Twig路径
• 推荐使用Compiler Pass，因为它是Symfony官方推荐的容器配置扩展方式
• 通过array_unique避免重复添加相同路径
• 实现后无需在config/packages/twig.yaml中硬编码任何Bundle的模板路径

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