如何应用quartz定时任务？

Quartz可以用来做什么？

Quartz是一个强大任务调度框架，我工作时候会在这些情况下使用到quartz框架，当然还有很多的应用场景，在这里只列举2个实际用到的

• 餐厅系统会在每周四晚上的22点自动审核并生成报表
• 人事系统会在每天早晨8点给有待办的人员自动发送Email提醒

使用Quartz之前的准备

1.建立一个Maven项目

2.引入quartz的依赖

使用quartz，我们仅仅需要在maven的pom文件中添加依赖即可。我使用的是现在最新的一个版本2.3.0，大家可以在maven的仓库获取到最新的版本依赖。

quartz下载地址：http://www.quartz-scheduler.org/downloads/

但然也可以使用这个2.3.0的依赖，下面的例子都是使用此依赖并实现了效果。

<dependency>
    <groupId>org.quartz-schedulergroupId>
    <artifactId>quartzartifactId>
    <version>2.3.0version>
dependency>

案例

一句话看懂quartz

• 1、创建调度工厂(); 　　 //工厂模式
• 2、根据工厂取得调度器实例(); 　//工厂模式
• 3、Builder模式构建子组件 　　 // builder模式, 如JobBuilder、TriggerBuilder、DateBuilder
• 4、通过调度器组装子组件 调度器.组装<子组件1,子组件2…> 　//工厂模式
• 5、调度器.start();　　 //工厂模式

一、每隔2秒钟打印一次HelloQuartz

先实现一下这个基本的Quartz的任务再来介绍一下Quartz的3个重要组成，JobDetail，Trigger，Scheduler

1、创建一个类 HelloJob.java，这个类是编写我们的具体要实现任务（打印Hello Quartz）

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

import java.text.SimpleDateFormat;
import java.util.Date;

public class HelloJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        //打印当前的执行时间 例如 2022-6-27 00:00:00
        Date date = new Date();
        SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        System.out.println("现在的时间是："+ sf.format(date));
        //具体的业务逻辑
        System.out.println("Hello Quartz");
    }
}

2、创建一个类Scheduler方法，这个是具体触发我们的任务

// 触发我们的任务方法
public static void helloScheduler() throws Exception{
    // 创建一个jobDetail的实例，将该实例和HelloJob.class绑定
    JobDetail jobDetail = JobBuilder.newJob(HelloJob.class).withIdentity("helloJob").build();

    // 创建一个helloTrigger触发器的实例，定义该job立即执行，并且每两秒执行一次，并且一直执行
    Trigger helloTrigger = TriggerBuilder.newTrigger().withIdentity("helloTrigger").startNow()
            .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(2).repeatForever()).build();

    // 创建 Scheduler 实例
    StdSchedulerFactory schedulerFactory = new StdSchedulerFactory();
    org.quartz.Scheduler scheduler = schedulerFactory.getScheduler();
    scheduler.start();
    scheduler.scheduleJob(jobDetail,helloTrigger);
}

3、测试，在主函数中调用该方法

public static void main(String[] args) throws Exception {
    helloScheduler();
}

二、 每日的9点40分触发任务打印HelloQuartz

上一个的简单案例的区别在于，SimpleTrigger/CronTrigger. 简单的定时任务,可以采用SimpleTrigger,复杂的任务一般采用CronTrigger。

cronTrigger不仅可以设定单的触发时间表,更可以设定非常复杂的触发时间表。

CronTrigger 是基于 Unix类似于 cron 表达式,如果对cron表达式比较熟悉,那么学习起来经非常简单. 即使对cron表达式不熟悉,花一会儿的功夫也可以学会。

（在工作中我们直接使用网上的在线生成表达式即可又快又准确）生成地址：https://cron.qqe2.com/

1、编写任务类 HelloJob1.java，具体情况编写具体内容，如生成报表，发送邮件。

public class HelloJob1 implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        //打印当前的执行时间 例如 2022-6-27 00:00:00
        Date date = new Date();
        SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        System.out.println("现在的时间是："+ sf.format(date));
        //具体的业务逻辑
        System.out.println("开始生成任务报表 或 开始发送邮件");
    }
}

