写在前面: 从2018年底开始学习SpringBoot,也用SpringBoot写过一些项目。这里对学习Springboot的一些知识总结记录一下。如果你也在学习SpringBoot,可以关注我,一起学习,一起进步。
相关文章:
【Springboot系列】Springboot入门到项目实战
定时任务作用
定时任务顾名思义就是定时执行一个指定的方法。在项目中也很常用,比如:
- 定时向用户发送短信、邮件等。
- 定期统计数据。
- 天气预报系统定期更新数据。
SpringBoot中使用定时任务
1、创建定时器
使用SpringBoot项目中创建定时任务非常简单,只需几行代码便可完成。新建一个Timer类作为定期任务类。代码如下:
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import java.text.SimpleDateFormat;
import java.util.Date;
@Configuration //主要用于标记配置类,兼备Component的效果。
@EnableScheduling //开启定时任务
public class Timer {
//添加定时任务,每隔5秒执行一次
@Scheduled(cron = "0/5 * * * * ?")
private void configureTasks() {
SimpleDateFormat simpleDateFormat=new SimpleDateFormat("HH:mm:ss");
System.out.println("当前时间:"+simpleDateFormat.format(new Date()));
}
}
【注】 其中@Scheduled注解用于开启定时任务,@Scheduled注解的核心属性是cron,代表定时任务的触发计划表达式。这个表达式的格式为:
seconds秒,minutes分钟,hours小时,day天,month月,week星期,year年(可选添加)
@Scheduled(cron="seconds minutes hours day month week year")
2、运行效果
定时任务方法中输出了当前时间,用于显示定时任务效果。上面定时器方法设置的是每隔5秒执行一次,效果如下:
3、cron表达式
cron表达式中,每个位置的约束如下:
序号 | 说明 | 是否必填 | 值 | 通配符 |
---|---|---|---|---|
1 | 秒 | 是 | 0-59 | , - * / |
2 | 分 | 是 | 0-59 | , - * / |
3 | 小时 | 是 | 0-23 | , - * / |
4 | 日 | 是 | 1-31 | , - * / |
5 | 月 | 是 | 1-12 | , - * / L W |
6 | 星期 | 是 | 1-7/SUN-SAT | , - * / ? L # |
7 | 年 | 否 | 1970-2099 | , - * / |
- 星号( * ):可用在所有字段中,表示对应时间域的所有值,例如,* 在分钟字段时,表示“每分钟都会触发”。
- 问号(?):该字符只在日期和星期字段中使用,它通常指定为“无意义的值”,相当于占位符。
- 减号(-):表达一个范围,如在小时字段中使用“10-12”,则表示从10到12点,即10, 11, 12。
- 逗号(,):表达一个列表值,如在星期字段中使用“1, 2, 3”,则表示星期一,星期三和星期五。
- 斜杠(/):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~59) 例如0/5表示每5秒
- 分(0~59)
- 时(0~23)
- 日(0~31)的某天,需计算
- 月(0~11)
- 星期( 可填1-7[1表示星期天,7表示星期六] 或 SUN/MON/TUE/WED/THU/FRI/SAT)
常用的cron表达式含义
每隔5秒执行一次:0/5 * * * * ?
每隔1分钟执行一次:0 */1 * * * ?
每天24点执行一次:0 0 0 * * ?
每月1号凌晨1点执行一次:0 0 1 1 * ?
每月最后一天24点执行一次:0 0 24 L * ?
每周星期天凌晨1点实行一次:0 0 1 ? * L
在15分、35分、40分执行一次:0 15,35,40 * * * ?
每天的0点、10点、15点、20点都执行一次:0 0 0,10,15,20 * * ?
4、fixedRate
fixedRate 两次执行任务时间间隔是任务的开始点,也就是上一次执行开始多少毫秒后执行。
@Configuration //主要用于标记配置类,兼备Component的效果。
@EnableScheduling //开启定时任务
@EnableAsync //开启多线程
public class Timer {
@Scheduled(fixedRate = 3000)
@Async
public void configureTasks() {
SimpleDateFormat simpleDateFormat=new SimpleDateFormat("HH:mm:ss");
System.out.println("开始,时间是 : "+simpleDateFormat.format(new Date())+""+Thread.currentThread().getName());
try {
Thread.sleep(5000);
} catch (InterruptedException e) {
e.printStackTrace();
}
System.out.println("结束,时间是 : "+simpleDateFormat.format(new Date())+""+Thread.currentThread().getName());
}
}
【注】 fixedRate属性值的单位为毫秒,因为使用到了线程,所以需要在类上添加上@EnableAsync 注解,开启多线程。为了能看出效果,在控制台输出时开始执行后,线程休眠5秒后在执行。
运行效果(是在上一次执行开始后3秒执行,输出用线程的名字区分):
可以看出第一次执行,过了三秒,方法又开始执行了,此时第一次执行的方法还没有结束。
5、fixedDelay
fixedDelay 的间隔是前次任务的结束与下次任务的开始,也就是上一次执行完成后多少毫秒后执行。
@Configuration //主要用于标记配置类,兼备Component的效果。
@EnableScheduling //开启定时任务
@EnableAsync //开启多线程
public class Timer {
@Scheduled(fixedDelay = 3000)
@Async
public void configureTasks() {
SimpleDateFormat simpleDateFormat=new SimpleDateFormat("HH:mm:ss");
System.out.println("开始,时间是 : "+simpleDateFormat.format(new Date())+""+Thread.currentThread().getName());
try {
Thread.sleep(5000);
} catch (InterruptedException e) {
e.printStackTrace();
}
System.out.println("结束,时间是 : "+simpleDateFormat.format(new Date())+""+Thread.currentThread().getName());
}
}
【注】 fixedDelay属性值的单位为毫秒,在控制台输出时开始执行后,线程休眠5秒后在执行。
运行效果(是在上一次执行开始后3秒执行,输出用线程的名字区分):
可以看出第一次执行完成后又过了3秒后,才开始重新执行。
最后有什么不足之处,欢迎大家指出,期待与你的交流。