作业调度框架Quartz.net用法详解

目录

• 一、介绍
• quartz的构成和基本工作流程
• 二、基于文件配置
• 1、引入包
• 2、配置
• 3、接口实现
• 4、启动Quartz
• 5、禁用Quartz.NET日志输出
• 6、当应用或网站关闭时结束正在执行的工作
• 三、基于代码的方式
• 四、Quartz.net的概念和基本用法
• 1.TriggerBuilder介绍
• 1、SimpleSchedule
• 2、CalendarIntervalSchedule
• 3、DailyTimeIntervalSchedule
• 4、CronSchedule
• 5、Cron表达式
• 2.Scheduler介绍
• 3.Calendar介绍
• 4.Listener介绍
• 五、Quartz.net通过数据库持久化与配置集群。
• 1.JobStore介绍
• 2.Db持久化和集群配置
• 第一步：添加数据库表
• 第二步：配置QuartzFactory属性，直接看代码：
• 3.一些需要注意的地方

一、介绍

Quartz.NET是一个强大、开源、轻量的作业调度框架，你能够用它来为执行一个作业而创建简单的或复杂的作业调度。它有很多特征，如：数据库支持，集群，插件，支持cron-like表达式等等。在2017年的最后一天Quartz.NET 3.0发布，正式支持了.NET Core 和async/await。这是一个大版本，有众多新特性和大的功能

官网：http://www.quartz-scheduler.net/

源码：https://github.com/quartznet/quartznet

示例：https://www.quartz-scheduler.net/documentation/quartz-3.x/quick-start.html

新功能

• 支持 async/await 基于任务的作业，内部以async/await工作
• 支持.NET Core / netstandard 2.0和.NET Framework 4.5.2及更高版本
• 通过提供程序名称SQLite-Microsoft支持Microsoft.Data.Sqlite，旧的提供程序SQLite也仍然有效，还可以用
• 增加了对SQL Server内存优化表的初步支持和Quartz.Impl.AdoJobStore.UpdateLockRowSemaphoreMOT
• 从依赖关系中删除Common.Logging
• 删除C5 Collections，使用.NET框架内置的Collections
• 在插件启动时添加对作业调度XML文件的验证
• 在TimeZoneUtil中添加对额外自定义时区解析器功能的支持

Quartz3.x和2.x最大的优势在于：支持异步执行Job，所以建议将Job的Excute方法设计为异步方法，这样做可以提高任务调度和执行效率。

quartz的构成和基本工作流程

在使用Quart.net前，我们先理解下quartz的构成和基本工作流程，

1、Quartz包含以下五个基本部分:

• Scheduler 调度器，quartz工作时的独立容器
• Trigger 触发器，定义了调度任务的时间规则
• Job 调度的任务
• ThreadPool 线程池（不是clr中的线程池），任务最终交给线程池中的线程执行
• JobStore RAWStore和DbStore两种，job和trigger都存放在JobStore中

2、Quartz的基本工作流程：

scheduler是quartz的独立运行容器，trigger和job都可以注册在scheduler容器中。

其中trigger是触发器，用于定义调度任务的时间规则，job是被调度的任务，一个job可以有多个触发器，而一个触发器只能属于一个job。

Quartz中一个调度线程QuartzSchedulerThread，调度线程可以找到将要被触发的trigger，通过trigger找到要执行的job，然后在ThreadPool中获取一个线程来执行这个job。

JobStore主要作用是存放job和trigger的信息。

二、基于文件配置

Quartz.NET 在3.x已经将插件分离了，所以如果要从xml直接加载文件，需要引入插件包

1、引入包

2、配置

app.config

<xml version="1.0" encoding="utf-8"?>
<configuration>

  <configSections>
    <section name="quartz" type="System.Configuration.NameValueSectionHandler, System, Version=1.0.5000.0,Culture=neutral, PublicKeyToken=b77a5c561934e089" />
  </configSections>

  <quartz>
    <add key="quartz.scheduler.instanceName" value="QuartzScheduler"/>
    <add key="quartz.threadPool.type" value="Quartz.Simpl.SimpleThreadPool, Quartz"/>
    <add key="quartz.threadPool.threadCount" value="10"/>
    ******************************Plugin配置*********************************************
    <add key="quartz.plugin.jobInitializer.type" value="Quartz.Plugin.Xml.XMLSchedulingDataProcessorPlugin, Quartz.Plugins"/>
    <add key="quartz.plugin.jobInitializer.fileNames" value="quartz_jobs.xml"/>
  </quartz>

  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2"/>
  </startup>

