如何基于Entity Framework Core编写适配自动扩容的动态数据库管理代码

核心思路 #

自动扩容场景下，核心是基于数据库标识（如分片键、实例ID）动态拼接连接字符串，同时通过工厂模式灵活创建DbContext实例，无需提前知晓所有数据库的连接信息。关键是抽离连接字符串的公共模板，动态替换可变部分（如数据库名、服务器地址），再结合服务发现机制获取扩容后的数据库实例信息。

实现步骤 #

1. 配置连接字符串模板 #

在appsettings.json中定义基础连接模板，将可变部分用占位符标记：

{
  "ConnectionStrings": {
    "SqlServerTemplate": "Server={serverAddr};Database={dbName};User Id={username};Password={pwd};TrustServerCertificate=True;"
  }
}

2. 实现动态连接字符串解析器 #

创建服务处理连接字符串的动态生成，依赖服务发现组件获取扩容后的数据库实例信息：

public interface IConnectionStringResolver
{
    Task<string> ResolveAsync(string databaseKey);
}

public class SqlServerConnStringResolver : IConnectionStringResolver
{
    private readonly IConfiguration _config;
    private readonly IDbClusterDiscovery _discoveryService; // 自定义服务发现组件

    public SqlServerConnStringResolver(IConfiguration config, IDbClusterDiscovery discoveryService)
    {
        _config = config;
        _discoveryService = discoveryService;
    }

    public async Task<string> ResolveAsync(string databaseKey)
    {
        // 从服务发现拉取对应数据库的实时实例信息（扩容新增节点会自动同步）
        var dbInstance = await _discoveryService.GetInstanceAsync(databaseKey);
        
        // 替换模板占位符生成最终连接字符串
        var template = _config.GetConnectionString("SqlServerTemplate");
        return string.Format(template, dbInstance.ServerAddr, dbInstance.DbName, dbInstance.Username, dbInstance.Password);
    }
}

3. 改进DbContext工厂 #

让工厂依赖动态连接字符串解析器，支持泛型DbContext创建：

public class DynamicDbContextFactory
{
    private readonly IServiceProvider _serviceProvider;
    private readonly IConnectionStringResolver _connResolver;

    public DynamicDbContextFactory(IServiceProvider serviceProvider, IConnectionStringResolver connResolver)
    {
        _serviceProvider = serviceProvider;
        _connResolver = connResolver;
    }

    public async Task<TContext> CreateAsync<TContext>(string databaseKey) 
        where TContext : DbContext
    {
        var connString = await _connResolver.ResolveAsync(databaseKey);
        
        var optionsBuilder = new DbContextOptionsBuilder<TContext>();
        optionsBuilder.UseSqlServer(connString);

        // 自动注入DbContext的其他依赖（如日志、拦截器）
        return ActivatorUtilities.CreateInstance<TContext>(_serviceProvider, optionsBuilder.Options);
    }
}

4. 注册依赖服务 #

在Program.cs中完成服务注册：

builder.Services.AddScoped<IConnectionStringResolver, SqlServerConnStringResolver>();
builder.Services.AddScoped<DynamicDbContextFactory>();
// 注册自定义DbContext（无需固定配置，由工厂动态生成选项）
builder.Services.AddScoped<MyBusinessDbContext>();

5. 业务代码中使用示例 #

public class OrderService
{
    private readonly DynamicDbContextFactory _dbFactory;

    public OrderService(DynamicDbContextFactory dbFactory)
    {
        _dbFactory = dbFactory;
    }

    public async Task<List<Order>> GetOrdersAsync(string tenantDbKey)
    {
        using var dbContext = await _dbFactory.CreateAsync<MyBusinessDbContext>(tenantDbKey);
        return await dbContext.Orders.ToListAsync();
    }
}

关键注意事项 #

• 服务发现集成：自动扩容的核心是实时获取新增数据库的实例信息，需与集群管理系统（如K8s服务发现、自定义配置中心）集成，确保IDbClusterDiscovery能返回最新节点数据。
• DbContext生命周期：同一请求内多次使用相同databaseKey时，可缓存DbContext实例避免重复创建，注意线程安全。
• 自动迁移：新数据库创建后，可在DbContext初始化时调用await dbContext.Database.MigrateAsync()，确保Schema同步。

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