Spring定时任务@Scheduled注解使用配置方式（cron表达式、fixedRate和fixedDelay）

Spring定时任务@Scheduled注解使用配置方式（cron表达式、fixedRate和fixedDelay）

序言：

个人推荐一个很方便的在线Cron生成器（网页版）：https://qqe2.com/cron/index 

一、前言

spring的@Scheduled定时任务相信大家都是十分熟悉。最近在项目开发过程中发现了一些问题，写篇文章，和大家分享一下。结论在最后，想直接看的可以拉到最后。

---

 

二、使用

• @Scheduled的使用方式十分简单，首先在项目启动类添加注解@EnableScheduled。
• 编写定时任务方法，方法上添加注解@Scheduled。
• 如果有多个定时任务，可以使用异步或者多线程解决。

方式一：@Scheduled(cron = "0/1 * * * * ?")

@Component
public class testTask {
    private Logger logger = LoggerFactory.getLogger(testTask.class);

    @Scheduled(cron = "0/5 * * * * ?")
    public void doTask() {
        logger.info(Thread.currentThread().getName()+"===task run");
    }

}

关于cron表达式的写法如下：  

   按顺序依次为
  1  秒（0~59）
  2  分钟（0~59）
  3 小时（0~23）
  4  天（0~31）
  5 月（0~11）
  6  星期（1~7 1=SUN 或 SUN，MON，TUE，WED，THU，FRI，SAT）
  7.年份（1970－2099）
  其中每个元素可以是一个值(如6),一个连续区间(9-12),一个间隔时间(8-18/4)(/表示每隔4小时),一个列表(1,3,5),通配符。由于"月份中的日期"和"星期中的日期"这两个元素互斥的,必须要对其中一个设置?.
   0 0 10,14,16 * * ? 每天上午10点，下午2点，4点
   0 0/30 9-17 * * ?   朝九晚五工作时间内每半小时
   0 0 12 ? * WED 表示每个星期三中午12点
   "0 0 12 * * ?" 每天中午12点触发 
   "0 15 10 ? * *" 每天上午10:15触发 
   "0 15 10 * * ?" 每天上午10:15触发 
   "0 15 10 * * ? *" 每天上午10:15触发 
   "0 15 10 * * ? 2005" 2005年的每天上午10:15触发 
   "0 * 14 * * ?" 在每天下午2点到下午2:59期间的每1分钟触发 
   "0 0/5 14 * * ?" 在每天下午2点到下午2:55期间的每5分钟触发 
   "0 0/5 14,18 * * ?" 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发 
   "0 0-5 14 * * ?" 在每天下午2点到下午2:05期间的每1分钟触发 
   "0 10,44 14 ? 3 WED" 每年三月的星期三的下午2:10和2:44触发 
   "0 15 10 ? * MON-FRI" 周一至周五的上午10:15触发 
   "0 15 10 15 * ?" 每月15日上午10:15触发 
   "0 15 10 L * ?" 每月最后一日的上午10:15触发 
   "0 15 10 ? * 6L" 每月的最后一个星期五上午10:15触发 
   "0 15 10 ? * 6L 2002-2005" 2002年至2005年的每月的最后一个星期五上午10:15触发 
   "0 15 10 ? * 6#3" 每月的第三个星期五上午10:15触发 
   有些子表达式能包含一些范围或列表
   例如：子表达式（天（星期））可以为 “MON-FRI”，“MON，WED，FRI”，“MON-WED,SAT”
   “*”字符代表所有可能的值
   “/”字符用来指定数值的增量
   例如：在子表达式（分钟）里的“0/15”表示从第0分钟开始，每15分钟
            在子表达式（分钟）里的“3/20”表示从第3分钟开始，每20分钟（它和“3，23，43”）的含义一样
   “？”字符仅被用于天（月）和天（星期）两个子表达式，表示不指定值
   当2个子表达式其中之一被指定了值以后，为了避免冲突，需要将另一个子表达式的值设为“？”
   “L” 字符仅被用于天（月）和天（星期）两个子表达式，它是单词“last”的缩写
   如果在“L”前有具体的内容，它就具有其他的含义了。例如：“6L”表示这个月的倒数第６天
   注意：在使用“L”参数时，不要指定列表或范围，因为这会导致问题
   W 字符代表着平日(Mon-Fri)，并且仅能用于日域中。它用来指定离指定日的最近的一个平日。大部分的商业处理都是基于工作周的，所以 W 字符可能是非常重要的。
   例如，日域中的 15W 意味着 "离该月15号的最近一个平日。" 假如15号是星期六，那么 trigger 会在14号(星期五)触发，因为星期四比星期一离15号更近。
   C：代表“Calendar”的意思。它的意思是计划所关联的日期，如果日期没有被关联，则相当于日历中所有日期。例如5C在日期字段中就相当于日历5日以后的第一天。1C在星期字段中相当于星期日后的第一天。
   字段   允许值   允许的特殊字符
   秒           0-59           , - * /
   分           0-59           , - * /
   小时           0-23           , - * /
   日期           1-31           , - * ? / L W C
   月份           1-12 或者 JAN-DEC           , - * /
   星期           1-7 或者 SUN-SAT           , - * ? / L C #
   年（可选）           留空, 1970-2099           , - * /

 

