EF Core DbContextFactory使用IOptions注入连接字符串迁移失败求助

问题根源 #

EF Core的迁移工具执行update-database时，会调用IDesignTimeDbContextFactory的无参构造函数，不会触发ASP.NET Core的依赖注入流程。你当前代码中，带IOptions<DbConfiguration>参数的构造根本没被调用，导致_connectionString始终为null，自然会报"Connection string not initialized"错误。

解决方案 #

以下两种方案可根据项目情况选择：

方案一：在无参构造中手动获取密钥保管库的连接字符串 #

把Program.cs中获取Azure密钥的逻辑复制到工厂类的无参构造里，用同步方式获取连接字符串（构造函数不能异步）：

public class MyDbContextFactory : IDesignTimeDbContextFactory<NotificationDbContext>
{
    private string _connectionString;

    public MyDbContextFactory()
    {
        // 从环境变量或本地配置读取密钥保管库认证信息
        var appId = Environment.GetEnvironmentVariable("AZURE_CLIENT_ID");
        var appSecret = Environment.GetEnvironmentVariable("AZURE_CLIENT_SECRET");
        var keyVaultUrl = "你的密钥保管库URL"; // 也可从appsettings.json读取
        var secretName = "你的连接字符串密钥名称";

        var client = new KeyVaultClient(new KeyVaultClient.AuthenticationCallback(
            async (string auth, string res, string scope) =>
            {
                var authContext = new AuthenticationContext(auth);
                var credential = new ClientCredential(appId, appSecret);
                var result = await authContext.AcquireTokenAsync(res, credential);
                if (result == null)
                    throw new InvalidOperationException("获取Token失败");
                return result.AccessToken;
            }));

        // 同步获取密钥（构造函数无法使用async/await）
        var secret = client.GetSecretAsync(keyVaultUrl, secretName).GetAwaiter().GetResult();
        _connectionString = secret.Value;
    }

    // 保留带参数的构造，供运行时依赖注入使用
    public MyDbContextFactory(IOptions<DbConfiguration> connectionString)
    {
        _connectionString = connectionString.Value.ConnectionString;
    }

    public NotificationDbContext CreateDbContext(string[] args)
    {
        if (string.IsNullOrEmpty(_connectionString))
            throw new InvalidOperationException("连接字符串未初始化");

        var optionsBuilder = new DbContextOptionsBuilder<NotificationDbContext>();
        optionsBuilder.UseSqlServer(_connectionString, options =>
        {
            options.MigrationsHistoryTable("EFMigrationHistory", "dbo");
        });

        return new NotificationDbContext(optionsBuilder.Options);
    }
}

方案二：将密钥保管库集成到配置系统，工厂直接读取配置 #

把Azure密钥保管库集成到ASP.NET Core的Configuration体系中，让工厂类直接读取配置，避免重复代码：

第一步：修改Program.cs，集成密钥保管库

var builder = WebApplication.CreateBuilder(args);

// 使用Azure.Identity库（推荐）集成密钥保管库
var credential = new DefaultAzureCredential();
builder.Configuration.AddAzureKeyVault(
    new Uri(builder.Configuration["KeyVaultAd:KeyVaultURL"]),
    credential);

// 配置DbContext时直接从Configuration读取连接字符串
builder.Services.AddDbContext<NotificationDbContext>(options =>
{
    options.UseSqlServer(
        builder.Configuration.GetConnectionString("YourConnectionStringName"),
        o => o.MigrationsHistoryTable("EFMigrationHistory", "dbo"));
});

第二步：修改MyDbContextFactory，直接构建配置读取连接字符串

public class MyDbContextFactory : IDesignTimeDbContextFactory<NotificationDbContext>
{
    public NotificationDbContext CreateDbContext(string[] args)
    {
        var currentDir = Directory.GetCurrentDirectory();
        var configuration = new ConfigurationBuilder()
            .SetBasePath(currentDir)
            .AddJsonFile("appsettings.json")
            .AddJsonFile($"appsettings.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT") ?? "Production"}.json", optional: true)
            .AddAzureKeyVault(
                new Uri(configuration["KeyVaultAd:KeyVaultURL"]),
                new DefaultAzureCredential())
            .Build();

        var optionsBuilder = new DbContextOptionsBuilder<NotificationDbContext>();
        optionsBuilder.UseSqlServer(
            configuration.GetConnectionString("YourConnectionStringName"),
            options => options.MigrationsHistoryTable("EFMigrationHistory", "dbo"));

        return new NotificationDbContext(optionsBuilder.Options);
    }
}

注意事项 #

• 本地开发时，DefaultAzureCredential会自动使用Azure CLI、Visual Studio或Azure PowerShell的登录身份，无需手动配置ClientId和Secret。
• 生产环境建议使用托管标识访问密钥保管库，避免暴露ClientSecret。

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