</configuration>

quartz_jobs.xml

<xml version="1.0" encoding="UTF-8"?>

 This file contains job definitions in schema version 2.0 format 

<job-scheduling-data xmlns="http://quartznet.sourceforge.net/JobSchedulingData" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0">

  <processing-directives>
    <overwrite-existing-data>true</overwrite-existing-data>
  </processing-directives>


  <schedule>

    开始执行一个调度
    <job>
      <name>jldwjob</name>
      <group>kelun</group>
      <description>计量单位</description>
      格式：实现了IJob接口的包含完整命名空间的类名,程序集名称
      <durable>true</durable>
      <recover>false</recover>
    </job>
    
    <trigger>
      <cron>
        <name>jlwd</name>
        <group>kelun</group>
        <job-name>jldwjob</job-name>
        <job-group>kelun</job-group>
        2018-01-22T00:00:00+08:00
        每3秒执行一次
      </cron>
    </trigger>

  </schedule>
</job-scheduling-data>

3、接口实现

using Kelun.Log4Net;
using Quartz;
using System.Reflection;
using System.Threading.Tasks;

namespace Kelun
{
    class JldwJob : IJob
    {

        private static readonly IMyLog Logger = MyLogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);

        public Task Execute(IJobExecutionContext context)
        {
            return Task.Run(() => 
            {
                Logger.Info("定时任务执行");
            });
        }
    }
}

4、启动Quartz

public MainForm()
{
    InitializeComponent();
    RunProgramAsync().GetAwaiter().GetResult();
}

private static async Task RunProgramAsync()
{
    try
    {
        StdSchedulerFactory factory = new StdSchedulerFactory();

        IScheduler scheduler = await factory.GetScheduler();

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

        //创建一个作业
        //IJobDetail job = JobBuilder.Create().WithIdentity("myJob", "group1").Build();

        //ITrigger trigger = TriggerBuilder.Create()
        //    .WithIdentity("myTrigger", "group1")
        //    .StartNow()     //现在开始
        //    .WithSimpleSchedule(x => x
        //        .WithIntervalInSeconds(1)   //触发时间，1秒一次
        //        .RepeatForever())
        //    .Build();

        //把作业，触发器加入调度器。
       //await scheduler.ScheduleJob(job, trigger);  

        //await scheduler.Shutdown();

    }
    catch (SchedulerException se)
    {
        Logger.Error("执行错误", se);
    }
}

5、禁用Quartz.NET日志输出

<logger name="Quartz">
    <level value="OFF" />
</logger>

6、当应用或网站关闭时结束正在执行的工作

在Global.asax中的Application_End方法中添加如下代码：

        protected void Application_End(object sender, EventArgs e)
        {
            //   在应用程序关闭时运行的代码
            if (scheduler != null)
            {
                 scheduler.Shutdown(true);
             }
         }

三、基于代码的方式

用五分钟看一个简单的例子吧，这个例子中通过调度器工厂StdSchedulerFactory获取一个调度器实例scheduler，然后定义Job和trigger，并注册到调度器中，最后启动scheduler就可以执行我们的任务了。代码如下：

using Quartz;
using Quartz.Impl;
using System;
using System.Threading.Tasks;

