Spring-boot 定时任务

发表于

定时任务在开发中很常见，最近在清理数据库过期数据时用到定时任务，定时任务简单使用如下。

修改入口程序

启动类中使用注解@EnableScheduling

1
2
3
4
5
6
7
@SpringBootApplication
@EnableScheduling
public class MainApplication {
    public static void main(String[] args) {
        SpringApplication.run(MainApplication.class, args);
    }
}

新建定时任务类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@Component
public class MyTimer {
    private static TempTokenDao tempInfoDao = DbManager.create(TempTokenDao.class);
    @Bean
    public TaskScheduler taskScheduler() {
        return new ConcurrentTaskScheduler(); //single threaded by default
    }
    /**
     * 每天凌晨四点清理一次临时表
     */
    @Scheduled(cron = "0 0 4 * * ?")
    public void clearTempToken(){
        tempInfoDao.deleteAll();
    }
}

组件类加上@Component注解，在定时任务的方法上加上@Scheduled注解即可。

@Scheduled注解参数

以上采用是Cron表达式方式，@Scheduled的其他参数如下：

  • @Scheduled(fixedRate=3000)：上一次开始执行时间点后3秒再次执行；

  • @Scheduled(fixedDelay=3000)：上一次执行完毕时间点后3秒再次执行；

  • @Scheduled(initialDelay=1000, fixedDelay=3000)：第一次延迟1秒执行，然后在上一次执行完毕时间点后3秒再次执行；

举例：

1
2
3
4
5
//每3秒执行一次
@Scheduled(fixedRate = 3000)
public void timerRate() {
    //TODO you want
}

扩展：Cron表达式

Cron表达式分为6或7个域，每一个域代表一个含义，从左到右(用空格隔开)为：秒 分 小时 月份中的日期 月份 星期中的日期 年份（年份通常可省略）
每个域可取值如下：

字段 允许值 允许的特殊字符
秒（Seconds） 0~59的整数 , - * /
分（Minutes） 0~59的整数 , - * /
小时（Hours） 0~23的整数 , - * /
日期（DayofMonth） 1~31的整数（但需考虑月的天数） ,- * ? / L W C
月份（Month） 1~12的整数或者 JAN-DEC , - * /
星期（DayofWeek） 1~7的整数或者 SUN-SAT （1=SUN） , - * ? / L C #
年(可选，留空)（Year） 1970~2099 , - * /

取值含义如下：

  • ：表示匹配该域的任意值。若在Minutes域使用, 即表示每分钟都会触发某事件。
  • ?： 表示未说明的值，即不关心它为何值，只能用在DayofMonth和DayofWeek两个域，因为DayofMonth和DayofWeek会相互影响。例如想在每月的10日触发调度，不管10日到底是星期几，则使用如下写法： 1 1 1 10 ?, 其中最后一位只能用？，而不能使用，如果使用*表示不管星期几都会触发，与实际不符。
  • -：表示范围。例如在Minutes域使用5-10，表示从5分到10分钟每分钟触发一次。
  • /：表示从起始时间开始触发，然后每隔固定时间触发一次。例如在Minutes域使用5/20,则意味着从5分钟开始触发第一次，之后每隔20分钟出发一次，即5、25、45分钟各触发一次。
  • ,：表示列出枚举值。例如：在Minutes域使用5,10，则意味着在5分钟和10分钟各触发一次。
  • L：last表示最后，只能出现在DayofWeek和DayofMonth域。如果在DayofWeek域使用5L,意味着在最后的一个星期四触发。用在DayofMonth字段意思是 “这个月最后一天”。
  • W：weekday表示有效工作日(周一到周五),只能出现在DayofMonth域，系统将在离指定日期的最近的有效工作日触发事件。例如：在 DayofMonth使用5W，如果5日是星期六，则将在最近的工作日：星期五，即4日触发。如果5日是星期天，则在6日(周一)触发；如果5日在星期一到星期五中的一天，则就在5日触发。注意，W的最近寻找不会跨月份。
  • LW：这两个字符可以连用，表示在某个月最后一个工作日。
  • #：只能用在DayofWeek字段。用来指定这个月的第几个周几。例：在DayofWeek字段用”6#3”指这个月第3个周五（6指周五，3指第3个）。注意，如果指定的日期不存在，触发器就不会触发。
  • C：指和calendar联系计算过的值。它的意思是计算所关联的日期，如果日期没有被关联，则相当于日历中所有日期。例如5C在日期字段中就相当于日历5日以后的第一天；1C在星期字段中相当于星期日后的第一天。

示例：

  • /3 * ? 每隔3秒执行一次
  • 0 0 5-15 ? 每天5-15点整点触发
  • 0 0-5 14 ? 在每天下午2点到下午2:05期间的每1分钟触发
  • 0 0/3 14 ? 在每天下午2点到下午2:55期间的每3分钟触发
  • 0 0 10,14,16 ? 每天上午10点，下午2点，4点
  • 0 0 12 ? * WED 表示每个星期三中午12点
  • 0 0 17 ? * TUES,THUR,SAT 每周二、四、六下午五点
  • 0 10,44 14 ? 3 WED 每年三月的星期三的下午2:10和2:44触发
  • 0 15 10 ? * MON-FRI 周一至周五的上午10:15触发
  • 0 23 L * ? 每月最后一天23点执行一次
  • 0 15 10 ? * 6L 每月的最后一个星期五上午10:15触发
  • 0 15 10 ? * 6L 2010-2020 2010年至2020年,每月的最后一个星期五上午10:15触发
  • 0 15 10 ? * 6#3 每月的第三个星期五上午10:15触发
  • 15,30,45 ? 每逢15秒，30秒，45秒时触发任务
  • 15-45 ? 15到45秒内，每秒都触发任务
  • 15/5 ? 每分钟的第15秒开始触发，每隔5秒触发一次
  • 15-30/5 ? 每分钟的15秒到30秒之间触发，每隔5秒触发一次
  • 0 15 10 LW * ? 每个月最后一个工作日的10点15分0秒触发任务