共享库实体对应的Doctrine迁移文件应存放于何处？最佳实践探讨

核心结论 #

迁移文件的存放位置取决于共享实体的使用场景：如果实体的数据库结构需要全局统一同步到所有依赖项目，优先放在共享类库；如果不同项目对实体有定制化扩展需求，则采用「共享核心迁移+项目自定义迁移」的拆分模式。

1. 迁移文件存放在共享类库（通用场景首选） #

• 优势：所有依赖项目的数据库结构和实体定义完全对齐，避免各项目重复维护相同迁移，减少结构不一致的风险。
• 关键注意事项：
  • 确保所有依赖项目使用相同版本的Doctrine，避免迁移语法兼容问题。
  • 严格遵循Doctrine的迁移命名规则（如Version20240520123456.php），保证执行顺序正确。
  • 若你将共享实体放在bundle中，确实需要实现VersionComparator来控制迁移执行顺序——比如强制共享bundle的迁移先于项目自有迁移执行，防止项目迁移依赖的数据库结构尚未创建。

2. 迁移文件存放在各项目（定制化场景） #

• 适用情况：当不同项目需要给共享实体添加专属字段、关联关系，或有项目独有的数据库逻辑时。
• 关键注意事项：
  • 共享类库仅维护实体的核心基础迁移，项目迁移只处理自身定制化的部分，禁止修改共享实体的核心结构。
  • 项目迁移需依赖共享类库的基础迁移已执行完成，可通过VersionComparator或命名规则（如共享迁移版本号前缀更小）来保障顺序。

最佳实践总结 #

• 优先统一：只要实体结构无项目差异，就把迁移放在共享类库，这是最能减少维护成本的方案。
• 按需拆分：有定制化需求时，采用混合模式，明确核心迁移和项目迁移的职责边界。
• 验证先行：所有迁移在部署到生产环境前，必须在测试环境验证执行顺序和结构变更效果。
• VersionComparator实现建议：如果用bundle存放共享迁移，可以基于迁移的命名前缀（如共享迁移以Shared_开头）或版本号区间来排序，确保共享迁移优先执行。

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