2、编写任务触发类 CronScheduler方法

// 触发我们的任务方法
public static void CronScheduler() throws Exception{
    // 创建一个jobDetail的实例，将该实例和HelloJob.class绑定
    JobDetail jobDetail = JobBuilder.newJob(HelloJob1.class).withIdentity("helloJob").build();

    // 创建一个helloTrigger触发器的实例，定义该job立即执行，并且每两秒执行一次，并且一直执行
    CronTrigger cronTrigger = TriggerBuilder.newTrigger().withIdentity("cronTrigger")
            .withSchedule(CronScheduleBuilder.cronSchedule("0 52 15 * * ? ")).build();
    // 表示每天的15：52执行此方法

    // 创建 Scheduler 实例
    StdSchedulerFactory schedulerFactory = new StdSchedulerFactory();
    org.quartz.Scheduler scheduler = schedulerFactory.getScheduler();
    scheduler.start();
    scheduler.scheduleJob(jobDetail,cronTrigger);
}

3、调用该方法，测试

   public static void main(String[] args) throws Exception {
        CronScheduler();
    }

cron表达式编写规则

1.　Quartz Cron 表达式支持7个域 ,分别是秒/分/时/日/月/周/年.期中年是非必须项.如下图

名称	是否必须	允许值	特殊字符
秒	是	0-59	, - * /
分	是	0-59	, - * /
时	是	0-23	, - * /
日	是	1-31	, - * ? / L W C
月	是	1-12 或 JAN-DEC	, - * /
周	是	1-7 或 SUN-SAT	, - * ? / L C #
年	否	空 或 1970-2099	, - * /

注意在cron表达式中不区分大小写.

• 星号(**)：可用在所有字段中，表示对应时间域的每一个时刻，例如，* 在分钟字段时，表示“每分钟”；
• 问号（?）：该字符只在日期和星期字段中使用，它通常指定为“无意义的值”，相当于点位符；
• 减号(-)：表达一个范围，如在小时字段中使用“10-12”，则表示从10到12点，即10,11,12；
• 逗号(,)：表达一个列表值，如在星期字段中使用“MON,WED,FRI”，则表示星期一，星期三和星期五；
• 斜杠(/)：x/y表达一个等步长序列，x为起始值，y为增量步长值。如在分钟字段中使用0/15，则表示为0,15,30和45秒，而5/15在分钟字段中表示5,20,35,50，你也可以使用*/y，它等同于0/y；
• 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表示当月的第五个星期三，假设当月没有第五个星期三，忽略不触发；
• C：该字符只在日期和星期字段中使用，代表“Calendar”的意思。它的意思是计划所关联的日期，如果日期没有被关联，则相当于日历中所有日期。例如5C在日期字段中就相当于日历5日以后的第一天。1C在星期字段中相当于星期日后的第一天。

Cron表达式对特殊字符的大小写不敏感，对代表星期的缩写英文大小写也不敏感。

2.官方的一些案例

表示式	说明
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分运行。

以上就可以实现大部分的业务的需求了，以下是对Quartz的API的一些了解

Quartz的三个基本要素

Quartz对任务调度的领域问题进行了高度的抽象，提出了调度器、任务和触发器这3个核心的概念，并在org.quartz通过接口和类对重要的这些核心概念进行描述：

●Job：是一个接口，只有一个方法void execute(JobExecutionContext context)，开发者实现该接口定义运行任务，JobExecutionContext类提供了调度上下文的各种信息。Job运行时的信息保存在JobDataMap实例中；

●JobDetail：Quartz在每次执行Job时，都重新创建一个Job实例，所以它不直接接受一个Job的实例，相反它接收一个Job实现类，以便运行时通过newInstance()的反射机制实例化Job。因此需要通过一个类来描述Job的实现类及其它相关的静态信息，如Job名字、描述、关联监听器等信息，JobDetail承担了这一角色。

通过该类的构造函数可以更具体地了解它的功用：JobDetail(java.lang.String name, java.lang.String group, java.lang.Class jobClass)，该构造函数要求指定Job的实现类，以及任务在Scheduler中的组名和Job名称；

