Quartz

Quartz可以用来做什么？

Quartz是一个任务调度框架。比如你遇到这样的问题

• 想每月25号，信用卡自动还款
• 想每年4月1日自己给当年暗恋女神发一封匿名贺卡
• 想每隔1小时，学习笔记到云盘

这些问题总结起来就是：在某一个有规律的时间点干某件事。并且时间的触发的条件可以非常复杂（比如每月最后一个工作日的17:50），复杂到需要一个专门的框架来干这个事。 Quartz就是来干这样的事，你给它一个触发条件的定义，它负责到了时间点，触发相应的Job起来干活。

Quartz API核心接口

• Scheduler：调度器。所有的调度都是由它控制。
• Trigger： 定义触发的条件。例子中，它的类型是SimpleTrigger，每隔1秒中执行一次（什么是SimpleTrigger下面会有详述）。
• TriggerBuilder：定义和创建Trigger实例的接口；
• Job：(作业)你通过scheduler执行任务，你的任务类需要实现的接口；
• JobDetail：(作业实例)定义Job的实例；
• JobBuilder：定义和创建JobDetail实例的接口;

关于name和group

JobDetail和Trigger都有name和group。

name是它们在这个sheduler里面的唯一标识。如果我们要更新一个JobDetail定义，只需要设置一个name相同的JobDetail实例即可。

group是一个组织单元，sheduler会提供一些对整组操作的API，比如 scheduler.resumeJobs()。

Trigger

• CalendarIntervalTrigger 日期触发器
• SimpleTrigger 简单触发器
• DailyTimeIntervalTrigger 日期触发类(日)
• CronTrigger cron表达式触发器

SimpleTrigger

指定从某一个时间开始，以一定的时间间隔（单位是毫秒）执行的任务。
它适合的任务类似于：9:00 开始，每隔1小时，执行一次。
它的属性有：

repeatInterval 重复间隔
repeatCount 重复次数。实际执行次数是 repeatCount+1。因为在startTime的时候一定会执行一次。** 下面有关repeatCount 属性的都是同理。　**

Main

public static void main(String[] args) throws Exception{
		//开启
		Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
		JobDetail jobDetail = JobBuilder.newJob(PrintJob.class).withIdentity("job1", "group1").build();
		SimpleTrigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1","triggerGroup1").startNow().withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(2).repeatForever()).build();
		scheduler.scheduleJob(jobDetail, trigger);
		System.out.println("=============begin");
		scheduler.start();
        TimeUnit.SECONDS.sleep(5);
        scheduler.shutdown();
        System.out.println("=============end");
		
	}

Job

package com.zhiyou100.test;

import java.util.Date;

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

public class PrintJob implements Job{
	
	public void execute(JobExecutionContext context) throws JobExecutionException {
		
		System.out.println("-------------------"+new Date());
	}

}

Springboot + Quartz

依赖

  <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-quartz</artifactId>
   </dependency>

Config

package com.example.config;

import org.quartz.*;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.example.job.PrintJob;

@Configuration
public class QuartzConfig {
	/********* 第1种Simple ***************/
	@Bean
	public JobDetail jobDetail() {
		return JobBuilder.newJob(PrintJob.class).withIdentity("job1", "group1").storeDurably().build();
	}
	/*
	 * @Bean public Trigger trigger(){ SimpleScheduleBuilder scheduleBuilder =
	 * SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(3).
	 * repeatForever(); return
	 * TriggerBuilder.newTrigger().withIdentity("trigger1").startNow().
	 * withSchedule(scheduleBuilder).forJob(jobDetail()).build(); }
	 */
	/********* 第2种Calendar ***************/

	/*
	 * @Bean public Trigger trigger(){ CalendarIntervalScheduleBuilder
	 * scheduleBuilder =
	 * CalendarIntervalScheduleBuilder.calendarIntervalSchedule().
	 * withIntervalInSeconds(10); return
	 * TriggerBuilder.newTrigger().withIdentity("trigger1").startNow().
	 * withSchedule(scheduleBuilder).forJob(jobDetail()).build();
	 * 
	 * }
	 */
	/********* 第3种Cron ***************/

	@Bean
	public Trigger trigger() {
		//[秒] [分] [小时] [日] [月] [周] [年]

		CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("0-59/2 * * * * ?");
		
		return TriggerBuilder.newTrigger().withIdentity("trigger1").startNow().withSchedule(scheduleBuilder)
				.forJob(jobDetail()).build();

	}
}

Job

package com.example.job;

import java.util.Date;

import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.quartz.QuartzJobBean;

public class PrintJob extends QuartzJobBean{

	private Logger logger = LoggerFactory.getLogger(PrintJob.class);
	@Override
	protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
		logger.info("time:++++++++"+new Date());
		
	}
	
	
}

注解

package com.example.job;

import java.util.Date;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
@Component
@EnableScheduling

public class CronJob {
	private Logger logger = LoggerFactory.getLogger(CronJob.class);
	
