EF Core OnConfiguring方法怎么用 EF Core配置DbContextOptions

OnConfiguring是EF Core配置数据库连接的核心方法,用于设置DbContextOptionsBuilder;适合快速配置,但生产环境推荐依赖注入+appsettings.json管理连接字符串,模型配置应放在OnModelCreating中。

OnConfiguring 方法是 EF Core 中配置数据库连接和行为的核心入口,它在每次 DbContext 实例创建时被自动调用,用于设置 DbContextOptionsBuilder。关键在于:它适合快速配置、原型开发或简单场景;但生产项目更推荐通过依赖注入 + appsettings.json 方式管理连接字符串和选项。

OnConfiguring 的基本写法

重写该方法,调用 UseSqlServer(或其他数据库提供程序)传入连接字符串即可:

  • 必须调用 base.OnConfiguring(optionsBuilder)(除非明确不需要父类逻辑)
  • 连接字符串可硬编码(仅限测试)、从环境变量读取,或通过 IConfiguration 注入(需构造函数接收)
  • 支持链式配置,比如日志、敏感数据开关、分页优化等

示例(SQL Server):

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
    base.OnConfiguring(optionsBuilder);
    optionsBuilder
        .UseSqlServer("Server=.;Database=MyAppDb;Trusted_Connection=true;")
        .LogTo(Console.WriteLine)                    // 简单控制台日志
        .EnableSensitiveDataLogging();               // 开发时显示参数值(勿用于生产)
}

配合 IConfiguration 使用(推荐做法)

避免硬编码连接字符串,把配置交给宿主(如 ASP.NET Core 或 .NET 6+ 主机构建器)统一管理:

  • DbContext 构造函数接收 IConfiguration
  • OnConfiguring 中通过 _configuration.GetConnectionString("DefaultConnection") 获取
  • 同时确保 Program.cs 中已注册 DbContext 并绑定同一连接字符串名

这样既解耦又便于多环境切换(开发/测试/生产)。

哪些配置适合放 OnConfiguring?

以下常见操作可在此完成,无需额外服务注册:

  • 指定数据库提供程序(UseSqlServer / UseSqlite / UseMySql
  • 启用日志(LogToUseLoggerFactory
  • 开启调试功能(EnableSensitiveDataLoggingEnableDetailedErrors
  • 添加拦截器(AddInterceptors),如审计、SQL 标签注入
  • 设置查询超时、命令超时(CommandTimeout

注意:模型配置(如主键、索引、关系)应放在 OnModelCreating,而非 OnConfiguring

什么情况下不该用 OnConfiguring?

当项目需要:

  • 单元测试中替换 DbContext(需无参构造或可控构造)
  • 多个 DbContext 共享同一连接字符串或日志策略
  • 使用 AddDbContextPool 进行性能优化
  • 严格遵循配置中心、密钥管理(如 Azure Key Vault)

此时应完全移除 OnConfiguring,改用 AddDbContext 在 DI 容器中集中配置选项。

基本上就这些。OnConfiguring 不复杂但容易忽略上下文生命周期和配置优先级——只要记住:它负责“怎么连”,而 OnModelCreating 负责“连什么结构”。