.NET5.0 Azure Functions EF迁移时如何从DBContext获取连接字符串

问题现象 #

• 基于EF Core的Azure Functions项目已在Startup.cs完成DbContext依赖注入配置，本地启动函数运行时DbContext注入正常，数据库操作无异常
• 执行EF设计时命令（包管理器控制台的Add-Migration InitialCreate、CLI的dotnet ef migrations script等）时抛出错误：Value cannot be null. (Parameter 'connectionString')
• 错误触发原因：EF设计时工具不会加载Azure Functions的Startup DI管道，默认调用DbContext无参构造函数创建实例，原有逻辑中无参构造未初始化连接字符串字段，触发OnConfiguring时传入空值导致异常。硬编码连接字符串虽可临时解决，但存在配置泄露、多环境适配困难问题，不推荐使用。

解决步骤 #

1. 安装必要依赖 #

在存放DbContext的Infrastructure项目中，安装Microsoft.EntityFrameworkCore.Design NuGet包，该包提供EF设计时实例构建的扩展支持。

2. 实现设计时DbContext工厂 #

在Infrastructure项目中新增IDesignTimeDbContextFactory<MySampleContext>实现类，EF设计时工具检测到该实现后，会优先调用工厂创建DbContext实例，不再走无参构造逻辑：

using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Design;
using Microsoft.Extensions.Configuration;
using System.IO;

namespace 你的Infrastructure项目根命名空间
{
    public class MySampleContextDesignFactory : IDesignTimeDbContextFactory<MySampleContext>
    {
        public MySampleContext CreateDbContext(string[] args)
        {
            // 定位启动项目（Functions项目）的配置文件路径
            var functionProjectPath = Path.GetFullPath(Path.Combine(Directory.GetCurrentDirectory(), "../你的Functions项目文件夹名称"));
            
            // 手动加载配置文件，和运行时配置逻辑保持一致
            var configuration = new ConfigurationBuilder()
                .SetBasePath(functionProjectPath)
                .AddJsonFile("appsettings.json", optional: false)
                .AddJsonFile("appsettings.Development.json", optional: true)
                .Build();

            var dbContextOptionsBuilder = new DbContextOptionsBuilder<MySampleContext>();
            dbContextOptionsBuilder.UseSqlServer(configuration.GetConnectionString("MyDbCon"));

            return new MySampleContext(dbContextOptionsBuilder.Options, configuration);
        }
    }
}

注意事项 #

• 代码中functionProjectPath的拼接逻辑需要和实际本地文件夹结构匹配，保证执行迁移命令时能正确定位到Functions项目下的appsettings.json文件；若在CI/CD流水线中执行迁移命令，可根据流水线工作目录调整路径拼接规则，也支持通过环境变量覆盖连接字符串配置，无需硬编码
• 原有DbContext的业务代码无需修改，运行时DI注入、设计时工厂创建两种场景下，传入的DbContextOptions都已完成数据库提供程序配置，OnConfiguring方法中!optionsBuilder.IsConfigured判断会跳过空连接字符串的逻辑分支
• 不要修改DbContext无参构造函数的访问修饰符，避免破坏EF Core的内部运行逻辑
• 多环境部署时，可在配置加载逻辑中增加环境变量配置源，和Functions运行时的配置优先级保持一致，无需为迁移单独维护配置

验证效果 #

完成上述配置后，重新执行迁移相关命令：

• EF设计时工具会自动识别MySampleContextDesignFactory，调用其CreateDbContext方法加载配置、创建DbContext实例
• 连接字符串从appsettings.json正常读取，不会再抛出空参数异常
• Azure Functions运行时的DI注入逻辑不受任何影响，本地启动、云端部署的运行行为和改造前完全一致

内容的提问来源于stack exchange，提问作者O'Neil Tomlinson