EntityFramework Core 9.0 自动编译模型的多项目解决方案实践

在 EntityFramework Core 9.0 中，微软引入了 MSBuild 集成功能，旨在简化 EF Core 模型的编译过程。然而，当开发者在多项目解决方案中使用 EF Core 时，特别是当上下文被多个"启动项目"（如 API 项目和 Worker 项目）共享时，会遇到一些配置挑战。

自动编译模型的演进

最初，EF Core 9.0 的设计允许通过指定启动项目来配置上下文。但在实际使用中发现，这种方法在某些复杂解决方案中会导致构建依赖循环问题，这些问题不仅难以诊断，有时甚至无法解决。因此，EF Core 团队移除了通过启动项目指定配置的功能。

多项目环境下的解决方案

当 EF Core 上下文被多个项目共享时，推荐的解决方案是使上下文项目在配置方面自给自足。这意味着上下文项目不应该依赖外部项目提供的配置信息。

实现自给自足的上下文配置

要实现这一点，开发者需要在上下文项目中实现 IDesignTimeDbContextFactory<TContext> 接口。这个接口允许在设计和迁移时创建上下文实例，而不依赖于应用程序的启动配置。

public class MyDbContextFactory : IDesignTimeDbContextFactory<MyDbContext>
{
    public MyDbContext CreateDbContext(string[] args)
    {
        var optionsBuilder = new DbContextOptionsBuilder<MyDbContext>();
        optionsBuilder.UseSqlServer("YourConnectionString");
        
        return new MyDbContext(optionsBuilder.Options);
    }
}

实践建议

1. 集中配置：将数据库连接字符串和其他关键配置放在上下文项目中，或者使用环境变量等与项目无关的配置方式。

2. 避免外部依赖：确保上下文项目不依赖于特定应用程序项目的配置逻辑。

3. 测试验证：在实现后，运行迁移命令验证配置是否正确工作。

4. 安全考虑：如果使用硬编码的连接字符串，确保不会将敏感信息提交到源代码控制。

总结

在多项目解决方案中使用 EF Core 9.0 的自动编译模型功能时，开发者应该采用上下文项目自给自足的配置策略。通过实现 IDesignTimeDbContextFactory<TContext> 接口，可以避免构建依赖循环问题，同时保持代码的整洁和可维护性。这种方法不仅解决了多启动项目的问题，还提高了上下文项目的独立性和可重用性。