继续，启动项目运行，控制台输出：

2020-05-28 15:20:30.009 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 15:20:35.009 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 15:20:40.008 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 15:20:45.009 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 15:20:50.232 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 15:20:55.007 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run

 

问题出现了，如果我的任务在5秒内没有执行完呢？spring会怎么处理呢？

测试代码：

@Scheduled(cron = "*/5 * * * * ?")
    public void doTask() throws InterruptedException {
        logger.info(Thread.currentThread().getName()+"===task run");
        Thread.sleep(6*1_000);
        logger.info(Thread.currentThread().getName()+"===task end");
    }

测试结果：

 

2020-05-28 16:02:50.035 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:02:56.496 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 16:03:00.006 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:03:06.013 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 16:03:10.115 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:03:17.267 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 16:03:20.055 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:03:26.164 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end

我们可以发现，spring他的处理方式是等待上一个任务执行完成后，再去执行下一个任务，也就是说spring的定时任务默认是单线程的，而不会开启另一条线程去执行任务。

眼尖的小伙伴应该发现任务执行的时间还是怪怪的，任务开始到结束的时间间隔确实是6s，但是下一个任务的开始时间和上一个任务的结束时间之间为什么差了4s呢？这个时间是怎么设定的呢？

这个问题和spring处理cron表达式这种定时任务的机制有关，我们稍后再说，先讲讲@Scheduled注解的另外两个属性：fixedRate和fixedDelay。

 

方式二：@Scheduled(fixedDelay = 5000)

测试代码：

@Scheduled(fixedDelay = 5000)
    public void doTask() throws InterruptedException {
        logger.info(Thread.currentThread().getName()+"===task run");
        Thread.sleep(6*1_000);
        logger.info(Thread.currentThread().getName()+"===task end");
    }

测试结果：

2020-05-28 16:30:56.246 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:31:03.114 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 16:31:08.122 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:31:14.139 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 16:31:19.149 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:31:25.261 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 16:31:30.269 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:31:36.385 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end

我们可以发现，这个结果和上一个使用cro表达式的结果好像啊。但是仔细看我们就会发现，这次所有的时间都是我们配置的：任务开始到结束间隔6s，上一个任务结束时间到下一个任务开始时间是5秒，这样看来是比较符合我们的设置的。

fixedDelay是设定上一个任务结束后多久执行下一个任务，也就是fixedDelay只关心上一任务的结束时间和下一任务的开始时间。

 

方式三：@Scheduled(fixedRate = 5000)

测试代码：

@Scheduled(fixedRate = 5000)
    public void doTask() throws InterruptedException {
        logger.info(Thread.currentThread().getName()+"===task run");
//        Thread.sleep(6*1_000);
        logger.info(Thread.currentThread().getName()+"===task end");
    }

测试结果：

2020-05-28 16:48:22.039 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:48:22.060 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 16:48:27.005 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:48:27.496 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 16:48:32.001 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:48:32.008 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 16:48:37.016 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:48:37.024 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end

