Laravel-Modules 中自动迁移功能的问题与解决方案

问题背景

在 Laravel 模块化开发中，使用 laravel-modules 包进行模块管理时，开发者可能会遇到模块迁移文件被自动执行的问题。特别是在多租户系统中，开发者希望控制迁移的执行时机和目标数据库，而不是让模块自动执行迁移。

问题现象

当开发者升级 laravel-modules 到 11.1.0 及以上版本后，即使没有在模块服务提供者中显式调用 loadMigrationsFrom 方法，模块的迁移文件也会被自动执行。这会导致迁移被应用到错误的数据库（如中央数据库而非租户数据库）。

问题原因

在 laravel-modules 11.1.0 版本中，引入了模块功能的自动发现机制，其中包括了对迁移文件的自动注册功能。这一变化旨在简化模块服务提供者的管理，但可能会干扰开发者对迁移执行流程的自定义控制。

解决方案

要解决这个问题，开发者可以通过修改配置文件来禁用自动迁移发现功能：

1. 首先，确保你的配置文件是最新的，可以通过发布包的配置文件来更新：

   php artisan vendor:publish --provider="Nwidart\Modules\LaravelModulesServiceProvider" --tag=config
   

2. 在配置文件中找到 auto-discover 部分，将 migrations 设置为 false：

   'auto-discover' => [
       'migrations' => false,
       'translations' => false,
   ],
   

3. 这样配置后，模块的迁移文件将不会被自动注册，开发者可以完全控制迁移的执行时机和目标数据库。

最佳实践建议

1. 多租户系统迁移管理：在多租户系统中，建议完全禁用自动迁移发现，通过租户服务提供者来管理迁移的执行。

2. 版本升级注意事项：在升级 laravel-modules 时，应该检查配置文件的变更，特别是当项目对迁移执行有特殊要求时。

3. 模块化开发规范：对于复杂的模块化系统，建议建立明确的迁移管理规范，明确哪些模块的迁移应该在什么环境下执行。

4. 测试验证：在修改迁移配置后，应该在测试环境中验证迁移行为是否符合预期，特别是在多数据库环境中。

总结

laravel-modules 的自动迁移发现功能虽然简化了模块开发，但在特定场景下可能需要禁用。通过理解配置选项和合理设置，开发者可以灵活控制模块迁移的执行方式，满足各种复杂应用场景的需求。