namespace ConsoleApp3
{
    internal class Program
    {
        private static void Main(string[] args)
        {
            //调度器,生成实例的时候线程已经开启了，不过是在等待状态
            StdSchedulerFactory factory = new StdSchedulerFactory();
            IScheduler scheduler = factory.GetScheduler().Result;

            //创建一个Job,绑定MyJob
            IJobDetail job = JobBuilder.Create()              //获取JobBuilder
                                .WithIdentity("jobname1", "group1")  //添加Job的名字和分组
                                .WithDescription("一个简单的任务")   //添加描述
                                .Build();                            //生成IJobDetail

            //创建一个触发器
            ITrigger trigger = TriggerBuilder.Create()                   //获取TriggerBuilder  
                              .StartAt(DateBuilder.TodayAt(01, 00, 00))  //开始时间，今天的1点（hh,mm,ss），可使用StartNow()
                              .ForJob(job)                               //将触发器关联给指定的job
                              .WithPriority(10)                          //优先级，当触发时间一样时，优先级大的触发器先执行
                              .WithIdentity("tname1", "group1")          //添加触发器的名字和分组
                              .WithSimpleSchedule(x => x.WithIntervalInSeconds(1) //调度，一秒执行一次，执行三次
                                                        .WithRepeatCount(3)
                                                        .Build())
                              .Build();

            //start让调度线程启动【调度线程可以从jobstore中获取快要执行的trigger,然后获取trigger关联的job，执行job】
            scheduler.Start();
            //将job和trigger注册到scheduler中
            scheduler.ScheduleJob(job, trigger).Wait();
            Console.ReadKey();
        }
    }

    #region MyJob

    /// 

    /// 一个简单的Job，所有的Job都要实现IJob接口
    /// 
    public class MyJob : IJob
    {
        public async Task Execute(IJobExecutionContext context)
        {
            await Task.Run(() =>
            {
                Console.WriteLine("hello quartz!");
                //JobDetail的key就是job的分组和job的名字
                Console.WriteLine($"JobDetail的组和名字：{context.JobDetail.Key}");
                Console.WriteLine();
            });
        }
    }

    #endregion MyJob
}

通过Quartz来调度一个任务十分简单，执行结果如下：

四、Quartz.net的概念和基本用法

1.TriggerBuilder介绍

在Quartz中Trigger的作用是定义Job何时执行。

Quartz.net提供了四种触发策略：SimpleSchedule，CalendarIntervalSchedule，DailyTimeIntervalSchedule和CronSchedule。

TriggerBuilder顾名思义就是用来创建Trigger的。

1、SimpleSchedule

Simpleschedule 是最简单的一种触发策略，它的作用类似于timer，可以设置间隔几秒/几分钟/几小时执行一次，如创建一秒执行一次的触发器如下

ITrigger trigger = TriggerBuilder.Create()
        .StartNow()
        .WithIdentity("tname1", "group1")
        .WithSimpleSchedule(x => x.WithIntervalInSeconds(1)  //设置时间间隔，时分秒              
        .WithRepeatCount(3))       //设置执行次数，总共执行3+1次，
    .Build();

2、CalendarIntervalSchedule

CalendarIntervalSchedule扩展了Simplescheduler的功能，Simplescheduler只能在时分秒的维度上指定时间间隔，那么就有一个问题，如果我们想一个月执行一次怎么办呢？要知道每个月的天数是不一样的，用SimpleSchedule实现起来就十分麻烦了。 
CalendarIntervalSchedule可以实现时分秒天周月年的维度上执行轮询。如创建一个月执行一次的触发器如下：这样

ITrigger trigger = TriggerBuilder.Create()
    .StartAt(DateTimeOffset.Parse("2018/1/6 13:17:00"))
    .WithIdentity("tname1", "group1")
    .WithCalendarIntervalSchedule(x => x.WithIntervalInMonths(1))  //一月执行一次
    .Build();

3、DailyTimeIntervalSchedule

DailyTimeIntervalSchedule主要用于指定每周的某几天执行，如我们想让每周的周六周日的8:00-20:00，每两秒执行一次，创建触发器如下：

ITrigger trigger =TriggerBuilder.Create()
        .StartAt(DateTimeOffset.Parse("2018/1/6 13:17:00"))
        .WithIdentity("tname1", "group1")
        .WithDailyTimeIntervalSchedule(x => x.OnDaysOfTheWeek(new DayOfWeek[] { DayOfWeek.Saturday, DayOfWeek.Sunday }) //周六和周日
            .StartingDailyAt(TimeOfDay.HourMinuteAndSecondOfDay(8, 00, 00)) //8点开始
            .EndingDailyAt(TimeOfDay.HourMinuteAndSecondOfDay(20, 00, 00))  //20点结束
            .WithIntervalInSeconds(2)                                       //两秒执行一次，可设置时分秒维度
            .WithRepeatCount(3))                                            //一共执行3+1次
    .Build();