	@Scheduled(cron="0-59/2 * * * * ? ")
	public void m1(){
		logger.info("time:+++++++++++++++++++"+new Date());
	}
}

Cron表达式

语法

{秒数} {分钟} {小时} {日期} {月份} {星期} {年份(可为空)}

取值范围

字段	允许值	允许的特殊字符
秒	0-59	, - * /
分	0-59	, - * /
小时	0-23	, - * /
日期	1-31	, - * ? / L W C
月份	1-12 或者 JAN-DEC	, - * /
星期	1-7 或者 SUN-SAT	, - * ? / L C #
年（可为空）	留空, 1970-2099	, - * /

秒

允许值范围: 0~59 ,不允许为空值，若值不合法，调度器将抛出SchedulerException异常

“*” 代表每隔1秒钟触发

“,” 代表在指定的秒数触发，比如"0,15,45"代表0秒、15秒和45秒时触发任务

“-” 代表在指定的范围内触发，比如"25-45"代表从25秒开始触发到45秒结束触发，每隔1秒触发1次

“/” 代表触发步进(step)，"/“前面的值代表初始值(”“等同"0”)，后面的值代表偏移量，比如"0/20"或者"/20"代表从0秒钟开始，每隔20秒钟触发1次，即0秒触发1次，20秒触发1次，40秒触发1次；"5/20"代表5秒触发1次，25秒触发1次，45秒触发1次；"10-45/20"代表在[10,45]内步进20秒命中的时间点触发，即10秒触发1次，30秒触发1次

分钟

允许值范围: 0~59 ,不允许为空值，若值不合法，调度器将抛出SchedulerException异常

“*” 代表每隔1分钟触发

“,” 代表在指定的分钟触发，比如"10,20,40"代表10分钟、20分钟和40分钟时触发任务

“-” 代表在指定的范围内触发，比如"5-30"代表从5分钟开始触发到30分钟结束触 发，每隔1分钟触发

“/” 代表触发步进(step)，"/“前面的值代表初始值(”“等同"0”)，后面的值代表偏移量，比如"0/25"或者"/25"代表从0分钟开始，每隔25分钟触发1次，即0分钟触发1次，第25分钟触发1次，第50分钟触发1次；"5/25"代表5分钟触发1次，30分钟触发1次，55分钟触发1次；"10-45/20"代表在[10,45]内步进20分钟命中的时间点触发，即10分钟触发1次，30分钟触发1次

小时

允许值范围: 0~23 ,不允许为空值，若值不合法，调度器将抛出SchedulerException异常

“*” 代表每隔1小时触发

“,” 代表在指定的时间点触发，比如"10,20,23"代表10点钟、20点钟和23点触发任务

“-” 代表在指定的时间段内触发，比如"20-23"代表从20点开始触发到23点结束触发，每隔1小时触发

“/” 代表触发步进(step)，"/“前面的值代表初始值(”“等同"0”)，后面的值代表偏移量，比如"0/1"或者"/1"代表从0点开始触发，每隔1小时触发1次；"1/2"代表从1点开始触发，以后每隔2小时触发一次

日期

允许值范围: 1~12 (JAN-DEC),不允许为空值，若值不合法，调度器将抛出SchedulerException异常

“*” 代表每个月都触发

“,” 代表在指定的月份触发，比如"1,6,12"代表1月份、6月份和12月份触发任务

“-” 代表在指定的月份范围内触发，比如"1-6"代表从1月份开始触发到6月份结束触发，每隔1个月触发

“/” 代表触发步进(step)，"/“前面的值代表初始值(”“等同"1”)，后面的值代表偏移量，比如"1/2"或者"/2"代表从1月份开始触发，每隔2个月触发1次；"6/6"代表从6月份开始触发，以后每隔6个月触发一次；"1-6/12"表达式意味着每年1月份触发

星期

允许值范围: 1~7 (SUN-SAT),1代表星期天(一星期的第一天)，以此类推，7代表星期六(一星期的最后一天)，不允许为空值，若值不合法，调度器将抛出SchedulerException异常

“*” 代表每星期都触发；

“?” 与{日期}互斥，即意味着若明确指定{日期}触发，则表示{星期}无意义，以免引起冲突和混乱

“,” 代表在指定的星期约定触发，比如"1,3,5"代表星期天、星期二和星期四触发

“-” 代表在指定的星期范围内触发，比如"2-4"代表从星期一开始触发到星期三结束触发，每隔1天触发

“/” 代表触发步进(step)，"/“前面的值代表初始值(”“等同"1”)，后面的值代表偏移量，比如"1/3"或者"/3"代表从星期天开始触发，每隔3天触发1次；"1-5/2"表达式意味着在[1,5]范围内，每隔2天触发，即星期天、星期二、星期四触发

“L” 如果{星期}占位符如果是"L"，即意味着星期的的最后一天触发，即星期六触发，L= 7或者 L = SAT，因此，"5L"意味着一个月的最后一个星期四触发

