执行Update-Database时无法创建CMSDBContext实例的问题排查

问题描述 #

使用Entity Framework Core 6.0.1执行Update-Database --verbose命令时，触发错误提示：Unable to create an object of type 'CMSDBContext'。

已尝试以下方案但未解决问题：

• 将包含CMSDBContext的项目设置为启动项目；
• 手动创建空数据库cms_db后重新执行命令。

确认代码本身无问题，该代码在其他机器可正常运行。

相关配置与代码信息 #

NuGet包引用配置 #

<ItemGroup>
    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="6.0.1" />
    <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="6.0.1" />
    <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="6.0.1">
      <PrivateAssets>all</PrivateAssets>
      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    </PackageReference>
    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
    <PackageReference Include="StackExchange.Redis" Version="2.5.43" />
</ItemGroup>

CMSDBContext类代码 #

public class CMSDBContext : DbContext
{
    public CMSDBContext(DbContextOptions<CMSDBContext> options)
                : base(options)
    {
    }

    // Dbsets
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.HasDefaultSchema("dbo");
        base.OnModelCreating(modelBuilder);
        CustomDateConverter.DateToUTC(modelBuilder);
        modelBuilder.ApplyConfigurationsFromAssembly(Assembly.GetExecutingAssembly());
    }

    public override async Task<int> SaveChangesAsync(bool acceptAllChangesOnSuccess, CancellationToken cancellationToken = default)
    {
        DateTime currentDateTime = DateTime.UtcNow;

        foreach (var auditableEntity in ChangeTracker.Entries<IAuditable>())
        {
            if (auditableEntity.State == EntityState.Added || auditableEntity.State == EntityState.Modified)
            {
                switch (auditableEntity.State)
                {
                    case EntityState.Added:
                        auditableEntity.Entity.CreatedAt = currentDateTime;
                        break;

                    case EntityState.Modified:
                        auditableEntity.Entity.UpdatedAt = currentDateTime;
                        break;
                }
            }
        }

        return await base.SaveChangesAsync(acceptAllChangesOnSuccess, cancellationToken);
    }
}

服务注册代码 #

public static IServiceCollection AddPresistenceInfrastructure(this IServiceCollection services)
{
    services.AddDbContext<CMSDBContext>(options => options.UseSqlServer(SettingManager.CMSConnectionString));

    #region Repositories
    services.AddTransient(typeof(IGenericRepository<>), typeof(GenericRepository<>));
    services.AddTransient(typeof(IReadonlyRepository<>), typeof(ReadonlyRepository<>));
    services.AddTransient(typeof(ISectionRepository), typeof(SectionRepository));
    #endregion

    #region Cache
    var redisConfigSection = SettingManager.GetSection(RedisSettings.SectionName);

    services.AddSingleton<IConnectionMultiplexer>(sp => ConnectionMultiplexer.Connect(new ConfigurationOptions
            {
                EndPoints = { $"{redisConfigSection["Server"]}:{redisConfigSection["Port"]}" },
                AllowAdmin = true,
                AbortOnConnectFail = false,
            }));

    services.AddSingleton<ICacheService, RedisCacheService>();
    #endregion

    return services;
}

appsettings.json连接字符串 #

"CMSConnection": "Server=Sandy-NB\\LOCALSERVER;Database=cms_db;User Id=sa;Password=xxxx;"

项目引用配置 #

<ItemGroup>
    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="6.0.1" />
    <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="6.0.1" />
    <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="6.0.1">
      <PrivateAssets>all</PrivateAssets>
      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    </PackageReference>
    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
    <PackageReference Include="StackExchange.Redis" Version="2.5.43" />
</ItemGroup>

<ItemGroup>
    <ProjectReference Include="..\..\Core\CMS.Application\CMS.Application.csproj" />
    <ProjectReference Include="..\..\Core\CMS.Domain\CMS.Domain.csproj" />
    <ProjectReference Include="..\..\Shared\CMS.Shared.Common\CMS.Common.csproj" />
</ItemGroup>

可能的原因排查方向 #

1. 连接字符串读取异常：检查SettingManager.CMSConnectionString是否正确读取到appsettings.json中的CMSConnection值。EF迁移工具执行时可能无法加载Web环境配置，导致SettingManager无法正常获取连接字符串。
2. 缺少设计时工厂：你的CMSDBContext仅包含带DbContextOptions的构造函数，若未实现IDesignTimeDbContextFactory<CMSDBContext>，EF工具在设计时（非运行时）可能无法创建DbContext实例，尤其是启动项目非Web项目时。
3. 依赖初始化失败：SettingManager、CustomDateConverter等依赖在设计时环境下可能无法正常初始化。比如SettingManager依赖Web环境配置，但迁移命令执行时无该环境，导致初始化失败，进而无法创建CMSDBContext。
4. SQL Server实例连接问题：确认本地SQL Server实例Sandy-NB\\LOCALSERVER是否可正常访问，包括实例名称是否正确、SQL Server服务是否启动、sa账号密码是否有效、TCP/IP协议是否启用等。
5. 项目构建错误：检查包含CMSDBContext的项目是否编译成功，隐藏的编译错误可能导致EF工具无法识别DbContext类型。
6. EF工具版本不匹配：执行dotnet ef --version查看全局EF工具版本，若版本与项目引用的6.0.1不一致，可能导致DbContext创建失败。

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