摘要

Quartz.net 是一个功能强大的用于调度任务的开源库，它允许你在指定的时间点或时间间隔触发任务。它被广泛用于 .NET 平台中的任务调度和定时任务管理。Quartz.net 提供了丰富的功能和灵活的调度选项，可以用于各种场景，如定时执行任务、后台作业、定时发送邮件等。

正文

Quartz.net 的主要作用是在指定的时间点或时间间隔执行任务。它允许你创建定时任务，根据特定的触发条件来调度任务，以及管理任务的状态、暂停和恢复任务等。

常用属性

1. Scheduler：调度器对象，用于创建和管理任务。
2. Trigger：触发器对象，定义任务的触发条件，如时间点或时间间隔。
3. JobDetail：任务详情对象，定义要执行的任务。
4. CronExpression：Cron 表达式，用于定义复杂的时间触发规则。

常用方法

1. Start()：启动调度器，开始执行任务调度。
2. Shutdown()：关闭调度器，停止任务调度。
3. ScheduleJob(jobDetail, trigger)：安排一个任务和触发器进行调度。
4. PauseJob(jobKey)：暂停指定任务。
5. ResumeJob(jobKey)：恢复指定任务。
6. DeleteJob(jobKey)：删除指定任务。
7. GetCurrentlyExecutingJobs()：获取当前正在执行的任务列表。

nuget 安装Quartz.net

简单的调用Job

private async void btnStart_Click(object sender, EventArgs e)
{
    IJobDetail job = JobBuilder.Create<CollectJob>()
    .WithIdentity("TestJob", "Test")
    .Build();


    ITrigger trigger = TriggerBuilder.Create()
      .WithIdentity("TestJobTrigger", "Test")
      .WithSimpleSchedule(x =>
      {
          x.WithIntervalInSeconds(3).RepeatForever();
      })
      .Build();

    StdSchedulerFactory factory = new StdSchedulerFactory();

    //创建任务调度器
    IScheduler scheduler = await factory.GetScheduler();
    //启动任务调度器
    await scheduler.Start();

    //将创建的任务和触发器条件添加到创建的任务调度器当中
    await scheduler.ScheduleJob(job, trigger);
}

带callback回调Job

CollectJob.cs

/// <summary>
/// 创建一个任务 
/// </summary>
public class CollectJob : IJob
{

    public async Task Execute(IJobExecutionContext context)
    {
        JobDataMap dataMap = context.JobDetail.JobDataMap;
        var act= (Action<string>)dataMap.Get("callback");
        act(DateTime.Now.ToString("yyyyMMddHHmmss"));
        //做定时业务
        await Task.Run(() =>
        {

        });
    }

}

private async void btnCallbackStart_Click(object sender, EventArgs e)
{
    // 创建调度器
    ISchedulerFactory schedulerFactory = new StdSchedulerFactory();
    IScheduler scheduler = await schedulerFactory.GetScheduler();

    // 将 IJob 的实现类转换为 IJobDetail
    IJobDetail jobDetail = JobBuilder.Create<CollectJob>()
        .WithIdentity("collectJob", "test")
        .Build();

    //回调
    Action<string> action = new Action<string>((x) =>
    {
        this.Invoke(() =>
        {
            txtLog.AppendText(x);
            txtLog.AppendText(System.Environment.NewLine);
        });
    });

    jobDetail.JobDataMap["callback"] = action;

    // 创建触发器，每隔 3 秒触发一次
    ITrigger trigger = TriggerBuilder.Create()
        .WithIdentity("testTrigger", "test")
        .StartNow()
        .WithSimpleSchedule(x => x
            .WithIntervalInSeconds(3)
            .RepeatForever())
        .Build();

    // 将任务和触发器安排到调度器中
    await scheduler.ScheduleJob(jobDetail, trigger);

    // 启动调度器
    await scheduler.Start();

}

JobDataMap 是 Quartz.NET 中一个非常有用的特性，它用于传递数据给作业（Job）。在调度器（Scheduler）调度任务时，你可以使用 JobDataMap 来将一些参数、配置或任何类型的数据传递给作业，并在作业的执行过程中访问这些数据。这是一种非常方便的方式，可以帮助你根据需要动态地配置作业的行为。

触发器（Trigger）

触发器（Trigger）可以使用 Cron 表达式或简单表达式（Simple Schedule Expression）来指定触发规则。Cron 表达式可以用于更复杂的时间调度，而简单表达式则适用于简单的固定间隔触发。

1. Cron 表达式例子： 每分钟执行一次：0 * * ? * * 每小时的 30 分钟执行一次：0 30 * ? * * 每天的 10:15 AM 执行一次：0 15 10 ? * * 每月的第一天的 12:00 PM 执行一次：0 0 12 1 * ? 每周一到周五的 9:30 AM 执行一次：0 30 9 ? * MON-FRI
2. 简单表达式例子： 每 5 秒执行一次：0/5 * * * * ? 每分钟执行一次：0 0/1 * * * ? 每小时执行一次：0 0 0/1 * * ? 每天的 10:15 AM 执行一次：0 15 10 ? * * 每周一到周五的 9:30 AM 执行一次：0 30 9 ? * MON-FRI

注意：Cron 表达式的格式为：秒 分 时 日 月 星期，使用空格来分隔不同的时间单位。简单表达式的格式是：秒 分 小时 天 月 年。

// 每周一到周五的 8:45 AM 执行一次：0 45 8 ? * MON-FRI
ITrigger trigger = TriggerBuilder.Create()
    .WithIdentity("testTrigger", "test")
    .WithCronSchedule("0 45 8 ? * MON-FRI")
    .Build();

增加暂停与继续功能

private async void btnPause_Click(object sender, EventArgs e)
{
    // 暂停任务
    JobKey jobKey = new JobKey("collectJob", "test");
    await scheduler.PauseJob(jobKey);
}

private async void btnResume_Click(object sender, EventArgs e)
{
    // 恢复任务
    JobKey jobKey = new JobKey("collectJob", "test");
    await scheduler.ResumeJob(jobKey);
}