定时任务
近期开发需要用到定时任务,写篇学习博客记录一下。比如每个月汇总上个月数据的报表或者定期的日志分析都会用到定时任务,我们可以直接使用SpringBoot 框架里Spring Framework 自带的定时任务。
相关的注解
- @EnableScheduling :开启定时任务。
- @Scheduled : 在需要定时的方法类上标注。
1.开启定时任务
@SpringBootApplication
@EnableSwagger2
@EnableScheduling //开启定时任务
public class ComplainApplication {
// 启动类
}
2. 在需要定时的方法类上标注
可以有多个需要定时的任务,有几个定时任务就要有几个被标注的方法。
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Service;
@Service // 不可省略
public class ScheduledService {
// corn表达式中六个参数:秒,分,时,日,月,周几
@Scheduled(cron = "59 59 23 0 0 5") // cron 表达式,每周五 23:59:59 执行
public void hello(){
System.out.println("我是定时任务~");
}
}
corn表达式
Cron表达式是一个字符串,字符串以5或6个空格隔开,分为6或7个域,每一个域代表一个含义,Cron有如下两种语法格式:
(1) Seconds Minutes Hours DayofMonth Month DayofWeek Year(七个,多一个年份)
(2)Seconds Minutes Hours DayofMonth Month DayofWeek (六个)
特殊字符 | 代表意义 |
---|---|
, | 枚举 |
- | 区间 |
* | 任意 |
/ | 步长 |
? | 也是任意(注意日和星期冲突匹配) |
L | 最后 |
W | 工作日 |
C | 和calendar联系后计算出的值 |
# | 星期,4#2,第2个星期四 |
注意事项:
每一个域都使用数字,但还可以出现如下特殊字符,它们的含义是:
(1)* :表示匹配该域的任意值。假如在Minutes域使用*, 即表示每分钟都会触发事件。
(2)?:只能用在DayofMonth和DayofWeek两个域。它也匹配域的任意值,但实际不会。因为DayofMonth和DayofWeek会相互影响。例如想在每月的20日触发调度,不管20日到底是星期几,则只能使用如下写法: 13 13 15 20 * ?, 其中最后一位只能用?,而不能使用*,如果使用*表示不管星期几都会触发,实际上并不是这样。
(3)-:表示范围。例如在Minutes域使用5-20,表示从5分到20分钟每分钟触发一次
(4)/:表示起始时间开始触发,然后每隔固定时间触发一次。
(5),:表示列出枚举值。例如:在Minutes域使用5,20,则意味着在5和20分每分钟触发一次。
(6)L:表示最后,只能出现在DayofWeek和DayofMonth域。如果在DayofWeek域使用5L,意味着在最后的一个星期四触发。
(7)W:表示有效工作日(周一到周五),只能出现在DayofMonth域,系统将在离指定日期的最近的有效工作日触发事件。例如:在 DayofMonth使用5W,如果5日是星期六,则将在最近的工作日:星期五,即4日触发。如果5日是星期天,则在6日(周一)触发;如果5日在星期一到星期五中的一天,则就在5日触发。另外一点,W的最近寻找不会跨过月份 。
(8)LW:这两个字符可以连用,表示在某个月最后一个工作日,即最后一个星期五。
(9)#:用于确定每个月第几个星期几,只能出现在DayofMonth域。例如在4#2,表示某月的第二个星期三。