●Trigger：是一个类，描述触发Job执行的时间触发规则。主要有SimpleTrigger和CronTrigger这两个子类。当仅需触发一次或者以固定时间间隔周期执行，SimpleTrigger是最适合的选择；而CronTrigger则可以通过Cron表达式定义出各种复杂时间规则的调度方案：如每早晨9:00执行，周一、周三、周五下午5:00执行等；

●Calendar：org.quartz.Calendar和java.util.Calendar不同，它是一些日历特定时间点的集合（可以简单地将org.quartz.Calendar看作java.util.Calendar的集合——java.util.Calendar代表一个日历时间点，无特殊说明后面的Calendar即指org.quartz.Calendar）。一个Trigger可以和多个Calendar关联，以便排除或包含某些时间点。

假设，我们安排每周星期一早上10:00执行任务，但是如果碰到法定的节日，任务则不执行，这时就需要在Trigger触发机制的基础上使用Calendar进行定点排除。针对不同时间段类型，Quartz在org.quartz.impl.calendar包下提供了若干个Calendar的实现类，如AnnualCalendar、MonthlyCalendar、WeeklyCalendar分别针对每年、每月和每周进行定义；

●Scheduler：代表一个Quartz的独立运行容器，Trigger和JobDetail可以注册到Scheduler中，两者在Scheduler中拥有各自的组及名称，组及名称是Scheduler查找定位容器中某一对象的依据，Trigger的组及名称必须唯一，JobDetail的组和名称也必须唯一（但可以和Trigger的组和名称相同，因为它们是不同类型的）。Scheduler定义了多个接口方法，允许外部通过组及名称访问和控制容器中Trigger和JobDetail。

Scheduler可以将Trigger绑定到某一JobDetail中，这样当Trigger触发时，对应的Job就被执行。一个Job可以对应多个Trigger，但一个Trigger只能对应一个Job。可以通过SchedulerFactory创建一个Scheduler实例。Scheduler拥有一个SchedulerContext，它类似于ServletContext，保存着Scheduler上下文信息，Job和Trigger都可以访问SchedulerContext内的信息。SchedulerContext内部通过一个Map，以键值对的方式维护这些上下文数据，SchedulerContext为保存和获取数据提供了多个put()和getXxx()的方法。可以通过Scheduler# getContext()获取对应的SchedulerContext实例；

●ThreadPool：Scheduler使用一个线程池作为任务运行的基础设施，任务通过共享线程池中的线程提高运行效率。

Job有一个StatefulJob子接口，代表有状态的任务，该接口是一个没有方法的标签接口，其目的是让Quartz知道任务的类型，以便采用不同的执行方案。无状态任务在执行时拥有自己的JobDataMap拷贝，对JobDataMap的更改不会影响下次的执行。而有状态任务共享共享同一个JobDataMap实例，每次任务执行对JobDataMap所做的更改会保存下来，后面的执行可以看到这个更改，也即每次执行任务后都会对后面的执行发生影响。

正因为这个原因，无状态的Job可以并发执行，而有状态的StatefulJob不能并发执行，这意味着如果前次的StatefulJob还没有执行完毕，下一次的任务将阻塞等待，直到前次任务执行完毕。有状态任务比无状态任务需要考虑更多的因素，程序往往拥有更高的复杂度，因此除非必要，应该尽量使用无状态的Job。

如果Quartz使用了数据库持久化任务调度信息，无状态的JobDataMap仅会在Scheduler注册任务时保持一次，而有状态任务对应的JobDataMap在每次执行任务后都会进行保存。

Trigger自身也可以拥有一个JobDataMap，其关联的Job可以通过JobExecutionContext#getTrigger().getJobDataMap()获取Trigger中的JobDataMap。不管是有状态还是无状态的任务，在任务执行期间对Trigger的JobDataMap所做的更改都不会进行持久，也即不会对下次的执行产生影响。

Quartz拥有完善的事件和监听体系，大部分组件都拥有事件，如任务执行前事件、任务执行后事件、触发器触发前事件、触发后事件、调度器开始事件、关闭事件等等，可以注册相应的监听器处理感兴趣的事件。

