如何中断Topshelf.Quartz作业？停止服务后无调度实例的处理方法

我正好处理过类似的场景，当Topshelf服务停止时要中断正在运行的Quartz作业，而且没有直接持有调度器实例的情况，咱们可以通过以下几个步骤来实现：

1. 让你的Job实现IInterruptableJob接口 #

Quartz原生提供了IInterruptableJob接口来支持中断正在运行的作业，这是实现协作式中断的基础。你需要在自定义Job类中实现这个接口，维护一个中断标志，并在执行逻辑中定期检查它。

示例代码：

public class MyJob : IInterruptableJob
{
    // volatile确保多线程下的可见性
    private volatile bool _isInterrupted = false;

    public Task Execute(IJobExecutionContext context)
    {
        return Task.Run(() =>
        {
            // 模拟长时间运行的作业逻辑
            for (int i = 0; i < 100; i++)
            {
                // 检查中断标志，一旦触发就停止执行
                if (_isInterrupted)
                {
                    Console.WriteLine("作业被中断，立即停止执行");
                    break;
                }
                
                Console.WriteLine($"作业正在执行：第{i}步");
                Thread.Sleep(1000); // 模拟耗时操作
            }
        });
    }

    // 实现中断方法，设置中断标志
    public Task Interrupt()
    {
        _isInterrupted = true;
        Console.WriteLine("收到中断信号，标记作业为中断状态");
        return Task.CompletedTask;
    }
}

2. 在Topshelf配置中捕获调度器实例并绑定停止事件 #

虽然你一开始没有调度器实例，但可以在Topshelf的Quartz作业配置环节，通过UsingScheduler方法把调度器实例保存下来，然后在服务的WhenStopping事件中触发中断操作。

示例配置代码：

HostFactory.Run(x =>
{
    // 声明一个变量来保存调度器实例
    IScheduler _quartzScheduler = null;

    x.Service<MyService>(s =>
    {
        s.ConstructUsing(name => new MyService());
        s.WhenStarted(tc => tc.Start());
        
        // 绑定服务停止前的事件，在这里处理作业中断
        s.WhenStopping(async tc => 
        {
            if (_quartzScheduler == null) return;

            try
            {
                // 获取所有正在执行的作业
                var executingJobs = await _quartzScheduler.GetCurrentlyExecutingJobs();
                
                foreach (var jobExecutionContext in executingJobs)
                {
                    // 判断当前作业是否实现了IInterruptableJob
                    if (jobExecutionContext.JobInstance is IInterruptableJob interruptableJob)
                    {
                        // 触发中断
                        await interruptableJob.Interrupt();
                    }
                }
                
                // 可选：等待所有作业中断完成后再停止服务
                await Task.Delay(2000);
            }
            catch (Exception ex)
            {
                Console.WriteLine($"中断作业时发生异常：{ex.Message}");
            }
            
            tc.Stop();
        });

        // 配置Quartz作业，并保存调度器实例
        s.ScheduleQuartzJob(q => q
            .WithJob(() => JobBuilder.Create<MyJob>().Build())
            .AddTrigger(() => TriggerBuilder.Create()
                .WithSimpleSchedule(b => b
                    .WithIntervalInSeconds(10)
                    .RepeatForever())
                .Build())
            // 在这里捕获调度器实例
            .UsingScheduler(sched => _quartzScheduler = sched));
    });

    x.RunAsLocalSystem();
    x.SetServiceName("MyQuartzService");
    x.SetDisplayName("我的Quartz调度服务");
});

3. 关键注意事项 #

• 协作式中断：Quartz不会强制终止作业，必须由你的Job主动检查中断标志并停止执行。所以一定要在耗时的循环、异步操作中插入检查点。
• 异步作业适配：如果你的Job是纯异步执行的（比如用await），要确保在异步流程中也能检查到中断标志，避免出现无法中断的情况。
• 异常处理：在中断过程中可能会遇到调度器未就绪、作业执行异常等情况，记得添加异常捕获逻辑，保证服务能正常停止。

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