SpringBoot集成Quartz
原文地址: https://www.cnblogs.com/wadmwz/p/10315481.html
SpringBoot集成Quartz
定时任务Quartz : 就是在指定的时间执行一次或者循环执行,在项目的开发中有时候会需要的, 还是很有用的.
SpringBoot内置的定时
-
添加依赖
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency>
-
启动类上添加注解
@SpringBootApplication @EnableScheduling public class SpringbootQuartzApplication { }
-
创建定时执行的任务类(两种方式)
方式一:
@Component public class SchedulerTask { private int count = 0; /** * @Author Smith * @Description 设置没6秒执行一次 * @Date 14:23 2019/1/24 * @Param * @return void **/ @Scheduled(cron = "*/6 * * * * ?") private void process(){ System.out.println("this is scheduler task running " + (count++)); } }
方式二:
@Component public class SchedulerTask2 { private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss"); /** * @Author Smith * @Description 设置没6秒执行一次 * @Date 14:22 2019/1/24 * @Param * @return void **/ @Scheduled(fixedRate = 6000) private void process(){ System.out.println("now time is " + dateFormat.format(new Date())); } }
@Scheduled 参数可以接受两种定时的设置,一种是我们常用的 cron="*/6 * * * * ?",一种是 fixedRate = 6000,两种都可表示固定周期执行定时任务。
fixedRate说明
-
@Scheduled(fixedRate = 6000):上一次开始执行时间点之后 6 秒再执行。 @Scheduled(fixedDelay = 6000):上一次执行完毕时间点之后 6 秒再执行。 @Scheduled(initialDelay=1000, fixedRate=6000):第一次延迟 1 秒后执行,之后按 fixedRate 的规则每 6 秒执行一次。
cron说明
cron一定有七位数,最后一位是年,SpringBoot定时方案只需要设置六位即可:
-
第一位, 表示秒, 取值是0 ~ 59
-
第二位, 表示分. 取值是0 ~ 59
-
第三位, 表示小时, 取值是0 ~ 23
-
第四位, 表示天/日, 取值是0 ~ 31
-
第五位, 表示月份, 取值是1 ~ 12
-
第六位, 表示星期, 取值是1 ~ 7, 星期一,星期二..., 还有 1 表示星期日
-
第七位, 年份, 可以留空, 取值是1970 ~ 2099
cron中,还有一些特殊的符号,含义如下:
-
(*) 星号,可以理解为每的意思,每秒、每分、每天、每月、每年...。
-
(?)问号,问号只能出现在日期和星期这两个位置,表示这个位置的值不确定,每天 3 点执行,因此第六位星期的位置,是不需要关注的,就是不确定的值;同时,日期和星期是两个相互排斥的元素,通过问号来表明不指定值,比如 1 月 10 日是星期一,如果在星期的位置另指定星期二,就前后冲突矛盾了。
-
(-)减号,表达一个范围,如在小时字段中使用“10 - 12”,则表示从 10 到 12 点,即 10、11、12。
-
(,)逗号,表达一个列表值,如在星期字段中使用“1,2,4”,则表示星期一、星期二、星期四。
-
(/)斜杠,如 x/y,x 是开始值,y 是步长,比如在第一位(秒),0/15 就是从 0 秒开始,每隔 15 秒执行一次,最后就是 0、15、30、45、60,另 */y,等同于 0/y。
举几个例子熟悉一下:
-
0 0 3 * * ? :每天 3 点执行;
-
0 5 3 * * ?:每天 3 点 5 分执行;
-
0 5 3 ? * *:每天 3 点 5 分执行,与上面作用相同;
-
0 5/10 3 * * ?:每天 3 点的 5 分、15 分、25 分、35 分、45 分、55分这几个时间点执行;
-
0 10 3 ? * 1:每周星期天,3 点 10 分执行,注,1 表示星期天;
-
0 10 3 ? * 1#3:每个月的第三个星期,星期天执行,# 号只能出现在星期的位置。
zone - 时区设置
我们可以通过 TimeZone
类 的getDefault()
查看当前系统所在的时区,如下:
System.out.println(TimeZone.getDefault());
// 打印结果为:sun.util.calendar.ZoneInfo[id="Asia/Shanghai",offset=28800000,dstSavings=0,useDaylight=false,transitions=19,lastRule=null]
其中的 id值为我们可以在 @Scheduled 注解中使用,我们可以通过 ZoneId 类的 getAvailableZoneIds() 方法获取所有的时区值:
System.out.println(ZoneId.getAvailableZoneIds()); // 值有很多,可自己打印查看
fixedDelay && fixedDelayString - 固定间隔任务
下一次的任务执行时间,是从方法最后一次任务执行结束时间开始计算。并以此规则开始周期性的执行任务。fixedDelayString是使用String类型参数
比如 a 方法 设置 fixedDelay = 1000 * 10
,在第 0 秒开始执行,方法本身执行时间为 12 秒,那么下一次的执行时间为第22 秒。
fixedRate && fixedRateString- 固定频率任务
按照指定频率执行任务,并以此规则开始周期性的执行调度。fixedRateString使用String类型参数
当然一般情况下我们定时任务的cron
等值是放在properties文件中,我们可以使用“${}”来获取
spring中有一套默认的配置,使得即使在我们没有指定调度器的情况下也可以正常工作起来;默认的调度配置使用单线程调度,所有的任务都必须等待当前任务执行完成才可以继续执行。如果只有一个调度任务,且调度任务的时间比调度时间短,那么问题不大;如果有几个调度任务一起执行,那么单线程的调度任务就不满足我们的需求,因此我们要自定义调度线程池来保证我们需求,如下:
@Configuration public class SchedulePoolConfiguration { @Bean public TaskScheduler taskScheduler() { ThreadPoolTaskScheduler schedulerPool = new ThreadPoolTaskScheduler(); // 设置调度任务线程池大小 schedulerPool.setPoolSize(3); return schedulerPool; } }
Quartz
Quartz有四个核心概念:
-
Job:是一个接口,只定义一个方法 execute(JobExecutionContext context),在实现接口的 execute 方法中编写所需要定时执行的 Job(任务),JobExecutionContext 类提供了调度应用的一些信息;Job 运行时的信息保存在 JobDataMap 实例中。
-
JobDetail:Quartz 每次调度 Job 时,都重新创建一个 Job 实例,因此它不接受一个 Job 的实例,相反它接收一个 Job 实现类(JobDetail,描述 Job 的实现类及其他相关的静态信息,如 Job 名字、描述、关联监听器等信息),以便运行时通过 newInstance() 的反射机制实例化 Job。
-
rigger:是一个类,描述触发 Job 执行的时间触发规则,主要有 SimpleTrigger 和 CronTrigger 这两个子类。当且仅当需调度一次或者以固定时间间隔周期执行调度,SimpleTrigger 是最适合的选择;而 CronTrigger 则可以通过 Cron 表达式定义出各种复杂时间规则的调度方案:如工作日周一到周五的 15:00 ~ 16:00 执行调度等。
-
Scheduler:调度器就相当于一个容器,装载着任务和触发器,该类是一个接口,代表一个 Quartz 的独立运行容器,Trigger 和 JobDetail 可以注册到 Scheduler 中,两者在 Scheduler 中拥有各自的组及名称,组及名称是 Scheduler 查找定位容器中某一对象的依据,Trigger 的组及名称必须唯一,JobDetail 的组和名称也必须唯一(但可以和 Trigger 的组和名称相同,因为它们是不同类型的)。Scheduler 定义了多个接口方法,允许外部通过组及名称访问和控制容器中 Trigger 和 JobDetail。
Job 为作业的接口,为任务调度的对象;JobDetail 用来描述 Job 的实现类及其他相关的静态信息;Trigger 做为作业的定时管理工具,一个 Trigger 只能对应一个作业实例,而一个作业实例可对应多个触发器;Scheduler 做为定时任务容器,是 Quartz 最上层的东西,它提携了所有触发器和作业,使它们协调工作,每个 Scheduler 都存有 JobDetail 和 Trigger 的注册,一个 Scheduler 中可以注册多个 JobDetail 和多个 Trigger。
整合
-
引入依赖:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-quartz</artifactId> </dependency>
定时输出HelloWorld(使用Scheduler 启动)
首先定义一个Job
public class SampleJob extends QuartzJobBean { private String name; public void setName(String name) { this.name = name; } @Override protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException { System.out.println("Quartz ----> Hello, " + this.name); } }
构建JobDetail:
@Configuration public class SampleScheduler { @Bean public JobDetail sampleJobDetail() { // 链式编程,可以携带多个参数,在Job类中声明属性 + setter方法 return JobBuilder.newJob(SampleJob.class).withIdentity("sampleJob") .usingJobData("name","World").storeDurably().build(); } @Bean public Trigger sampleJobTrigger(){ // 每隔两秒执行一次 SimpleScheduleBuilder scheduleBuilder = SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(2).repeatForever(); return TriggerBuilder.newTrigger().forJob(sampleJobDetail()).withIdentity("sampleTrigger") .withSchedule(scheduleBuilder).build(); } } JobBuilder 无构造函数,只能通过 JobBuilder 的静态方法 newJob(Class jobClass)生成 JobBuilder 实例。 withIdentity 方法可以传入两个参数 withIdentity(String name,String group) 来定义 TriggerKey,也可以不设置,像上文示例中会自动生成一个独一无二的 TriggerKey 用来区分不同的 Trigger。
CronSchedule方式
CronSchedule可以设置更灵活的方式,定时设置与SpringBoot自带的表达式相同.
同理,先定义两个个Job,与ScheduledJob相同,不过实现Job接口,如下:
第一个job:
public class ScheduledJob implements Job { private String name; public void setName(String name) { this.name = name; } @Override public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException { SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss"); System.out.println("CRON ----> schedule job1 is running ... + " + name + " ----> " + dateFormat.format(new Date())); } }
第二个Job
public class ScheduledJob2 implements Job { private String name; public void setName(String name) { this.name = name; } @Override public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException { SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss"); System.out.println("CRON ----> schedule job2 is running ... + " + name + " ----> " + dateFormat.format(new Date())); } }
构建Schedule来执行任务:
@Component public class CronSchedulerJob { @Autowired private SchedulerFactoryBean schedulerFactoryBean; private void scheduleJob1(Scheduler scheduler) throws SchedulerException { JobDetail jobDetail = JobBuilder.newJob(ScheduledJob.class) .withIdentity("job1", "group1").build(); // 6的倍数秒执行 也就是 6 12 18 24 30 36 42 .... CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("0/6 * * * * ?"); CronTrigger cronTrigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1") .usingJobData("name","王智1").withSchedule(scheduleBuilder).build(); scheduler.scheduleJob(jobDetail,cronTrigger); } private void scheduleJob2(Scheduler scheduler) throws SchedulerException{ JobDetail jobDetail = JobBuilder.newJob(ScheduledJob2.class) .withIdentity("job2", "group2").build(); // 12秒的倍数执行 12 24 36 48 60 CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("0/12 * * * * ?"); CronTrigger cronTrigger = TriggerBuilder.newTrigger().withIdentity("trigger2", "group2") .usingJobData("name","王智2").withSchedule(scheduleBuilder).build(); scheduler.scheduleJob(jobDetail,cronTrigger); } /** * @Author Smith * @Description 同时启动两个定时任务 * @Date 16:31 2019/1/24 * @Param * @return void **/ public void scheduleJobs() throws SchedulerException { Scheduler scheduler = schedulerFactoryBean.getScheduler(); scheduleJob1(scheduler); scheduleJob2(scheduler); } }
触发定时任务有两种方式:
第一种是项目启动时执行:
@Component public class MyStartupRunner implements CommandLineRunner { @Autowired public CronSchedulerJob scheduleJobs; @Override public void run(String... args) throws Exception { scheduleJobs.scheduleJobs(); System.out.println(">>>>>>>>>>>>>>>定时任务开始执行<<<<<<<<<<<<<"); } }
第二种是定时执行:
@Configuration @EnableScheduling @Component public class SchedulerListener { @Autowired public CronSchedulerJob scheduleJobs; @Scheduled(cron="0 47 16 24 1 ?") public void schedule() throws SchedulerException { scheduleJobs.scheduleJobs(); System.out.println(">>>>>>>>>>>>>>>定时任务开始执行<<<<<<<<<<<<<"); } }