在处理大型项目时，常常会遇到多个插件和模块的数据库迁移需要按特定顺序执行的问题。我曾在项目中遇到过这种情况，导致迁移脚本执行顺序混乱，影响了项目的稳定性和可维护性。经过一番探索，我发现了 sylius-labs/doctrine-migrations-extra-bundle 这个库，它通过拓扑排序和容器注入来优化 doctrine migrations 的执行顺序，彻底解决了我的难题。
安装和配置
要使用这个库，首先需要通过 Composer 进行安装：
composer require sylius-labs/doctrine-migrations-extra-bundle
接着，在 config/bundles.php 中添加这个 bundle：
return [ // ... SyliusLabsDoctrineMigrationsExtraBundleSyliusLabsDoctrineMigrationsExtraBundle::class => ['all' => true], ];
最后，需要替换 Doctrine Migrations 的原始服务，修改 config/packages/doctrine_migrations.yaml 文件：
doctrine_migrations: services: 'DoctrineMigrationsVersionMigrationFactory': 'SyliusLabsDoctrineMigrationsExtraBundleFactoryContainerAwareVersionFactory' 'DoctrineMigrationsVersionComparator': 'SyliusLabsDoctrineMigrationsExtraBundleComparatorTopologicalVersionComparator'
使用方法
在应用中，你可以配置迁移的拓扑顺序。例如，在 config/packages/sylius_labs_doctrine_migrations_extra.yaml 中：
sylius_labs_doctrine_migrations_extra: migrations: 'CoreMigrations': ~ 'PluginDependingOnCommonPluginMigrations': ['CoreMigrations', 'CommonPluginMigrations'] 'CommonPluginMigrations': ['CoreMigrations'] 'PluginDependingOnCoreMigrations': ['CoreMigrations']
这种配置会确保迁移按照以下顺序执行：
- CoreMigrations
- CommonPluginMigrations
- PluginDependingOnCommonPluginMigrations
- PluginDependingOnCoreMigrations
如果你是在开发一个 bundle，可以在 bundle 的扩展中预定义配置：
use SymfonyComponentDependencyInjectionExtensionExtension; use SymfonyComponentDependencyInjectionExtensionPrependExtensionInterface; final class AcmeExtension extends Extension implements PrependExtensionInterface { // ... public function prepend(ContainerBuilder $container): void { if (!$container->hasExtension('doctrine_migrations') || !$container->hasExtension('sylius_labs_doctrine_migrations_extra')) { return; } $container->prependExtensionConfig('doctrine_migrations', [ 'migrations_paths' => [ 'AcmeAcmeBundleMigrations' => '@AcmeBundle/Migrations', ], ]); $container->prependExtensionConfig('sylius_labs_doctrine_migrations_extra', [ 'migrations' => [ 'AcmeAcmeBundleMigrations' => ['CoreMigrations'], ], ]); } }
生成新的迁移脚本
由于这个 bundle 会动态改变 Doctrine Migrations 的配置，你可能需要指定自己的命名空间：
# config/packages/doctrine_migrations.yaml doctrine_migrations: migrations_paths: 'AppMigrations': "%kernel.project_dir%/src/Migrations" # config/packages/sylius_labs_doctrine_migrations_extra.yaml sylius_labs_doctrine_migrations_extra: migrations: 'AppMigrations': ~
然后，你可以通过以下命令生成新的迁移脚本：
bin/console doctrine:migrations:diff --namespace=AppMigrations
优势和应用效果
sylius-labs/doctrine-migrations-extra-bundle 的优势在于它能够通过拓扑排序确保迁移脚本的执行顺序，这对于复杂的项目架构尤为重要。通过容器注入，它还增强了迁移过程的灵活性和可维护性。
在实际应用中，这个库显著提高了项目的稳定性，减少了因迁移顺序错误导致的问题。我的项目自从引入这个库后，迁移过程变得更加可控和可靠，大大简化了开发和维护的工作量。
总的来说，sylius-labs/doctrine-migrations-extra-bundle 是一个非常实用的工具，特别适合那些需要处理复杂迁移顺序的项目。它不仅解决了我的实际问题，还为未来的开发提供了坚实的基础。
