如何在运行时根据请求动态修改Hangfire连接字符串

问题描述 #

在Startup.cs中配置了固定连接字符串，但需要根据HttpContext.Request.Host.Host动态切换DbContext和Hangfire的连接字符串，已掌握DbContext的修改方式，不清楚如何修改Hangfire的连接字符串。

原Startup.cs配置代码：

var connStr = Configuration.GetConnectionString("DefaultConnection");

services.AddDbContext<ExampleContext>(options => options.UseSqlServer(connStr));
services.AddHangfire(x => x.UseSqlServerStorage(connStr));
services.AddHangfireServer();

实现思路与代码 #

Hangfire的使用场景分为两种，需要针对性处理：

1. Web请求触发的Hangfire任务 #

当从Web请求中触发任务时，可以先通过当前HttpContext获取Host标识，将其传递给任务，在任务执行时动态匹配对应连接字符串。

步骤1：调整Hangfire服务注册

先不绑定固定连接字符串，保留后续动态配置的空间：

// 仅注册Hangfire基础服务，暂不指定存储连接字符串
services.AddHangfire(config => config.UseSqlServerStorage());
services.AddHangfireServer();

步骤2：在请求中传递Host标识触发任务

在Controller或中间件中，获取当前请求Host并作为参数传入Hangfire任务：

[ApiController]
[Route("api/jobs")]
public class JobTriggerController : ControllerBase
{
    private readonly IBackgroundJobClient _backgroundJobClient;
    private readonly IConfiguration _configuration;

    public JobTriggerController(IBackgroundJobClient backgroundJobClient, IConfiguration configuration)
    {
        _backgroundJobClient = backgroundJobClient;
        _configuration = configuration;
    }

    [HttpPost("run")]
    public IActionResult TriggerSampleJob()
    {
        var currentHost = HttpContext.Request.Host.Host;
        // 将Host作为参数传递给任务
        _backgroundJobClient.Enqueue<SampleJobService>(job => job.Execute(currentHost));
        return Ok("任务已触发");
    }
}

步骤3：任务执行时动态获取连接字符串

实现任务服务类，根据传入的Host匹配对应连接字符串，再操作数据库或Hangfire存储：

public class SampleJobService
{
    private readonly IConfiguration _configuration;

    public SampleJobService(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    public void Execute(string host)
    {
        var targetConnStr = GetConnStrByHost(host);

        // 1. 动态创建DbContext使用目标连接字符串
        using var dbContext = new ExampleContext(
            new DbContextOptionsBuilder<ExampleContext>()
                .UseSqlServer(targetConnStr)
                .Options);
        // 执行数据库操作...

        // 2. 若需操作Hangfire存储，也可基于该连接字符串实例化存储对象
        using var hangfireStorage = new SqlServerStorage(targetConnStr);
        // 操作Hangfire存储（比如查询任务状态）...
    }

    private string GetConnStrByHost(string host)
    {
        // 根据Host映射到配置中的对应连接字符串
        return host switch
        {
            "tenant1.yourdomain.com" => _configuration.GetConnectionString("Tenant1Conn"),
            "tenant2.yourdomain.com" => _configuration.GetConnectionString("Tenant2Conn"),
            _ => _configuration.GetConnectionString("DefaultConnection")
        };
    }
}

2. Hangfire定时/后台自动任务（无HttpContext场景） #

对于RecurringJob这类无HttpContext的定时任务，需要提前为任务指定租户Host标识，或通过配置中心动态获取对应连接字符串：

// 在Startup.cs或单独的任务配置类中注册定时任务
services.AddHangfireServer();

// 为不同租户分别注册定时任务，指定对应的Host标识
RecurringJob.AddOrUpdate<SampleJobService>(
    "tenant1-daily-task",
    job => job.Execute("tenant1.yourdomain.com"),
    Cron.Daily);

RecurringJob.AddOrUpdate<SampleJobService>(
    "tenant2-daily-task",
    job => job.Execute("tenant2.yourdomain.com"),
    Cron.Daily);

进阶：自定义JobStorage工厂实现全局动态切换 #

如果需要全局层面动态切换Hangfire存储，可以实现存储工厂类，统一管理不同Host对应的存储实例：

// 注册存储工厂
services.AddSingleton<IJobStorageFactory, TenantJobStorageFactory>();

// 定义工厂接口与实现
public interface IJobStorageFactory
{
    IJobStorage GetStorage(string host);
}

public class TenantJobStorageFactory : IJobStorageFactory
{
    private readonly IConfiguration _configuration;

    public TenantJobStorageFactory(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    public IJobStorage GetStorage(string host)
    {
        var connStr = GetConnStrByHost(host);
        return new SqlServerStorage(connStr);
    }

    private string GetConnStrByHost(string host)
    {
        // 复用Host-连接字符串映射逻辑
        return host switch
        {
            "tenant1.yourdomain.com" => _configuration.GetConnectionString("Tenant1Conn"),
            "tenant2.yourdomain.com" => _configuration.GetConnectionString("Tenant2Conn"),
            _ => _configuration.GetConnectionString("DefaultConnection")
        };
    }
}

后续需要使用Hangfire存储时，注入IJobStorageFactory并传入Host即可获取对应存储实例。

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