.NET多Web API共享Hangfire MongoDB存储的任务隔离问题

核心思路 #

通过任务标识隔离+程序集精准过滤的组合方案，让每个API实例仅处理自身项目定义的任务，彻底规避跨项目程序集加载失败的问题。

具体实现步骤 #

1. 给任务打上项目专属标识 #

在公共类库中封装带项目ID的任务调度扩展方法，把项目标识存入Hangfire任务的参数集合：

// 公共类库扩展方法
public static class HangfireJobExtensions
{
    public static string EnqueueWithProjectTag<T>(this IBackgroundJobClient client, string projectTag, Expression<Func<T, Task>> methodCall)
    {
        return client.Enqueue(methodCall, new Dictionary<string, object>
        {
            ["ProjectTag"] = projectTag
        });
    }
}

每个API项目调度任务时，传入自身的唯一标识（比如"OrderApi"、"UserApi"）：

// 订单API中调度任务
backgroundJobClient.EnqueueWithProjectTag<OrderTaskService>("OrderApi", x => x.GenerateDailyReport());

2. 实现任务过滤拦截器 #

创建Hangfire服务端过滤器，执行任务前校验任务的项目标识，不匹配则直接取消执行：

public class ProjectJobFilter : IServerFilter
{
    private readonly string _currentProjectTag;

    public ProjectJobFilter(string currentProjectTag)
    {
        _currentProjectTag = currentProjectTag;
    }

    public void OnPerforming(PerformingContext filterContext)
    {
        if (!filterContext.Job.Args.TryGetValue("ProjectTag", out var tagObj) || 
            !string.Equals(tagObj.ToString(), _currentProjectTag, StringComparison.OrdinalIgnoreCase))
        {
            filterContext.Canceled = true;
        }
    }

    public void OnPerformed(PerformedContext filterContext)
    {
        // 可选：执行后的日志或清理操作
    }
}

3. 每个API单独配置Hangfire Server #

在各API的Program.cs中，注册Hangfire时指定只扫描自身项目程序集，并注入过滤器：

// 订单API的Program.cs
var projectTag = "OrderApi";
builder.Services.AddHangfire(config =>
{
    config.UseMongoStorage(builder.Configuration.GetConnectionString("HangfireMongo"));
    // 仅扫描当前API项目的程序集，避免加载其他项目类型
    config.UseAssemblyActivator(new AssemblyActivator(typeof(Program).Assembly));
});

builder.Services.AddHangfireServer(options =>
{
    options.ServerName = $"Hangfire-Server-{projectTag}";
}).AddServerFilter(new ProjectJobFilter(projectTag));

4. 清理历史遗留任务 #

如果Hangfire数据库中已有未打标识的旧任务，直接通过MongoDB或Hangfire Dashboard删除这些任务，避免后续执行时触发程序集加载错误。

关键注意事项 #

• 所有API项目必须使用相同版本的Hangfire包，避免兼容性问题
• 禁止直接使用Hangfire原生的Enqueue方法，统一使用带项目标识的扩展方法
• 每个API的Hangfire Server名称建议唯一，方便在Dashboard中区分实例

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