ASP.NET Core多租户架构：动态修改租户库名及DatabaseInterceptor传参

问题说明 #

在ASP.NET Core构建多租户架构时，遇到两个核心问题：

1. 在Startup.cs执行后无法动态修改租户名称，尝试使用HttpContext也未成功；
2. 不知道如何在DatabaseInterceptor中正确传入MySQL数据库名称作为动态参数。

问题根源分析 #

1. 租户实例不共享：当前代码中，Startup.cs和控制器里都直接new TenantInfo()，导致Interceptor持有的实例与控制器修改的实例不是同一个，修改无法生效；
2. Interceptor注册方式错误：直接在DbContext配置中new DatabaseInterceptor(tenantInfo)，传入的是固定实例，无法动态获取请求上下文的租户信息；
3. 生命周期不匹配：TenantInfo注册为Scoped，但实际使用时却创建了独立实例，没有利用DI容器的生命周期管理实现请求内共享。

解决方案 #

一、实现动态修改租户名称 #

1. 利用DI容器共享TenantInfo实例：确保整个请求周期内使用同一个TenantInfo实例，通过DI注入而非手动new；
2. 通过HttpContext传递租户信息（可选）：如果需要从请求头、路由等位置自动识别租户，可以在中间件中设置TenantInfo。

二、DatabaseInterceptor动态获取数据库名称 #

修改Interceptor的注册方式，让它通过DI获取Scoped的TenantInfo，从而动态获取当前请求的数据库名称。

修改后的代码示例 #

1. Startup.cs 配置服务 #

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<ApplicationSettings>(Configuration.GetSection("AppSettings"));
    // 注册Scoped的TenantInfo，确保每个请求使用同一个实例
    services.AddScoped<TenantInfo>();
    services.UseSchemaPerTenant(Configuration);

    services.AddTransient<DatabaseMigrator>();

    // 注册DatabaseInterceptor为Transient，使其能注入Scoped的TenantInfo
    services.AddTransient<DatabaseInterceptor>();

    // 配置DbContext时，通过工厂方法获取Interceptor，而非直接new
    services.AddDbContext<erp_colombiaDbContext>((sp, options) => 
        options.UseMySql(Configuration.GetConnectionString("DefaultConnection"))
               .AddInterceptors(sp.GetRequiredService<DatabaseInterceptor>()));

    services.AddIdentityCore<Employee>(options =>
        options.SignIn.RequireConfirmedAccount = false
    ).AddRoles<Entities.Type>().AddEntityFrameworkStores<erp_colombiaDbContext>();
}

2. 控制器代码（修改租户名称） #

private readonly TenantInfo _tenantInfo;
private readonly DatabaseMigrator _migrator;
private readonly IWebHostEnvironment _hostingEnv;
private StringBuilder _output;

// 通过构造函数注入Scoped的TenantInfo和其他依赖
public YourController(TenantInfo tenantInfo, DatabaseMigrator migrator, IWebHostEnvironment hostingEnv)
{
    _tenantInfo = tenantInfo;
    _migrator = migrator;
    _hostingEnv = hostingEnv;
}

[HttpGet("seed")]
public async Task<IActionResult> Seed(string tenantNewName)
{
    if (_hostingEnv.IsDevelopment())
    {
        _output = new StringBuilder("---DATABASE SEED---\n");

        // 修改共享的TenantInfo实例的名称，而非创建新实例
        _tenantInfo.Name = tenantNewName ?? "erp_colombia";

        _migrator.Execute();

        _output.AppendLine("Ensured database is created and applied all pending migrations");
        _output.AppendLine("Done!");

        return Ok(_output.ToString());
    }
    else
    {
        _output = new StringBuilder($"Database can ONLY be generated in DEV MODE!!!!");
        return Ok(_output.ToString());
    }
}

3. DatabaseInterceptor 代码 #

public class DatabaseInterceptor : DbCommandInterceptor
{
    private readonly TenantInfo _tenantInfo;

    // 通过构造函数注入Scoped的TenantInfo，获取当前请求的租户数据库名称
    public DatabaseInterceptor(TenantInfo tenantInfo)
    {
        _tenantInfo = tenantInfo;
    }

    public override Task<InterceptionResult<DbDataReader>> ReaderExecutingAsync(DbCommand command,
        CommandEventData eventData,
        InterceptionResult<DbDataReader> result,
        CancellationToken cancellationToken = default)
    {
        // 使用当前请求的租户名称，为空则用默认值
        var dbName = _tenantInfo.Name ?? "erp_colombia";
        command.CommandText = $"USE {dbName}; {command.CommandText}";

        return base.ReaderExecutingAsync(command, eventData, result, cancellationToken);
    }
}

额外说明 #

如果需要从请求上下文自动识别租户（比如从路由参数、请求头），可以添加一个中间件来设置TenantInfo：

public class TenantMiddleware
{
    private readonly RequestDelegate _next;

    public TenantMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task InvokeAsync(HttpContext context, TenantInfo tenantInfo)
    {
        // 从路由获取租户名称，示例路由：/api/{tenantName}/seed
        if (context.Request.RouteValues.TryGetValue("tenantName", out var tenantName))
        {
            tenantInfo.Name = tenantName.ToString();
        }
        // 或者从请求头获取
        // var tenantName = context.Request.Headers["X-Tenant-Name"].FirstOrDefault();

        await _next(context);
    }
}

// 在Startup.cs的Configure方法中注册中间件
app.UseMiddleware<TenantMiddleware>();

内容的提问来源于stack exchange，提问作者J.C