4、CronSchedule

CronSchedule是应用最多的触发策略，通过Cron表达是我们可以轻松地表示任意的时间节点，下边的代码创建了一个每隔5秒执行一次的触发器

ITrigger trigger = TriggerBuilder.Create()
    .StartAt(DateTimeOffset.Parse("2018/1/6 13:17:00"))
    .WithIdentity("tname1", "group1")
    .WithCronSchedule("3/5 * * * * ?")  //五秒执行一次
    .Build();

5、Cron表达式

cron表达式有七个部分组成，以此是秒、分、时、天、月、周、年，其中年是可选的。Cron表达式对特殊字符的大小写不敏感，对代表星期的缩写英文大小写也不敏感。

• 星号(*)：可用在所有字段中，表示对应时间域的每一个时刻。例如， 在分钟字段时，表示“每分钟”；
• 问号（?）：该字符只在日期和星期字段中使用，它通常指定为“无意义的值”，相当于点位符；
• 减号(-)：表达一个范围，如在小时字段中使用“10-12”，则表示从10到12点，即10,11,12；
• 逗号(,)：表达一个列表值，如在星期字段中使用“MON,WED,FRI”，则表示星期一，星期三和星期五；
• 斜杠(/)：x/y表达一个等步长序列，x为起始值，y为增量步长值。如5/15在分钟字段中表示5,20,35,50；
• L：该字符只在日期和星期字段中使用，代表“Last”的意思，但它在两个字段中意思不同。L在日期字段中，表示这个月份的最后一天，如一月的31号，非闰年二月的28号；如果L用在星期中，则表示星期六，等同于7。但是，如果L出现在星期字段里，而且在前面有一个数值X，则表示“这个月的最后X天”，例如，6L表示该月的最后星期五；
• W：该字符只能出现在日期字段里，是对前导日期的修饰，表示离该日期最近的工作日。例如15W表示离该月15号最近的工作日，如果该月15号是星期六，则匹配14号星期五；如果15日是星期日，则匹配16号星期一；如果15号是星期二，那结果就是15号星期二。但必须注意关联的匹配日期不能够跨月，如你指定1W，如果1号是星期六，结果匹配的是3号星期一，而非上个月最后的那天。W字符串只能指定单一日期，而不能指定日期范围；
• LW组合：在日期字段可以组合使用LW，它的意思是当月的最后一个工作日；
• 井号(#)：该字符只能在星期字段中使用，表示当月某个工作日。如6#3表示当月的第三个星期五(6表示星期五，#3表示当前的第三个)，而4#5表示当月的第五个星期三，假设当月没有第五个星期三，忽略不触发；

一些例子：

• 0 0 12 * * ?：每天12点运行
• 0 15 10 ? * *：每天10:15运行
• 0 15 10 * * ?：每天10:15运行
• 0 15 10 * * ? *：每天10:15运行
• 0 15 10 * * ? 2008：在2008年的每天10：15运行
• 0 * 14 * * ?：每天14点到15点之间每分钟运行一次，开始于14:00，结束于14:59。
• 0 0/5 14 * * ?：每天14点到15点每5分钟运行一次，开始于14:00，结束于14:55。
• 0 0/5 14,18 * * ?：每天14点到15点每5分钟运行一次，此外每天18点到19点每5钟也运行一次。
• 0 0-5 14 * * ?：每天14:00点到14:05，每分钟运行一次。
• 0 10,44 14 ? 3 WED：3月每周三的14:10分和14:44执行。
• 0 15 10 ? * MON-FRI：每周一，二，三，四，五的10:15分运行。
• 0 15 10 15 * ?：每月15日10:15分运行。
• 0 15 10 L * ?：每月最后一天10:15分运行。
• 0 15 10 ? * 6L：每月最后一个星期五10:15分运行。
• 0 15 10 ? * 6L 2007-2009：在2007,2008,2009年每个月的最后一个星期五的10:15分运行。
• 0 15 10 ? * 6#3：每月第三个星期五的10:15分运行。

2.Scheduler介绍

调度器scheduler是Quartz中的独立工作容器，所有的Trigger和Job都需要注册到scheduler中才能工作。我们可以通过SchedulerFactory来获取scheduler实例。如下：

//1.获取默认的标准Scheduler引用
IScheduler scheduler = StdSchedulerFactory.GetDefaultScheduler().Result;


//2.通过代码配置scheduler
 NameValueCollection properties = new NameValueCollection
            {
                //scheduler的名字
                ["quartz.scheduler.instanceName"] = "MyScheduler",
                // 设置线程池中线程个数为20个
                ["quartz.threadPool.threadCount"] = "20",
                ["quartz.threadPool.type"] = "Quartz.Simpl.SimpleThreadPool, Quartz",
                //JobStore类型为内存存储
                ["quartz.jobStore.type"] = "Quartz.Simpl.RAMJobStore, Quartz"
            };
            ISchedulerFactory factroy = new StdSchedulerFactory(properties);
            IScheduler scheduler= await factroy .GetScheduler();

这里列一些会经常用的到方法，方法比较简单直观，就不一一展示了。

scheduler.PauseJob(JobKey.Create("jobname", "groupname"));//暂停job
          scheduler.ResumeJob(JobKey.Create("jobname", "groupname"));//重新启动job
          scheduler.DeleteJob(JobKey.Create("jobname", "groupname"));//删除job
          scheduler.PauseTrigger(new TriggerKey("triggername", "groupname"));//暂停trigger
          scheduler.ResumeTrigger(new TriggerKey("triggername", "groupname"));//重新启动trigger
          scheduler.UnscheduleJob(new TriggerKey("triggername", "groupname"));//删除trigger
          scheduler.GetTriggersOfJob(JobKey.Create("jobname", "groupname"));//获取一个job的所有key    
          scheduler.Standby();  //暂停所有的触发器，可通过shceduler.Start()重启
          scheduler.Shutdown(); //关闭scheduler，释放资源。通过Shutdown()关闭后，不能通过Start()重启
          scheduler.GetMetaData();//获取scheduler的元数据
          scheduler.Clear();//清空容器中所有的IJob,ITrigger

         //调度多个任务
         Dictionary> triggersAndJobs = new Dictionary>();
         triggersAndJobs.Add(job1, new List() { trigger1,trigger2});
         triggersAndJobs.Add(job2, new List() { trigger3});
         await scheduler.ScheduleJobs(triggersAndJobs, true);

3.Calendar介绍

通过上边的介绍，我们知道通过触发器Trigger可以设置Job的执行时间，但是有时候只使用Trigger来调度比较麻烦，如一年中每天都执行，但是元旦、圣诞节和情人节这三天不执行。使用trigger也可以实现，但是比较麻烦，如果我们有一种方法可以方便地排除这三天就好办了，Calendar主要作用就是为了排除Trigger中一些特定的时间节点。看一个简单的栗子：

    class Program
    {
        static void Main(string[] args)
        {
            //调度器
            IScheduler scheduler = StdSchedulerFactory.GetDefaultScheduler().Result;
            //JobDetail
            IJobDetail job = JobBuilder
                                .Create()
                                .Build();

            //获取一个Calendar实例
            DailyCalendar calendar = new DailyCalendar(DateBuilder.DateOf(19, 0, 0).DateTime, DateBuilder.DateOf(23, 0, 0).DateTime);//21~23点不执行
            //将Calendar注册到Scheduler中
            scheduler.AddCalendar("myCalendar", calendar, true, true);//参数依次是:calendarname,calendar,是否替换同名clendar,是否更新trigger
            //获取一个触发器，并将calendar绑定到触发器上
            ITrigger trigger =
                          TriggerBuilder.Create()
                               .StartNow()
                               .WithIdentity("tname1", "group1")
                               .WithCronSchedule("0/2 * * * * ?")  //2秒执行一次
                               .ModifiedByCalendar("myCalendar")   //把Calendar绑定到trigger
                               .Build();

            //start让调度线程启动
            scheduler.Start();
            //将job添加到调度器中，同时将trigger绑定到job
            scheduler.ScheduleJob(job, trigger).Wait();
            Console.ReadKey();
        }
    }

    #region MyJob，继承IJob接口
    /// 

    /// 一个简单的Job
    /// 
    public class MyJob : IJob
    {public Task Execute(IJobExecutionContext context)
        {
            return Task.Run(() =>
            {
                Console.WriteLine($"触发时间：{context.ScheduledFireTimeUtc?.LocalDateTime},下次触发时间：{context.NextFireTimeUtc?.LocalDateTime}");
            });
        }

    }
    #endregion

执行结果：

使用Calendar的流程是：首先获取一个Calendar实例，然后将Calendar注册到scheduler容器中，在将Calendar绑定到触发器上即可。

Quartz.net中一共提供了六种Calendar，六种Calendar的用法大同小异，列举如下：

【1】DailyCalendar 用于排除一天中的某一段时间

DailyCalendar calendar = new DailyCalendar(DateBuilder.DateOf(19, 0, 0).DateTime, DateBuilder.DateOf(23, 0, 0).DateTime);//21~23点不执行

【2】WeeklyCalendar 用于排除一周中的某几天

WeeklyCalendar calendar = new WeeklyCalendar();
 calendar.SetDayExcluded(DayOfWeek.Sunday, true);//周日不执行 
//注：如果想让周日恢复执行，执行代码：  calendar.SetDayExcluded(DayOfWeek.Sunday, false);

【3】HolidayCalendar 用于排除某些日期 

HolidayCalendar calendar = new HolidayCalendar();
calendar.AddExcludedDate(DateTime.Parse("2018/1/2")); //2018年1月2号不执行
//注：如果想让2019/1/9恢复执行，执行代码：  calendar.RemoveExcludedDate(DateTime.Parse("2018/1/2"));

【4】MonthlyCalendar 用于排除每个月的某天*************************************

MonthlyCalendar calendar = new MonthlyCalendar();
calendar.SetDayExcluded(8, true); //每个月的8号不执行
//注：如果想让8号恢复执行，执行代码：  calendar.SetDayExcluded(8, false);

【5】AnnualCalendar 用于排除一年中的某些天*************************************

AnnualCalendar calendar = new AnnualCalendar();
calendar.SetDayExcluded(DateTime.Parse("2018/1/2"), true);//每年1月2号不执行
//注：如果想让1月8号恢复执行，执行代码：   calendar.SetDayExcluded(DateTime.Parse("2018/1/2"),true);

【6】CronCalendar 用于排除cron表达式表示的时间***************************

CronCalendar calendar = new CronCalendar("* * * 2 1 ?"); //每年的1月2号不执行

4.Listener介绍

TriggerListener和JobListener用法类似，这里以JobListener为例来介绍Quartz中的Listener。JobListener用于在Job执行前、后和被拒绝时执行一些动作，和Asp.net中的filter很相似，用法并不复杂，看一个简单的栗子：

using Quartz;
using Quartz.Impl;
using Quartz.Impl.Matchers;
using System;
using System.Collections.Specialized;
using System.Threading;
using System.Threading.Tasks;

namespace ConsoleApp3
{
    internal class Program
    {
        private static void Main(string[] args)
        {
            //获取调度器
            NameValueCollection pairs = new NameValueCollection() { { "quartz.threadPool.ThreadCount", "30" } };
            StdSchedulerFactory factory = new StdSchedulerFactory(pairs);
            IScheduler scheduler = factory.GetScheduler().Result;

            //创建Job
            IJobDetail job = JobBuilder
                                .Create()                     //获取JobBuilder
                                .WithIdentity("jobname1", "group1")  //添加Job的名字和分组
                                .Build();                            //生成IJobDetail

            //创建rigger
            ITrigger trigger =  TriggerBuilder.Create()                                  //获取JobBuilder
                              .StartAt(DateBuilder.TodayAt(01, 00, 00))  //开始时间，今天的1点（hh,mm,ss），可使用StartNow()
                              .WithPriority(10)                          //优先级，当触发时间一样时，优先级大的触发器先执行
                              .WithIdentity("tname1", "group1")          //添加名字和分组
                              .WithSimpleSchedule(x => x.WithIntervalInSeconds(1)
                                                        .RepeatForever()
                                                        .Build())
                              .Build();

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

            //myJobListener监控所有的job
            scheduler.ListenerManager.AddJobListener(new MyJobListener(), GroupMatcher.AnyGroup());
            //将job添加到调度器中，同时将trigger绑定到job
            scheduler.ScheduleJob(job, trigger).Wait();
            Console.ReadKey();
        }
    }

    #region MyJob，继承IJob接口

    /// 

    /// 一个简单的Job
    /// 
    public class MyJob : IJob
    {
        public async Task Execute(IJobExecutionContext context)
        {
            await Task.Run(() =>
            {
                Console.WriteLine("hello quartz!");
                Console.WriteLine($"ThreadPool中的线程个数：{context.Scheduler.GetMetaData().Result.ThreadPoolSize}");
            });
        }
    }

    #endregion MyJob，继承IJob接口

    #region myJobListener，继承IJobListener接口

    /// 

    /// 一个简单的JobListener,triggerListener类似
    /// 
    public class MyJobListener : IJobListener
    {
        public string Name => "hello joblisener";

        //job被拒绝时执行
        public async Task JobExecutionVetoed(IJobExecutionContext context, CancellationToken cancellationToken = default(CancellationToken))
        {
            await Task.Run(() => { });
        }

        //job开始前执行
        public async Task JobToBeExecuted(IJobExecutionContext context, CancellationToken cancellationToken = default(CancellationToken))
        {
            await Task.Run(() =>
            {
                Console.WriteLine("myjob-------------begin");
            });
        }

        //job完成后执行
        public async Task JobWasExecuted(IJobExecutionContext context, JobExecutionException jobException, CancellationToken cancellationToken = default(CancellationToken))
        {
            await Task.Run(() =>
            {
                Console.WriteLine("myjob---------------end");
                Console.WriteLine();
            });
        }

        #endregion myJobListener，继承IJobListener接口
    }
}

上边例子中，Listener执行的动作很简单，在Job执行前打印begin，执行后打印end，在实际开发中，我们可以在通过Listenter来记录job的执行日志，执行结果如下：

五、Quartz.net通过数据库持久化与配置集群。

1.JobStore介绍

学习持久化和集群前我们先了解一下Quartz.net中的JobStore，JobStore用于追踪任务调度相关的所有数据，如Job，Trigger，Calendar等。

Quartz.net 提供了两种JobStore:RAMJobStore,AdoJobStore。

1、RAMJobStore:RAMJobStore是最简单的JobStore，顾名思义这种JobStore将所有的数据都存放在内存中，这也是它运行速度快的原因，但是弊端也很明显:一旦应用结束或者遇到断电所有的数据都会丢失。

RAMJobStore是默认的JobStore，我们也已通过下边的代码来显式设置使用的JobStore为RAMJobStore。

quartz.jobStore.type = Quartz.Simpl.RAMJobStore, Quartz

2、AdoJobStore：AdoJobStore通过Ado.net将数据存储在数据库中，因此可以解决断电数据丢失的问题，但是因为要读写数据库所以效率相对较低。

AdoJobStore官方支持的数据库有：MySql,SqlServer,Sqllite,Oracle等，当前AdoJobStore只有一种类型JobStoreTX，这一点不同于Jave版本，java版本还有JobStoreCMT类型。

2.Db持久化和集群配置

Quartz.net配置数据库持久化和集群比较容易，可以分为简单的两步：

第一步：添加数据库表

我们首先要在数据库中添加一系列的表（在Quartz项目的database/tables文件夹下可以找到各种数据库表的生成脚本，Git地址https://github.com/quartznet/quartznet/tree/master/database/tables）。以Sqlserver为例，Sqlserver的数据表生成脚本如下：

（略）

在Sqlserver管理器中新建查询，粘贴上边的脚本，运行即可生成Quartz的数据库表，数据库的结构如下：

第二步：配置QuartzFactory属性，直接看代码：

    class Program
    {
        public static void Main(string[] args)
        {
            NameValueCollection pars = new NameValueCollection
            {
                //scheduler名字
                ["quartz.scheduler.instanceName"] = "MyScheduler",
                //线程池个数
                ["quartz.threadPool.threadCount"] = "20",
                //类型为JobStoreXT,事务
                ["quartz.jobStore.type"] = "Quartz.Impl.AdoJobStore.JobStoreTX, Quartz",
                //JobDataMap中的数据都是字符串
                //["quartz.jobStore.useProperties"] = "true",
                //数据源名称
                ["quartz.jobStore.dataSource"] = "myDS",
                //数据表名前缀
                ["quartz.jobStore.tablePrefix"] = "QRTZ_",
                //使用Sqlserver的Ado操作代理类
                ["quartz.jobStore.driverDelegateType"] = "Quartz.Impl.AdoJobStore.SqlServerDelegate, Quartz",
                //数据源连接字符串
                ["quartz.dataSource.myDS.connectionString"] = "Server=[yourserver];Database=quartzDb;Uid=sa;Pwd=[yourpass]",
                //数据源的数据库
                ["quartz.dataSource.myDS.provider"] = "SqlServer",
                //序列化类型
                ["quartz.serializer.type"] = "json",//binary
                //自动生成scheduler实例ID，主要为了保证集群中的实例具有唯一标识
                ["quartz.scheduler.instanceId"] = "AUTO",
                //是否配置集群
                ["quartz.jobStore.clustered"] = "true",
            };
            StdSchedulerFactory factory = new StdSchedulerFactory(pars);
            IScheduler scheduler = factory.GetScheduler().Result;
            scheduler.Start();
            IJobDetail job = JobBuilder.Create()
                .WithIdentity("job1", "g1")
                .Build();
            ITrigger trigger = TriggerBuilder.Create().WithIdentity("trigger1", "g1").WithCronSchedule("0/1 * * * * ?").Build();
            if (scheduler.CheckExists(job.Key).Result)
            {
                scheduler.DeleteJob(job.Key).Wait();
            }
            scheduler.ScheduleJob(job, trigger).Wait();
        }
    }

    public class MyJob : IJob
    {
        public async Task Execute(IJobExecutionContext context)
        {
            await Task.Run(() =>
            {
                Console.WriteLine($"hello! 当前时间：{DateTime.Now}");
                Console.WriteLine($"触发时间：{context.ScheduledFireTimeUtc?.LocalDateTime},下次触发时间：{context.NextFireTimeUtc?.LocalDateTime}");
                Console.WriteLine();

            });
        }
    }

上边的代码配置信息在代码中都有注释，这个例子实现了一个简单的任务调度：每秒打印一次任务的触发时间和下次触发时间。然后运行项目即可，到这里Db持久化和集群都配置完成了。运行程序Quartz会自动在数据库中记录调度任务相关的数据。

Quartz自动向数据库写入的trigger信息：

Quartz自动向数据库写入的Job信息：

程序执行结果：

到这里我们看到了Db持久化已经实现了，但是上边的例子，我们在代码中通过 ["quartz.jobStore.clustered"] = "true" 配置了集群，这个有什么用呢？

首先添加一个debug文件夹的副本

然后运行这两个文件夹下的xxx.exe文件（如果使用的是.net core，生成的是xxx.dll文件,进入dll文件所在目录，命令行运行 dotnet xxx.dll 即可启动）,运行结果如下：

如上所示，运行两个xxx.exe（core中是dll）后，原文件和副本在同一时间只有一个在运行，所以我们调度的任务没有重复执行。如果我们关掉正在执行的那个程序，那么另一个程序会开始执行。我们可以得出结论：Quartz的集群并不会造成任务重复执行，而且当一个服务器挂了后，另一个服务器会自动开始执行，这种机制大大增加了任务调度的容灾性能。

3.一些需要注意的地方

1.Quartz3.x支持async和await，为提高性能，我们最好将Job中的Execute方法都写成异步方法；

2.不管使用的是RAMJobStore还是AdoJobStore，千万不要通过代码来直接操作JobStore（比如我们直接通过代码修改数据库中的数据），JobStore让Quartz自动操作即可。
无论使用场景是web应用还是桌面程序，我们只使用Scheduler提供的接口方法来实现Job和Trigger等的增/删/改/查/暂停/恢复即可。

到此这篇关于作业调度框架Quartz.net用法的文章就介绍到这了。希望对大家的学习有所帮助，也希望大家多多支持易盾网络。