如何在EF Core的OnConfiguring方法中获取--configuration参数

方法1：命令行中先设置环境变量再执行EF命令 #

dotnet ef 不会自动将 --configuration 参数映射到 ASPNETCORE_ENVIRONMENT 环境变量，所以可以在执行EF命令前手动设置该变量：

• Windows 命令提示符：

set ASPNETCORE_ENVIRONMENT=UAT && dotnet ef migrations script --output C:/SQL/tododbscript.sql --idempotent --project C:/Work/repos/Example/src/Example.DB/Example.DB.csproj --configuration UAT

• Windows PowerShell：

$env:ASPNETCORE_ENVIRONMENT="UAT"; dotnet ef migrations script --output C:/SQL/tododbscript.sql --idempotent --project C:/Work/repos/Example/src/Example.DB/Example.DB.csproj --configuration UAT

• Linux/macOS：

ASPNETCORE_ENVIRONMENT=UAT dotnet ef migrations script --output C:/SQL/tododbscript.sql --idempotent --project C:/Work/repos/Example/src/Example.DB/Example.DB.csproj --configuration UAT

设置后，你的 OnConfiguring 方法就能通过 Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT") 获取到正确的环境名，加载对应配置文件。

方法2：通过依赖注入传递IConfiguration #

让DbContext通过构造函数接收 IConfiguration，避免在 OnConfiguring 中手动构建配置。这种方式需要依赖启动项目（比如Web项目）来加载配置：

1. 修改DbContext代码 #

public class ExampleDbContext : DbContext
{
    private readonly IConfiguration _configuration;

    // 无参构造函数保留（EF迁移工具可能需要）
    public ExampleDbContext() { }

    // 依赖注入IConfiguration的构造函数
    public ExampleDbContext(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    // 带DbContextOptions的构造函数（用于DI场景）
    public ExampleDbContext(DbContextOptions<ExampleDbContext> options, IConfiguration configuration) : base(options)
    {
        _configuration = configuration;
    }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        if (!optionsBuilder.IsConfigured)
        {
            optionsBuilder.UseSqlServer(_configuration.GetConnectionString("ExampleDb"));
        }
    }
}

2. 执行EF命令时指定启动项目 #

dotnet ef migrations script --output C:/SQL/tododbscript.sql --idempotent --project C:/Work/repos/Example/src/Example.DB/Example.DB.csproj --startup-project C:/Work/repos/Example/src/Example.Web/Example.Web.csproj --configuration UAT

启动项目会加载对应 --configuration 的配置文件（比如 appsettings.UAT.json），并将 IConfiguration 注入到DbContext中。

方法3：直接解析命令行参数获取配置名 #

在 OnConfiguring 方法中直接解析命令行参数，提取 --configuration（或短参数 -c）的值：

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
    if (optionsBuilder.IsConfigured)
    {
        return;
    }

    // 解析命令行中的配置参数
    string[] args = Environment.GetCommandLineArgs();
    string configName = "UAT"; // 设置默认值
    for (int i = 0; i < args.Length; i++)
    {
        if ((args[i].Equals("--configuration", StringComparison.OrdinalIgnoreCase) || args[i].Equals("-c", StringComparison.OrdinalIgnoreCase)) 
            && i + 1 < args.Length)
        {
            configName = args[i + 1];
            break;
        }
    }

    var configuration = new ConfigurationBuilder()
        .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
        .AddJsonFile($"appsettings.{configName}.json", optional: true, reloadOnChange: true)
        .Build();

    optionsBuilder.UseSqlServer(configuration.GetConnectionString("ExampleDb"));
}

这种方式不需要额外设置环境变量或依赖启动项目，直接从命令行参数中获取配置名称，加载对应配置文件。

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