一、java最基本方式使用
使用java.util.Timer类
1 | public class TimedTask { |
使用java.util.concurrent.ScheduledExecutorService
1 | public class TimedTask { |
这样不好,建议创建使用线程池
推荐使用java.util.concurrent.ScheduledThreadPoolExecutor结合org.apache.commons.lang3.concurrent.BasicThreadFactory
1 | public class TimedTask { |
使用java.lang.Thread方式
1 | public class TimedTask { |
这种方式不优雅
二、Quartz框架实现
Quartz是一个强大任务调度框架,一个简单示例:
1 | <dependencies> |
任务逻辑
1 | /** |
任务调度
1 | /** |
cron表达式编写规则
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表达式对特殊字符的大小写不敏感,对代表星期的缩写英文大小写也不敏感。
官方示例:
表示式 说明
0 0 12 * * ? 每天12点运行
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对任务调度的领域问题进行了高度的抽象,提出了调度器、任务和触发器这3个核心的概念,主要类和接口解释:
Job:是一个接口,只有一个方法void execute(JobExecutionContext context),开发者实现该接口定义运行任务,JobExecutionContext类提供了调度上下文的各种信息。Job运行时的信息保存在JobDataMap实例中;
JobDetail:Quartz在每次执行Job时,都重新创建一个Job实例,所以它不直接接受一个Job的实例,它接收一个Job实现类,以便运行时通过newInstance()的反射机制实例化Job。因此需要通过一个类来描述Job的实现类及其它相关的静态信息,如Job名字、描述、关联监听器等信息,JobDetail承担了这一角色。
Trigger:是一个类,描述触发Job执行的时间触发规则。主要有SimpleTrigger和CronTrigger这两个子类。当仅需触发一次或者以固定时间间隔周期执行,SimpleTrigger是最适合的选择;而CronTrigger则可以通过Cron表达式定义出各种复杂时间规则的调度方案;
Calendar:org.quartz.Calendar和java.util.Calendar不同,它是一些日历特定时间点的集合,一个Trigger可以和多个Calendar关联,以便排除或包含某些时间点。
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,保存着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 https://www.cnblogs.com/zhanghaoliang/p/7886110.html
三、Spring方式实现
1、使用注解
在spring配置中加入task的命名空间:
1 | xmlns:task="http://www.springframework.org/schema/task" |
然后使用task配置扫描注解
1
2
3 <!-- 定时任务 -->
<task:annotation-driven scheduler="qbScheduler" mode="proxy"/>
<task:scheduler id="qbScheduler" />
此时就可以直接使用@Scheduled(cron = “时间格式串”),应用该注解就可以实现定时的功能。
1 | "0/5 * * * * ?") //每隔5秒执行一次定时任务 (cron = |
2、不使用注解实现定时任务
1 | xmlns:task="http://www.springframework.org/schema/task" |
Java:
1 |
|
3、spring boot上使用
开启定时任务功能
1 |
|
运行项目就会有结果
上面是单线程执行,如果需要并发多线程执行,这样做:
增加配置
1 | /** |
四、Spring Boot集成Quartz
这里直接介绍spring boot整合Quartz
1 |
|
创建两个任务:
1 | public class TestTask1 extends QuartzJobBean{ |
配置定时任务执行:
1 | /** |
入口:
1 |
|
运行没问题
2019-05-28 19:24:31.254 INFO 4368 --- [ main] org.quartz.core.QuartzScheduler : Scheduler quartzScheduler_$_NON_CLUSTERED started.
TestQuartz02----2019-05-28 19:24:31
TestQuartz01----2019-05-28 19:24:31
2019-05-28 19:24:31.270 INFO 4368 --- [ main] com.hu.Application : Started Application in 0.656 seconds (JVM running for 1.008)
TestQuartz02----2019-05-28 19:24:32
TestQuartz02----2019-05-28 19:24:33
TestQuartz02----2019-05-28 19:24:34
TestQuartz02----2019-05-28 19:24:35
TestQuartz02----2019-05-28 19:24:36
TestQuartz01----2019-05-28 19:24:36
TestQuartz02----2019-05-28 19:24:37
TestQuartz02----2019-05-28 19:24:38
具体见项目spring-boot-starter-quartz
https://github.com/huingsn/spring-boot-sample-demo/tree/master/quartz
参考https://www.jianshu.com/p/d52d62fb2ac6
在新版本的SpringBoot2.0发布后,SpringBoot2.0版本集成了Quartz2.3.0官网最新版本,整合到spring-boot-starter-quartz。针对Quartz新版本进行了 AutoConfiguration自动化配置,省去了很多繁琐的配置。
之前调度中心简单例子中,使用spring集成Quartz,这个示例把之前改为使用spring-boot-starter-quartz的项目。
见:spring-boot-starter-quartz
在此基础上修改:
1、pom.xml配置文件,SpringBoot为我们提供了对应的依赖,我们将之前的quartz相关依赖删除,替换为spring-boot-starter-quartz。
2、删除QuartzConfiguration配置类
之前使用 QuartzConfiguration配置类来完成了 Quartz需要的一系列配置,如: JobFactory、 SchedulerFactoryBean等,在我们添加 spring-boot-starter-quartz依赖后就不需要主动声明工厂类,因为 spring-boot-starter-quartz已经为我们自动化配置好了。
自动化配置源码
查看spring-boot-autoconfigure-2.0.0.RELEASE.jar,找到org.springframework.boot.autoconfigure.quartz,该目录就是SpringBoot提供的Quartz自动化配置源码实现,在该目录下有如下所示几个类:
AutowireCapableBeanJobFactory
该类替代了我们之前在QuartzConfiguration配置类的AutowiringSpringBeanJobFactory内部类实现,主要作用是我们自定义的QuartzJobBean子类被Spring IOC进行托管,可以在定时任务类内使用注入任意被Spring IOC托管的类。
JobStoreType
该类是一个枚举类型,定义了对应application.yml、application.properties文件内spring.quartz.job-store-type配置,其目的是配置quartz任务的数据存储方式,分别为:MEMORY(内存方式:默认)、JDBC(数据库方式)。
QuartzAutoConfiguration
该类是自动配置的主类,内部配置了SchedulerFactoryBean以及JdbcStoreTypeConfiguration,使用QuartzProperties作为属性自动化配置条件。
QuartzDataSourceInitializer
该类主要用于数据源初始化后的一些操作,根据不同平台类型的数据库进行选择不同的数据库脚本。
QuartzProperties
该类对应了spring.quartz在application.yml、application.properties文件内开头的相关配置。
SchedulerFactoryBeanCustomizer
这是一个接口,我们实现该接口后并且将实现类使用Spring IOC托管,可以完成SchedulerFactoryBean的个性化设置,这里的设置完全可以对SchedulerFactoryBean做出全部的设置变更。
3、在springboot配置文件中增加Quartz的配置信息,移除之前的Quartz配置文件。
其实就是把之前 quartz.properties配置文件内的所有配置转换成 YAML风格,对应的添加在该配置下即可,在 QuartzAutoConfiguration类内,会自动调用 SchedulerFactoryBean的 setQuartzProperties方法,把 spring.quartz.properties内的所有配置进行设置。
完成,启动测试和之前一样。