“#” 用来指定具体的周数，"#“前面代表星期，”#"后面代表本月第几周，比如"2#2"表示本月第二周的星期一，"5#3"表示本月第三周的星期四，因此，“5L"这种形式只不过是”#"的特殊形式而已

年份

允许值范围: 1970~2099 ,允许为空，若值不合法，调度器将抛出SchedulerException异常

"*"代表每年都触发

","代表在指定的年份才触发，比如"2011,2012,2013"代表2011年、2012年和2013年触发任务

"-"代表在指定的年份范围内触发，比如"2011-2020"代表从2011年开始触发到2020年结束触发，每隔1年触发

"/“代表触发步进(step)，”/“前面的值代表初始值(”“等同"1970”)，后面的值代表偏移量，比如"2011/2"或者"/2"代表从2011年开始触发，每隔2年触发1次

注意：除了{日期}和{星期}可以使用"?"来实现互斥，表达无意义的信息之外，其他占位符都要具有具体的时间含义，且依赖关系为：年->月->日期(星期)->小时->分钟->秒数

特殊字符

“*”

“”字符被用来指定所有的值。如：""在分钟的字段域里表示“每分钟”。

“?”

“?”字符只在日期域和星期域中使用。它被用来指定“非明确的值”。当你需要通过在这两个域中的一个来指定一些东西的时候，它是有用的。看下面的例子你就会明白。 月份中的日期和星期中的日期这两个元素时互斥的一起应该通过设置一个问号来表明不想设置那个字段。

“-”

“-”字符被用来指定一个范围。如：“10-12”在小时域意味着“10点、11点、12点”。

“,”

“,”字符被用来指定另外的值。如：“MON,WED,FRI”在星期域里表示”星期一、星期三、星期五”。

“/”

“/”字符用于指定增量。如：“0/15”在秒域意思是每分钟的0，15，30和45秒。“5/15”在分钟域表示每小时的5，20，35和50。符号“”在“/”前面（如：/10）等价于0在“/”前面（如：0/10）。记住一条本质：表达式的每个数值域都是一个有最大值和最小值的集合，如：秒域和分钟域的集合是0-59，日期域是1-31，月份域是1-12。字符“/”可以帮助你在每个字符域中取相应的数值。如：“7/6”在月份域的时候只有当7月的时候才会触发，并不是表示每个6月。

“L”

L是‘last’的省略写法可以表示day-of-month和day-of-week域，但在两个字段中的意思不同，例如day-of-month域中表示一个月的最后一天。如果在day-of-week域表示‘7’或者‘SAT’，如果在day-of-week域中前面加上数字，它表示一个月的最后几天，例如‘6L’就表示一个月的最后一个星期五。

“W”

字符“W”只允许日期域出现。这个字符用于指定日期的最近工作日。例如：如果你在日期域中写 “15W”，表示：这个月15号最近的工作日。所以，如果15号是周六，则任务会在14号触发。如果15好是周日，则任务会在周一也就是16号触发。如果是在日期域填写“1W”即使1号是周六，那么任务也只会在下周一，也就是3号触发，“W”字符指定的最近工作日是不能够跨月份的。字符“W”只能配合一个单独的数值使用，不能够是一个数字段，如：1-15W是错误的。

“L”和“W”可以在日期域中联合使用，LW表示这个月最后一周的工作日。

“#”

字符“#”只允许在星期域中出现。这个字符用于指定本月的某某天。例如：“6#3”表示本月第三周的星期五（6表示星期五，3表示第三周）。“2#1”表示本月第一周的星期一。“4#5”表示第五周的星期三。

“C”

字符“C”允许在日期域和星期域出现。这个字符依靠一个指定的“日历”。也就是说这个表达式的值依赖于相关的“日历”的计算结果，如果没有“日历”关联，则等价于所有包含的“日历”。如：日期域是“5C”表示关联“日历”中第一天，或者这个月开始的第一天的后5天。星期域是“1C”表示关联“日历”中第一天，或者星期的第一天的后1天，也就是周日的后一天（周一）。

表达式举例

“0 0 12 * * ?” 每天中午12点触发

“0 15 10 ? * *” 每天上午10:15触发

“0 15 10 * * ?” 每天上午10:15触发

“0 15 10 * * ? *” 每天上午10:15触发

“0 15 10 * * ? 2005” 2005年的每天上午10:15触发

“0 * 14 * * ?” 在每天下午2点到下午2:59期间的每1分钟触发

“0 0/5 14 * * ?” 在每天下午2点到下午2:55期间的每5分钟触发

“0 0/5 14,18 * * ?” 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发

“0 0-5 14 * * ?” 在每天下午2点到下午2:05期间的每1分钟触发

“0 10,44 14 ? 3 WED” 每年三月的星期三的下午2:10和2: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 2002-2005” 2002年至2005年的每月的最后一个星期五上午10:15触发

“0 15 10 ? * 6#3” 每月的第三个星期五上午10:15触发

网站

http://cron.qqe2.com/