嗯？这样看来好像和其他两个没什么区别，都是间隔5s执行方法啊。别急，现在我们把注掉的6s任务执行时间放开，再来看看结果
测试代码：

2020-05-28 16:54:29.613 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:54:36.113 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 16:54:36.118 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:54:42.580 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 16:54:42.607 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:54:48.632 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 16:54:48.639 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 16:54:55.188 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end

这次我们可以看到，上一个任务结束后，下一个任务立刻开始执行了，结合第一次测试，我们就可以推断，fixedRate设置的上一个任务的开始时间到下一个任务开始时间的间隔，那我们的推断对不对呢？这次我们把任务执行时间改成2s，测试走起~
测试代码：

@Scheduled(fixedRate = 5000)
    public void doTask() throws InterruptedException {
        logger.info(Thread.currentThread().getName()+"===task run");
        Thread.sleep(2*1_000);
        logger.info(Thread.currentThread().getName()+"===task end");
    }

测试结果：

2020-05-28 17:08:37.500 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 17:08:39.510 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 17:08:43.086 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 17:08:45.093 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 17:08:48.025 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 17:08:50.083 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 17:08:53.239 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 17:08:55.245 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end

结果和我们推断的一致，两个任务的开始时间间隔是5s，当到达任务的开始执行时间，但上一个任务却没有完成时，spring会等待上一个任务执行完，并立即开始执行本次任务。

---

三、分析

1、Cron执行机制：

        上面介绍了cron表达式、fixedRate和fixedDelay三种方式，但还有一个遗留问题，那就是cron的执行机制，为什么使用它时两个任务间隔并不固定呢？其实spring在处理使用cron表达式这种定时任务时，其实依旧关注的是任务的开始时间，但是他和fixedDelay不同的是，他会在配置任务开始时判断任务是否可以执行，如果可以则执行，如果不可以，那么他将不执行此次任务，等待下一次执行。比如下图：

        AB两个任务配置的执行规则都是每隔5s执行，A任务执行时间是4s，而B任务执行时间是7s。
A任务可以在执行内执行完任务，所以每隔5s他就会正常执行，0s开始，4s时结束，那么在5s的时候他会再次执行，如此反复。
        而B任务的执行时间是7s，执行时间超过了任务的间隔时间，就如图中例子，B任务在10s开始，执行时间持续了7s，当15s的时候本来应该是开始执行第二次，但由于第一次任务还未执行完成，所以第二次任务将不会执行，而是到20s要开始执行第三次任务的时候，再次判断，发现上一次B任务已经执行完毕，这时才开始再次执行B任务。

        还记得我们刚开始使用cron表达式做了一个执行时间为6s，间隔5s执行的测试任务吗？这次我们改一改，将执行时间改为8s，再次测试。

测试代码：

@Scheduled(cron = "0/5 * * * * ?")
    public void doTask() throws InterruptedException {
        logger.info(Thread.currentThread().getName()+"===task run");
        Thread.sleep(8*1_000);
        logger.info(Thread.currentThread().getName()+"===task end");
    }

测试结果：

2020-05-28 17:54:30.014 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 17:54:38.033 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 17:54:40.488 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 17:54:49.617 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 17:54:50.260 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 17:54:58.270 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end
2020-05-28 17:55:00.845 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task run
2020-05-28 17:55:08.856 [pool-12-thread-1] INFO  service.task.testTask -pool-12-thread-1===task end

---

四、总结

1. fixedRate配置了上一次任务的开始时间到下一次任务的开始时间的间隔，每次任务都会执行；

2. fixedDelay配置了上一次任务的结束时间到下一次任务的开始时间的间隔，每次任务都会执行；

3. cron表达式配置了在哪一刻执行任务，会在配置的任务开始时间判断任务是否可以执行，如果能则执行，不能则会跳过本次执行；

        如果是强调任务间隔的定时任务，建议使用fixedRate和fixedDelay，如果是强调任务在某时某分某刻执行的定时任务，建议使用cron表达式。