在平时开发中,需求中经常会出现一些定时周期任务,我们可以是用java定时线程ScheduledExecutorService或定时器Timer去实现,而在SpringBoot中,定时任务十分简单,只需要新建一个定时任务类,使用@EnableScheduling开启定时任务,并在对应方法上添加注解@Scheduled即可,其实它的底层也是通过定时线springframework.scheduling.concurrent.ThreadPoolTaskScheduler去实现的
一、@Scheduled注解参数
1、corn
该参数接收一个cron表达式,cron表达式是一个字符串,字符串以5或6个空格隔开,分开共6或7个域,每一个域代表一个含义。用来表示任务执行的时机及周期
注:[年]不是必须的域,可以省略[年],则一共6个域
语法
[秒] [分] [小时] [日] [月] [周] [年]
序号 | 说明 | 是否必填 | 允许填写的值 | 允许的通配符 |
1 | 秒 | 是 | 0-59 | , - * / |
2 | 分 | 是 | 0-59 | , - * / |
3 | 时 | 是 | 0-23 | , - * / |
4 | 日 | 是 | 1-31 | , - * ? / L W |
5 | 月 | 是 | 1-12 或 JAN-DEC | , - * / |
6 | 周 | 是 | 1-7 或 SUN-SAT | , - * ? / L # |
7 | 年 | 是 | 1970-2099 | , - * / |
通配符
通配符 | 描述 | 示例 |
* | 表示所有值 | 例如:在分的字段上设置 *,表示每一分钟都会触发。 |
? | 表示不指定值 | 使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作,但不关心是周几,所以需要周位置的那个字段设置为”?”, 具体设置为 0 0 0 10 * ? |
- | 表示区间 | 例如:在小时上设置 “10-12”,表示 10,11,12点都会触发。 |
, | 表示指定多个值 | 例如:在周字段上设置 “MON,WED,FRI” 表示周一,周三和周五触发。 |
/ | 用于递增触发 | 如在秒上面设置”5/15” 表示从5秒开始,每增15秒触发(5,20,35,50)。 在日字段上设置’1/3’所示每月1号开始,每隔三天触发一次 |
L | 表示最后的意思 | 在日字段设置上,表示当月的最后一天(依据当前月份,如果是二月还会依据是否是润年[leap]), 在周字段上表示星期六,相当于”7”或”SAT”。如果在”L”前加上数字,则表示该数据的最后一个。例如在周字段上设置”6L”这样的格式,则表示“本月最后一个星期五” |
W | 表示离指定日期的最近那个工作日(周一至周五) | 例如在日字段上置”15W”,表示离每月15号最近的那个工作日触发。如果15号正好是周六,则找最近的周五(14号)触发, 如果15号是周未,则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五),则就在该天触发。如果指定格式为 “1W”,它则表示每月1号往后最近的工作日触发。如果1号正是周六,则将在3号下周一触发。(注,”W”前只能设置具体的数字,不允许区间”-“)。 |
# | 序号(表示每月的第几个周几), | 例如在周字段上设置”6#3”表示在每月的第三个周六.注意如果指定”#5”,正好第五周没有周六,则不会触发该配置(用在母亲节和父亲节再合适不过了) ;小提示:’L’和 ‘W’可以一组合使用。如果在日字段上设置”LW”,则表示在本月的最后一个工作日触发;周字段的设置,若使用英文字母是不区分大小写的,即MON与mon相同 |
示例
描述 | corn表达式 |
每隔10秒执行一次 | */10 * * * * ? |
每小时30,45分钟各执行一次 | 0 30,45 * * * ? |
每周周一的凌晨2点半执行一次 | 0 30 2 ? * MON |
每天的下午1点开始,每隔5min执行一次 | 0 0/5 13 * * ? |
2、zone
时区,cron表达式会基于该时区解析。缺省取服务器所在地的时区。比如我们一般使用的时区Asia/Shanghai
3、fixedDelay
上一次执行完毕之后多长时间再执行
@Scheduled(fixedRate = 5000) // 上次执行后再过5s执行
4、fixedDelayString
与 fixedDelay 意思相同,只是使用字符串的形式,唯一不同的是支持占位符
@Scheduled(fixedDelayString = "5000")
5、fixedRate
周期,多久执行一次
@Scheduled(fixedRate = 5000) // 每5s执行一次
6、fixedRateString
与 fixedRate意思相同,只是使用字符串的形式,支持占位符
7、initialDelay
第一次执行延迟时间
@Scheduled(initialDelay=1000, fixedRate=5000) //第一次延迟1秒后执行,之后按fixedRate的规则每5秒执行一次
8. initialDelayString
与initialDelay 意思相同,只是使用字符串的形式,支持占位符。
二、示例
注意在类上加上@Configuration或@Component注解
1、示例1
@Slf4j
@EnableScheduling // 开启定时任务
@Configuration // 此注解必须加,不加不会扫描到定时任务,也可使用@Component
public class ScheduleTask {
@Scheduled(initialDelay = 3000, fixedRateString = "5000") // 首次延迟3秒后执行,后边每5s一次
private void scheduleTask1() {
log.info("method = scheduleTask1, schedule time is {}", System.currentTimeMillis());
}
@Scheduled(fixedDelay = 5000) // 如果是服务启动就开始执行的任务,和fixedRate就意义相同了
private void scheduleTask2() {
log.info("method = scheduleTask2, schedule time is {}", System.currentTimeMillis());
}
@Scheduled(cron = "*/10 * * * * ?") // 每隔十秒执行一次
private void scheduleTask3() {
log.info("method = scheduleTask3, schedule time is {}", System.currentTimeMillis());
}
@Scheduled(cron = "0 50,55 * * * ?") // 每小时的50和55各执行一次
private void scheduleTask4() {
log.info("method = scheduleTask4, schedule time is {}", System.currentTimeMillis());
}
}
结果
从日志可以看出服务启动后scheduleTask2先执行的,3s后scheduleTask1开始执行,后续都是每5s执行一次,scheduleTask3是每10s执行一次
12:48:24.316 [scheduling-1] INFO com.spring.demo.service.impl.ScheduleTask - method = scheduleTask2, schedule time is 1594356504316
12:48:27.318 [scheduling-1] INFO com.spring.demo.service.impl.ScheduleTask - method = scheduleTask1, schedule time is 1594356507318
12:48:29.319 [scheduling-1] INFO com.spring.demo.service.impl.ScheduleTask - method = scheduleTask2, schedule time is 1594356509319
12:48:30.001 [scheduling-1] INFO com.spring.demo.service.impl.ScheduleTask - method = scheduleTask3, schedule time is 1594356510001
12:48:32.317 [scheduling-1] INFO com.spring.demo.service.impl.ScheduleTask - method = scheduleTask1, schedule time is 1594356512317
12:48:34.320 [scheduling-1] INFO com.spring.demo.service.impl.ScheduleTask - method = scheduleTask2, schedule time is 1594356514320
12:48:37.317 [scheduling-1] INFO com.spring.demo.service.impl.ScheduleTask - method = scheduleTask1, schedule time is 1594356517317
12:48:39.323 [scheduling-1] INFO com.spring.demo.service.impl.ScheduleTask - method = scheduleTask2, schedule time is 1594356519323
12:48:40.001 [scheduling-1] INFO com.spring.demo.service.impl.ScheduleTask - method = scheduleTask3, schedule time is 1594356520001
scheduleTask4 50和55分各执行了一次
12:50:00.001 [scheduling-1] INFO com.spring.demo.service.impl.ScheduleTask - method = scheduleTask4, schedule time is 1594356600001
12:55:00.002 [scheduling-1] INFO com.spring.demo.service.impl.ScheduleTask - method = scheduleTask4, schedule time is 1594356900002
2、示例2
从某个时刻开始任务,每间隔多长时间来触发一次
@Slf4j
@EnableScheduling
@Configuration
public class ScheduleTask {
private int count = 0;
@Scheduled(cron = "0 0/1 13 * * ?") // 每天下午1点开始,每1min执行一次
private void scheduleTask() {
log.info("execute 第{}次 scheduleTask", ++count);
}