如何取消Hangfire中正在执行的批处理子任务？

问题现象 #

使用BatchJob.Cancel无法取消已处于运行状态的子任务，子任务会持续执行到完成；但通过子任务ID调用BackgroundJob.Delete却能成功终止正在运行的子任务。即使向任务方法注入JobCancellationToken或CancellationToken，也无法解决该问题。

当在子任务启动后调用BatchJob.Cancel，子任务会完整执行完毕；但如果改用BackgroundJob.Delete指定子任务ID，任务会正确响应取消并抛出OperationCanceledException。仅当批处理在子任务启动前被取消时，子任务才会被正常拦截。

原因分析 #

Hangfire的Batch组件默认行为是：BatchJob.Cancel仅将批处理标记为已删除状态，不会主动向已启动运行的子任务发送取消信号，也没有内置机制通过批处理ID关联并终止所有正在运行的子任务。只有尚未启动的子任务会被阻止执行，已启动的子任务不受影响。

另外，Hangfire默认的监控API没有直接提供通过批处理ID获取所有子任务ID的方法，无法直接批量操作子任务。

解决方案 #

方案1：通过存储层查询批处理的所有子任务ID并批量取消 #

Hangfire的JobStorage中存储了批处理和子任务的关联关系，可直接查询底层存储（以SQL Server为例）获取批处理下的所有子任务ID，再逐个调用取消方法。

实现示例：

public static class BatchJobExtensions
{
    public static void CancelAllRunningChildJobs(this IBackgroundJobClient jobClient, string batchJobId)
    {
        var storage = JobStorage.Current;
        using var connection = storage.GetConnection();
        
        // 关联查询批处理下的所有子任务ID
        var query = @"
SELECT j.Id 
FROM Hangfire.Job j
JOIN Hangfire.BatchJob bj ON j.BatchId = bj.Id
WHERE bj.Id = @BatchId";
        
        var parameters = new { BatchId = batchJobId };
        var childJobIds = connection.Query<string>(query, parameters).ToList();
        
        foreach (var childJobId in childJobIds)
        {
            var jobDetails = JobStorage.Current.GetMonitoringApi().JobDetails(childJobId);
            // 仅取消正在运行的任务
            if (jobDetails.History.Any(h => h.StateName == ProcessingState.StateName))
            {
                jobClient.Delete(childJobId);
            }
        }
    }
}

使用方式：

// 替换原有的BatchJob.Cancel(batchJobId)
BackgroundJob.CancelAllRunningChildJobs(batchJobId);

方案2：扩展BatchJob的取消逻辑，自动处理子任务 #

如果希望BatchJob.Cancel自动包含终止所有子任务的逻辑，可封装扩展方法：

public static class BatchJobExtended
{
    public static void CancelWithChildren(string batchJobId)
    {
        // 先执行默认批处理取消
        BatchJob.Cancel(batchJobId);
        
        // 再取消所有正在运行的子任务
        BackgroundJob.CancelAllRunningChildJobs(batchJobId);
    }
}

注意事项 #

1. 任务方法必须正确响应CancellationToken：需在耗时操作中传入令牌（如示例中的await Task.Delay(30000, ct)），否则即使调用Delete也无法终止任务。
2. 不同存储后端（如Redis、PostgreSQL）的查询语句需对应调整，需匹配实际使用的存储结构。
3. 批量操作时建议添加异常处理，避免单个子任务取消失败影响整体流程。

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