ASP.NET Core Web API：开发与生产环境数据库连接配置问询

我正在构建ASP.NET Core Web API，希望实现以下需求：部署到IIS生产环境时使用生产数据库连接字符串，本地启动API时自动连接测试数据库，且无需频繁修改代码。

当前我在Startup.cs中通过Entity Framework注册了两个DbContextFactory，代码如下：

services.AddDbContextFactory<ProdContext>(options =>
{
    string decrypted = ConnStringSecurity.Decrypt(Configuration.GetConnectionString("ProdDBConnection"));

    options.UseSqlServer(decrypted,
    sqlServerOptionsAction: sqlOptions =>
    {
        sqlOptions.EnableRetryOnFailure(
        maxRetryCount: 10,
        maxRetryDelay: TimeSpan.FromSeconds(5),
        errorNumbersToAdd: null
        );
    });
});

services.AddDbContextFactory<TestContext>(options =>
{
    string decrypted = ConnStringSecurity.Decrypt(Configuration.GetConnectionString("TestDBConnection"));

    options.UseSqlServer(decrypted,
    sqlServerOptionsAction: sqlOptions =>
    {
        sqlOptions.EnableRetryOnFailure(
        maxRetryCount: 10,
        maxRetryDelay: TimeSpan.FromSeconds(5),
        errorNumbersToAdd: null
        );
    });
});

我知道可以在Configure方法中通过IWebHostEnvironment区分开发与生产环境，但不清楚如何在此处全局集成DbContext；若在每个控制器中注入对应Context，需在每个端点判断环境，效率低下。我不想采用部署两个API实例的“偷懒”方案，请问是否有更高效的实现方式？

方法一：基于环境注册单一DbContext（推荐） #

不需要维护两个DbContext类，仅根据当前环境选择对应连接字符串注册同一个DbContext即可，控制器只需注入一个实例，无需额外判断。

实现步骤： #

1. 配置多环境连接字符串：
   • 生产环境配置（appsettings.json）：

     {
       "ConnectionStrings": {
         "DefaultDBConnection": "加密后的生产库连接字符串"
       }
     }
     

   • 本地开发环境配置（appsettings.Development.json）：

     {
       "ConnectionStrings": {
         "DefaultDBConnection": "加密后的测试库连接字符串"
       }
     }
     

2. 在Startup.cs中根据环境自动加载对应配置并注册DbContext：

   public void ConfigureServices(IServiceCollection services, IWebHostEnvironment env)
   {
       string connString = Configuration.GetConnectionString("DefaultDBConnection");
       string decrypted = ConnStringSecurity.Decrypt(connString);
   
       services.AddDbContextFactory<AppDbContext>(options =>
       {
           options.UseSqlServer(decrypted, sqlOptions =>
           {
               sqlOptions.EnableRetryOnFailure(
                   maxRetryCount: 10,
                   maxRetryDelay: TimeSpan.FromSeconds(5),
                   errorNumbersToAdd: null
               );
           });
       });
   }
   

原理： #

ASP.NET Core会自动识别当前环境并加载对应配置文件：

• 本地开发默认使用Development环境，优先读取appsettings.Development.json的配置，覆盖appsettings.json同名项
• 部署到IIS时，设置环境变量ASPNETCORE_ENVIRONMENT为Production，系统将加载appsettings.json的生产配置

方法二：通过接口抽象实现环境自动切换DbContext #

如果生产/测试库结构存在差异，必须保留两个DbContext类，可以通过接口抽象统一注入，避免控制器中判断环境。

实现步骤： #

1. 定义通用数据库上下文接口：

   public interface IAppDbContext
   {
       // 声明业务所需的DbSet和通用方法，与ProdContext、TestContext保持一致
       DbSet<YourEntity> YourEntities { get; set; }
   }
   

2. 让两个DbContext实现该接口：

   public class ProdContext : DbContext, IAppDbContext
   {
       public DbSet<YourEntity> YourEntities { get; set; }
       // 原有ProdContext的其他逻辑
   }
   
   public class TestContext : DbContext, IAppDbContext
   {
       public DbSet<YourEntity> YourEntities { get; set; }
       // 原有TestContext的其他逻辑
   }
   

3. 在Startup.cs中根据环境注册对应实现：

   public void ConfigureServices(IServiceCollection services, IWebHostEnvironment env)
   {
       // 保留原有两个DbContextFactory的注册代码
       services.AddDbContextFactory<ProdContext>(options =>
       {
           string decrypted = ConnStringSecurity.Decrypt(Configuration.GetConnectionString("ProdDBConnection"));
           options.UseSqlServer(decrypted, sqlOptions =>
           {
               sqlOptions.EnableRetryOnFailure(10, TimeSpan.FromSeconds(5), null);
           });
       });
   
       services.AddDbContextFactory<TestContext>(options =>
       {
           string decrypted = ConnStringSecurity.Decrypt(Configuration.GetConnectionString("TestDBConnection"));
           options.UseSqlServer(decrypted, sqlOptions =>
           {
               sqlOptions.EnableRetryOnFailure(10, TimeSpan.FromSeconds(5), null);
           });
       });
   
       // 根据环境绑定IAppDbContext的实现
       if (env.IsProduction())
       {
           services.AddScoped<IAppDbContext>(sp => 
               sp.GetRequiredService<IDbContextFactory<ProdContext>>().CreateDbContext());
       }
       else
       {
           services.AddScoped<IAppDbContext>(sp => 
               sp.GetRequiredService<IDbContextFactory<TestContext>>().CreateDbContext());
       }
   }
   

4. 控制器中直接注入IAppDbContext即可使用：

   [ApiController]
   [Route("api/[controller]")]
   public class YourController : ControllerBase
   {
       private readonly IAppDbContext _dbContext;
   
       public YourController(IAppDbContext dbContext)
       {
           _dbContext = dbContext;
       }
   
       // 直接使用_dbContext操作数据库，无需判断环境
   }
   

方法三：直接根据环境选择连接字符串名称 #

如果不想调整配置文件结构，可以在注册DbContext时直接根据环境选择连接字符串：

public void ConfigureServices(IServiceCollection services, IWebHostEnvironment env)
{
    string connStringName = env.IsProduction() ? "ProdDBConnection" : "TestDBConnection";
    string decrypted = ConnStringSecurity.Decrypt(Configuration.GetConnectionString(connStringName));

    services.AddDbContextFactory<AppDbContext>(options =>
    {
        options.UseSqlServer(decrypted, sqlOptions =>
        {
            sqlOptions.EnableRetryOnFailure(10, TimeSpan.FromSeconds(5), null);
        });
    });
}

该方式适合仅连接字符串不同、DbContext逻辑完全一致的场景。

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