Spring Quartz 定时任务
前言
Quartz 是一个完全由 Java 编写的开源的任务调度框架,按照规定的计划完成任务,如每周三的凌晨一点进行数据备份,或者按时间隔触发一次任务调度,如每十分钟同步一些状态信息,可以通过配置和注解两种方式来使用。
一、Cron 表达式
使用 Quartz 前必须要了解 Cron 周期计划。Cron 表达式的参数共有七位,第七位表示年份,可以忽略;第四位表示一个月的某一天,第六位表示一个周的某一天,这两个只会使用一个,另外一个使用符号 ? 占位,否则会有冲突。
(1)Cron 参数介绍
位数 | 说明(取值范围) |
---|---|
第一位 | 秒钟(0-59) |
第二位 | 分钟(0-59) |
第三位 | 小时(0-23) |
第四位 | 某一月的第某天(1-31) |
第五位 | 月份(1-12) |
第六位 | 某一周的第某天,可以使用数字1-7,也可以使用单词缩写 |
第七位 | 年份(1970-2099) |
注意:第六位参数需要注意,在西方一周的第一天是周日,所以 1=周日,7=周六; 扩展:一周的单词缩写:SUN,MON,TUE,WED,THU,FRI,SAT。
(2)Cron 表达式的占位符
占位符 | 说明 |
---|---|
* | 表示任意时刻 |
? | 一般用于第四位参数或第六位参数的占位 |
- | 表示一个区间范围 |
/ | 表示间隔多久 |
, | 表示枚举 |
L | 一般用于第四位参数或第六位参数,最后一月或最后一周 |
W | 表示有效的工作日(1-5) |
# | 表示第几个星期几 |
LW | 表示某月的最后一个工作日 |
(3)Cron 表达式的示例
cron | 说明 |
---|---|
0 0 3 * * ? | 每月每天凌晨3点触发 |
0 0 3 1 * ? | 每月1日凌晨3点触发 |
0 0 12 ? * WEN | 星期三中午12点触发, WEN也可以使用数字3表示 |
0 0 3 ?* MON-FRI | 周一至周五凌晨3点触发,MON-FRI 也可以使用1-5来表示 |
0 0/5 8 * * ? | 每天7点至7:55分每隔5分钟触发一次 |
5/15 0 * * * ? | 从第 5 秒开始,每 15 秒一次 |
0 10,20 8 * * ? | 每天的8点10分,8点20分触发 |
0 0 1-3 * * ? | 每天的1点至三点每小时触发一次 |
0 0 8 L * ? | 每月最后一天的8点触发 |
0 10 12 ? * 6#3 | 每月的第三个星期五的12:10分触发 |
0 10 12 ? * 6L 2022 | 表示2022年每月最后一个星期五10:22分触发 |
二、使用Quartz(注解的方式)
(1)引入依赖
代码语言:javascript复制<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
只听到从架构师办公室传来架构君的声音: 余亦谢时去,西山鸾鹤群。有谁来对上联或下联?
(2)任务调度的类
使用 @Scheduled 注解,配置它的 cron 属性。
代码语言:javascript复制此代码由Java架构师必看网-架构君整理
/** * @Author bls * @Description <p> 一段任务调度的代码 </p> * @Date 2020/12/02 09:58 */
@Service
public class QuartzJob {
@Scheduled(cron = "30 * * * * ?")
public void cronScheduled(){
System.out.println("在每时每刻的第 30 秒执行这次输出。");
}
}
(3)开启任务调度
添加 @EnableScheduling 注解,表示开启任务调度。SpringBoot 项目建议在启动类上添加,MVC 项目则在当前类上添加即可。
三、其他调度属性
(1)fixedDelay
每个3000毫秒执行一次,无论上次是否会执行成功,下次都会执行
代码语言:javascript复制 @Scheduled(fixedRate = 3000)
public void fixedRateScheduled(){
System.out.println("the night nice");
}
(2)fixedRate
每个3000毫秒执行一次,无论上次是否会执行成功,下次都会执行
代码语言:javascript复制此代码由Java架构师必看网-架构君整理
@Scheduled(fixedRate = 3000)
public void fixedRateScheduled(){
System.out.println("the night nice");
}
(3)initialDelay
initialDelay 表示初始化延迟1000毫秒后,执行具体的任务调度,之后按照fixedRate进行任务调度
代码语言:javascript复制 @Scheduled(initialDelay = 1000,fixedRate = 3000)
public void initialDelayStringScheduled(){
System.out.println("the night nice");
}
三、使用Quartz(XML配置的方式)
(1)任务调度的类
代码语言:javascript复制public class QuartzJob{
public void work(){
System.out.println("Quartz的任务调度!!!");
}
}
(2)Spring配置文件
代码语言:javascript复制<beans>
<!-- 要调用的工作类 -->
<bean id="quartzJob" class="com.quartz.QuartzJob"></bean>
<!-- 定义调用对象和调用对象的方法 -->
<bean id="jobtask" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
<!-- 调用的类 -->
<property name="targetObject">
<ref bean="quartzJob"/>
</property>
<!-- 调用类中的方法 -->
<property name="targetMethod">
<value>work</value>
</property>
</bean>
<!-- 定义触发时间 -->
<bean id="doTime" class="org.springframework.scheduling.quartz.CronTriggerBean">
<property name="jobDetail">
<ref bean="jobtask"/>
</property>
<!-- cron表达式 -->
<property name="cronExpression">
<value>0 0 8 L * ?</value>
</property>
</bean>
<!-- 总管理类 如果将lazy-init='false'那么容器启动就会执行调度程序 -->
<bean id="startQuertz" lazy-init="false" autowire="no" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
<property name="triggers">
<list>
<ref bean="doTime"/>
</list>
</property>
</bean>
</beans>
当 Spring 容器被加载的时候,任务就会开始进行调度。
四、 其他
(1)参考资料
https://www.ibm.com/developerworks/cn/java/j-quartz/index.html
(2)工具
也可以使用 cron 的表达式生成器,百度即可,自己使用的: https://qqe2.com/cron