Symfony Bundle中实现Doctrine实体按需加载与可选性管理

// src/Driver/CustomEntityDriver.php
namespace App\Driver;

use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
use Doctrine\ORM\Mapping\ClassMetadata;
use ReflectionClass;

class CustomEntityDriver extends AnnotationDriver
{
    /**
     * @var array<string>
     */
    private array $enabledEntities;

    /**
     * @param array<string> $paths           The paths where mapping files are located.
     * @param array<string> $enabledEntities An array of fully qualified class names of entities that should be enabled.
     */
    public function __construct(array $paths, array $enabledEntities)
    {
        parent::__construct($paths);
        $this->enabledEntities = $enabledEntities;
    }

    /**
     * {@inheritdoc}
     */
    public function loadMetadataForClass(string $className, ClassMetadata $metadata): void
    {
        // 检查当前实体是否在允许列表中
        if (in_array($className, $this->enabledEntities, true)) {
            // 如果在允许列表中，则调用父类方法加载元数据
            parent::loadMetadataForClass($className, $metadata);
        } else {
            // 如果不在允许列表中，则不加载元数据，有效地禁用该实体
            // Doctrine将不会为该实体创建表
            // 你也可以选择抛出一个异常或记录日志，但这通常不是必需的
            // 因为不加载元数据本身就达到了目的。
        }
    }

    /**
     * {@inheritdoc}
     */
    public function is   </string>Valid(string $className): bool
    {
        // 只有当实体在允许列表中时，才认为它是有效的
        return in_array($className, $this->enabledEntities, true) && parent::isValid($className);
    }

    /**
     * {@inheritdoc}
     */
    public function getAllClassNames(): array
    {
        // 仅返回允许列表中的实体类名
        return array_filter(parent::getAllClassNames(), function ($className) {
            return in_array($className, $this->enabledEntities, true);
        });
    }
}

# config/packages/doctrine.yaml
doctrine:
  orm:
    # ... 其他ORM配置
    mappings:
      # 假设这是您的Bundle的映射配置
      your_bundle_entities:
        is_bundle: false # 设置为 false，因为我们是自定义驱动器，而不是直接使用Bundle的默认配置
        type: App\Driver\CustomEntityDriver # 使用您的自定义驱动器
        dir: '%kernel.project_dir%/src/Entity' # 您的实体文件所在目录
        prefix: 'App\Entity' # 您的实体命名空间前缀
        alias: YourBundle # 可选的别名

services:
  # 定义您的自定义Metadata驱动器服务
  App\Driver\CustomEntityDriver:
    arguments:
      - ['%kernel.project_dir%/src/Entity'] # 实体文件路径，与dir参数一致
      - '%your_bundle.enabled_entities%' # 从Bundle配置中获取启用的实体列表

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

use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

class Configuration implements ConfigurationInterface
{
    public function getConfigTreeBuilder(): TreeBuilder
    {
        $treeBuilder = new TreeBuilder('your_bundle');
        $rootNode = $treeBuilder->getRootNode();

        $rootNode
            ->children()
                ->arrayNode('enabled_entities')
                    ->scalarPrototype()->end()
                    ->defaultValue([])
                    ->info('List of fully qualified class names (FQCN) of entities to be enabled.')
                ->end()
            ->end()
        ;

        return $treeBuilder;
    }
}

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

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

class YourBundleExtension extends Extension
{
    public function load(array $configs, ContainerBuilder $container): void
    {
        $configuration = new Configuration();
        $config = $this->processConfiguration($configuration, $configs);

        // 将enabled_entities配置设置为一个容器参数
        $container->setParameter('your_bundle.enabled_entities', $config['enabled_entities']);

        // 如果您有services.yaml，可以在这里加载
        // $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
        // $loader->load('services.yaml');
    }
}

# config/packages/your_bundle.yaml
your_bundle:
  enabled_entities:
    - 'YourBundle\Entity\User'
    - 'YourBundle\Entity\Product'
    # 只有User和Product实体会被Doctrine加载和创建表
    # YourBundle\Entity\Order等其他实体将被忽略