Quartz的3大API之一 - Job

JobDetail & Job和JobDataMap

JobDetail是任务的定义，而Job是任务的执行逻辑。在JobDetail里会引用一个Job Class定义。

每一个JobDetail都会有一个JobDataMap。JobDataMap本质就是一个Map的扩展类，只是提供了一些更便捷的方法，比如getString()之类的。

可以携带参数

1、编写CronScheduler1方法，传递参数

// 触发我们的任务方法
public static void CronScheduler1() throws Exception{
    // 创建一个jobDetail的实例，将该实例和HelloJob.class绑定
    JobDetail jobDetail = JobBuilder.newJob(HelloJob2.class) //定义Job类为HelloJob类，真正的执行逻辑所在
            .withIdentity("jobDetail") //定义name 和 group
            .usingJobData("age","23") //加入属性到jobDataMap
            .usingJobData("name","张三") //加入属性到jobDataMap
            .build();

    // 创建一个helloTrigger触发器的实例，定义该job立即执行，并且每两秒执行一次，并且一直执行
    CronTrigger cronTrigger = TriggerBuilder.newTrigger().withIdentity("cronTrigger")
            .withSchedule(CronScheduleBuilder.cronSchedule("0 26 15 * * ? ")).build();

    // 创建 Scheduler 实例
    StdSchedulerFactory schedulerFactory = new StdSchedulerFactory();
    org.quartz.Scheduler scheduler = schedulerFactory.getScheduler();
    scheduler.start();
    scheduler.scheduleJob(jobDetail,cronTrigger);
}

2、编写任务类 HelloJob2.java，接收参数

public class HelloJob2 implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        //打印当前的执行时间 例如 2022-6-27 00:00:00
        Date date = new Date();
        SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        System.out.println("现在的时间是："+ sf.format(date));
        //具体的业务逻辑
        JobDataMap jobDataMap = jobExecutionContext.getJobDetail().getJobDataMap();
        Object name = jobDataMap.get("name");
        Object age = jobDataMap.get("age");
        System.out.println(name+"--------"+age);
    }
}

3、调用该方法，测试

public static void main(String[] args) throws Exception {
        CronScheduler1();
    }

springboot中结合redis的定时计划

创建springboot工程

导入pom依赖

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-data-redisartifactId>
dependency>

<dependency>
    <groupId>org.quartz-schedulergroupId>
    <artifactId>quartzartifactId>
    <version>2.3.0version>
dependency>


<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-webartifactId>
dependency>

<dependency>
    <groupId>com.chenshuanggroupId>
    <artifactId>chenshuangpe_utilartifactId>
    <version>0.0.1-SNAPSHOTversion>
dependency>

创建主启动类

@EnableScheduling开启开启计划任务的支持，并排除数据库资源

// 排除数据库资源，防止出错
@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)

// 开启计划任务的支持（类上）
@EnableScheduling
public class PeJobStarter {
    public static void main(String[] args) {
        SpringApplication.run(PeJobStarter.class,args);
    }
}

创建定时配置删除文件类

// 交给spring容器管理
@Component
public class CleanImgJob {

    @Resource
    private RedisTemplate redisTemplate;

    // 定时计划
    @Scheduled(cron = "0/50 * * * * ?")

    public void scheduleTask(){
        // 取redis中的两个集合的差集
        Set<String> differenceList = redisTemplate.opsForSet().difference(RedisConstant.SETMEAL_PIC_UPLOAD, RedisConstant.SETMEAL_PIC_DB);
        // 判断如果差集不为空的情况，就删除垃圾图片
        if (differenceList!=null && differenceList.size()>0){
            for (String imgName : differenceList) {
                File file = new File("D:\\develop\\IDEA\\javaUp\\pro\\chenshuangpe_parent\\upload\\images", imgName);
                file.delete();
                // 从文件加中删除垃圾图片 redis数据库删除
                redisTemplate.opsForSet().remove(RedisConstant.SETMEAL_PIC_UPLOAD,imgName);
            }
        }
    }
}