EF Core：单DbContext+单模型处理运行时多Schema的最佳实践

假设某示例应用的数据结构如下：

Calculations: Id, Value

该应用需在运行时更新数据库结构，添加带Schema标识的新表，生成的表示例如下：

a.Calculations
b.Calculations
c.Calculations
etc. 

要求在EF Core中，使用单个DbContext且不使用继承的单个模型类实现该需求，现有部分代码如下，需完善缺失的数据库结构更新逻辑并说明最佳实践。

给定的模型类 #

public class Calculation
{
    public int? Id;
    public int? Value;
}

给定的DbContext（需补充缓存键逻辑） #

public partial class SampleDBContext : DbContext
{
    public string Schema { get; }
    public DbSet<Calculation> Calculations { get; set; }

    public SampleDBContext(DbContextOptions<SampleDBContext> options, string schema) 
        : base(options)
    {
        Schema = schema;
    }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);
        modelBuilder.Entity<Calculation>().ToTable("Calculations", Schema);
    }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        base.OnConfiguring(optionsBuilder);
        if (!optionsBuilder.IsConfigured)
            optionsBuilder
                .UseSqlServer("Data Source=localhost; Initial Catalog=SampleDB;")
                .ReplaceService<IModelCacheKeyFactory, CustomModelCacheKeyFactory>();
    }
}

1. 实现自定义模型缓存键工厂 #

EF Core默认会缓存模型，不同Schema需要独立的缓存项，否则会出现模型复用错误。必须实现CustomModelCacheKeyFactory，将DbContext类型与Schema组合作为缓存键：

public class CustomModelCacheKeyFactory : IModelCacheKeyFactory
{
    public object Create(DbContext context)
    {
        return context is SampleDBContext dbContext 
            ? (context.GetType(), dbContext.Schema) 
            : (object)context.GetType();
    }
}

2. 完善运行时数据库结构更新逻辑 #

在Generate方法中，需先确保Schema和目标表存在，再执行数据写入。直接使用SQL检查并创建对象是最直观的方式：

public void Generate(string schema)
{
    var optionBuilder = new DbContextOptionsBuilder<SampleDBContext>();
    optionBuilder.UseSqlServer("Data Source=localhost; Initial Catalog=SampleDB;");
    
    using var context = new SampleDBContext(optionBuilder.Options, schema);

    // 创建Schema（如果不存在）
    context.Database.ExecuteSqlRaw($"IF NOT EXISTS (SELECT * FROM sys.schemas WHERE name = N'{schema}') EXEC('CREATE SCHEMA [{schema}]')");

    // 检查目标表是否存在，不存在则创建
    var tableExists = context.Database.ExecuteSqlRawScalar<int>(
        $"SELECT COUNT(*) FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_SCHEMA = '{schema}' AND TABLE_NAME = 'Calculations'") > 0;

    if (!tableExists)
    {
        context.Database.ExecuteSqlRaw($@"
            CREATE TABLE [{schema}].[Calculations] (
                [Id] INT IDENTITY(1,1) PRIMARY KEY,
                [Value] INT NULL
            )");
    }

    // 写入数据
    var calculation = new Calculation { Value = 1 };
    context.Calculations.Add(calculation);
    context.SaveChanges();
}

3. 数据加载逻辑保持原实现 #

Load方法无需修改，DbContext会根据传入的Schema自动关联到对应表：

public List<Calculation> Load(string schema)
{
    var optionBuilder = new DbContextOptionsBuilder<SampleDBContext>();
    optionBuilder.UseSqlServer("Data Source=localhost; Initial Catalog=SampleDB;");
    
    using var context = new SampleDBContext(optionBuilder.Options, schema);
    return context.Calculations.ToList();
}

关键注意事项 #

• 权限控制：确保数据库账户拥有创建Schema和表的权限，避免抛出权限异常。
• 缓存有效性：自定义缓存键工厂必须正确实现，否则会导致EF Core复用错误模型，操作无关表。
• 性能优化：高并发场景下可缓存Schema和表的存在状态，避免重复查询数据库元数据。
• 结构变更：若后续需要修改表结构，可基于EF Core迁移脚本生成对应SQL，或动态执行ALTER TABLE语句。

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