ASP.NET Core Web API如何通过URL区分同结构同上下文的多个数据库

你之前重复注册同一个DatabaseContext的方式是无效的，ASP.NET Core DI容器中同一服务类型的多次注册，默认只会取最后一次的配置，无法实现按请求选择数据库的需求，可按照以下步骤改造：

1 调整DbContext实现 #

修改DatabaseContext的构造逻辑，注入IHttpContextAccessor获取当前请求的路由参数，动态构建数据库连接字符串：

public class DatabaseContext : DbContext
{
    private readonly IHttpContextAccessor _httpContextAccessor;
    private readonly IConfiguration _configuration;

    public DatabaseContext(DbContextOptions<DatabaseContext> options, 
        IHttpContextAccessor httpContextAccessor,
        IConfiguration configuration) : base(options)
    {
        _httpContextAccessor = httpContextAccessor;
        _configuration = configuration;
    }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        // 从当前请求的路由中获取database参数
        if (_httpContextAccessor.HttpContext?.Request.RouteValues.TryGetValue("database", out var dbNameObj) == true)
        {
            var dbName = dbNameObj.ToString();
            // 读取连接串模板，替换数据库名占位符
            var connTemplate = _configuration.GetConnectionString("DbTemplate");
            var connString = string.Format(connTemplate, dbName);
            optionsBuilder.UseMySQL(connString);
        }
        base.OnConfiguring(optionsBuilder);
    }

    // 原有DbSet定义完全保持不变
    public DbSet<YourEntity> YourEntities { get; set; }
}

在appsettings.json中新增连接串模板和允许访问的数据库列表配置：

"ConnectionStrings": {
  "DbTemplate": "server=127.0.0.1;port=3306;user=你的用户名;password=你的密码;database={0};",
  "AllowedDatabases": "db1,db2,db3"
}

2 修改服务注册逻辑 #

删除你原有重复注册DatabaseContext的代码，替换为如下配置：

// 注册Http上下文访问器，用于获取当前请求的路由参数
services.AddHttpContextAccessor();
// 注册DbContext，不需要指定固定连接串
services.AddDbContext<DatabaseContext>();

如果需要提升性能，也可以使用池化注册：

services.AddDbContextPool<DatabaseContext>(optionsBuilder => {
    // 连接串逻辑已经在DbContext的OnConfiguring中处理，此处留空即可
});

3 配置统一路由规则 #

通过路由规则自动携带database参数，不需要修改原有业务控制器的代码：

方式1：基类统一加路由特性 #

定义公共控制器基类，所有业务控制器继承该基类即可：

[Route("{database}/[controller]")]
[ApiController]
public class BaseApiController : ControllerBase
{
}

// 业务控制器示例，原有逻辑完全不变
public class UserController : BaseApiController
{
    private readonly DatabaseContext _dbContext;
    public UserController(DatabaseContext dbContext)
    {
        _dbContext = dbContext;
    }

    [HttpGet("{id}")]
    public async Task<IActionResult> GetUser(int id)
    {
        // 直接使用_dbContext即可，会自动连接到路由指定的数据库
        var user = await _dbContext.Users.FindAsync(id);
        return Ok(user);
    }
}

最终接口路由格式为.../db1/User/1、.../db2/User/1，自动匹配对应数据库。

方式2：全局统一配置路由 #

如果是MVC项目，可以在启动文件中统一配置路由规则：

app.MapControllerRoute(
    name: "multiDbRoute",
    pattern: "{database}/{controller=Home}/{action=Index}/{id?}");

4 可选：新增数据库名校验 #

避免用户传入非法数据库名导致连接报错，可添加全局校验过滤器：

public class DatabaseNameValidateFilter : IActionFilter
{
    private readonly List<string> _allowedDatabases;
    public DatabaseNameValidateFilter(IConfiguration configuration)
    {
        _allowedDatabases = configuration.GetValue<string>("ConnectionStrings:AllowedDatabases")
            .Split(',', StringSplitOptions.RemoveEmptyEntries)
            .ToList();
    }

    public void OnActionExecuting(ActionExecutingContext context)
    {
        if (!context.RouteData.Values.TryGetValue("database", out var dbNameObj))
        {
            context.Result = new BadRequestObjectResult("缺少database参数");
            return;
        }
        var dbName = dbNameObj.ToString();
        if (!_allowedDatabases.Contains(dbName))
        {
            context.Result = new NotFoundObjectResult($"不支持的数据库{dbName}");
            return;
        }
    }

    public void OnActionExecuted(ActionExecutedContext context) {}
}

注册过滤器：

services.AddControllers(opt =>
{
    opt.Filters.Add<DatabaseNameValidateFilter>();
});

注意事项 #

• 所有目标数据库的表结构必须完全一致，否则会出现查询字段不存在的错误
• 数据库连接账号需要配置所有目标数据库的访问权限
• 若有跨库查询需求，该方案不适用，需要单独扩展逻辑

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