Spring定時任務註解說明

一、註解說明。 
Spring 自帶的定時任務執行@Scheduled註解，可以定時的、週期性的執行一些任務。查看@Scheduled的註解可以看到有以下三種： 
1.1 String cron() default “” ;

//定義一個按時間執行的定時任務，在每天1:00執行一次。
@Scheduled(cron = "0 0 1* * ?") 
public void run() {
  //執行代碼
}

• 1
• 2
• 3
• 4
• 5

參數說明：

"0 0 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分每分鐘一次觸發 
"0 0/5 14 * * ?"    每天從下午2點開始到2：55分結束每5分鐘一次觸發 
"0 0/5 14,18 * * ?"    每天的下午2點至2：55和6點至6點55分兩個時間段內每5分鐘一次觸發 
"0 0-5 14 * * ?"    每天14:00至14:05每分鐘一次觸發 
"0 10,44 14 ? 3 WED"    三月的每週三的14：10和14：44觸發 
"0 15 10 ? * MON-FRI"    每個週一、週二、週三、週四、週五的10：15觸發 

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11

1.2 long fixedDelay() default -1;

//定義一個按一定頻率執行的定時任務，每隔1分鐘執行一次，延遲1秒執行
    @Scheduled(fixedRate = 1000 * 60,initialDelay = 1000)
    public void run() {
    //執行代碼
}

• 1
• 2
• 3
• 4
• 5

1.3 long fixedRate() default -1;

//定義一個按一定頻率執行的定時任務，每隔2分鐘執行一次
    @Scheduled(fixedRate = 1000 * 120)
    public void run() {
    //執行代碼
}

• 1
• 2
• 3
• 4
• 5

二、@Scheduled 執行原理說明： 
簡要介紹：spring在初始化bean後，通過“postProcessAfterInitialization”攔截到所有的用到“@Scheduled”註解的方法，並解析相應的的註解參數，放入“定時任務列表”等待後續處理；之後再“定時任務列表”中統一執行相應的定時任務。 
2.1 依次加載所有的實現 Scheduled 註解的類方法。（具體查看 spring-context jar包）說明：

ScheduledAnnotationBeanPostProcessor繼承BeanPostProcessor。
public Object postProcessAfterInitialization (final Object bean, String beanName ) {
           final Class<?> targetClass = AopUtils.getTargetClass(bean);
          ReflectionUtils. doWithMethods(targetClass, new MethodCallback() {
               public void doWith(Method method) throws IllegalArgumentException, IllegalAccessException {
                    Scheduled annotation = AnnotationUtils.getAnnotation(method, Scheduled.class);
                    if (annotation != null) {
                        // 此處省略條件判斷說明
                        Runnable runnable = new ScheduledMethodRunnable(bean , method );
                         boolean processedSchedule = false;
                        String errorMessage = "Exactly one of 'cron', 'fixedDelay', or 'fixedRate' is required.";
                        String cron = annotation.cron();
                         if (!"" .equals(cron )) {
                              processedSchedule = true ;
                              if (embeddedValueResolver != null) {
                                   cron = embeddedValueResolver.resolveStringValue(cron );
                             }
                              cronTasks.put(runnable , cron);
                        }
                         long fixedDelay = annotation.fixedDelay();
                         if (fixedDelay >= 0) {
                             Assert. isTrue(!processedSchedule, errorMessage);
                              processedSchedule = true ;
                              fixedDelayTasks.put(runnable , fixedDelay );
                        }
                         long fixedRate = annotation.fixedRate();
                         if (fixedRate >= 0) {
                             Assert. isTrue(!processedSchedule, errorMessage);
                              processedSchedule = true ;
                              fixedRateTasks.put(runnable , fixedRate);
                        }
                        Assert. isTrue(processedSchedule, errorMessage);
                   }
              }
          });
           return bean ;
     }

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37

從這段代碼中我們可以發現任務爲順序執行，先執行cron，之後再執行fixedRate。 
2.2 將對應類型的定時器放入相應的“定時任務列表”中，獲取scheduled類參數，之後根據參數類型、相應的延時時間、對應的時區放入不同的任務列表中

protected void processScheduled(Scheduled scheduled, Method method, Object bean) {   
     //獲取corn類型
      String cron = scheduled.cron();
      if (StringUtils.hasText(cron)) {
         Assert.isTrue(initialDelay == -1, "'initialDelay' not supported for cron triggers");
         processedSchedule = true;
         String zone = scheduled.zone();
         //放入cron任務列表中（不執行）
         this.registrar.addCronTask(new CronTask(runnable, new CronTrigger(cron, timeZone)));
      }
      //執行頻率類型（long類型）
      long fixedRate = scheduled.fixedRate();
      String fixedDelayString = scheduled.fixedDelayString();
      if (fixedRate >= 0) {
         Assert.isTrue(!processedSchedule, errorMessage);
         processedSchedule = true;
          //放入FixedRate任務列表中（不執行）（registrar爲ScheduledTaskRegistrar）
         this.registrar.addFixedRateTask(new IntervalTask(runnable, fixedRate, initialDelay));
      }
     //執行頻率類型（字符串類型，不接收參數計算如：600*20）
      String fixedRateString = scheduled.fixedRateString();
      if (StringUtils.hasText(fixedRateString)) {
         Assert.isTrue(!processedSchedule, errorMessage);
         processedSchedule = true;
         if (this.embeddedValueResolver != null) {
            fixedRateString = this.embeddedValueResolver.resolveStringValue(fixedRateString);
         }
         fixedRate = Long.parseLong(fixedRateString);
         //放入FixedRate任務列表中（不執行）
         this.registrar.addFixedRateTask(new IntervalTask(runnable, fixedRate, initialDelay));
      }
}
   return bean;
}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34

2.3：執行相應的定時任務。 
說明：定時任務先執行corn，判斷定時任務的執行時間，計算出相應的下次執行時間，放入線程中，到相應的時間後進行執行。之後執行按“頻率”（fixedRate）執行的定時任務，直到所有任務執行結束。

protected void scheduleTasks() {
   //順序執行相應的Cron
   if (this.cronTasks != null) {
      for (CronTask task : this.cronTasks) {
         this.scheduledFutures.add(this.taskScheduler.schedule(
               task.getRunnable(), task.getTrigger()));
      }
   }
  //順序執行所有的“fixedRate”定時任務（無延遲，也就是說initialDelay參數爲空），因爲無延遲，所以定時任務會直接執行一次，執行任務完成後，會將下次執行任務的時間放入delayedExecute中等待下次執行。
   if (this.fixedRateTasks != null) {
      for (IntervalTask task : this.fixedRateTasks) {
         if (task.getInitialDelay() > 0) {
            Date startTime = new Date(now + task.getInitialDelay());
            this.scheduledFutures.add(this.taskScheduler.scheduleAtFixedRate(
                  task.getRunnable(), startTime, task.getInterval()));
         }
         else {
            this.scheduledFutures.add(this.taskScheduler.scheduleAtFixedRate(
                  task.getRunnable(), task.getInterval()));
         }
      }
   }
//順序執行所有的“fixedRate”定時任務（有延遲，也就是說initialDelay參數不爲空）
   if (this.fixedDelayTasks != null) {
      for (IntervalTask task : this.fixedDelayTasks) {
         if (task.getInitialDelay() > 0) {
            Date startTime = new Date(now + task.getInitialDelay());
            this.scheduledFutures.add(this.taskScheduler.scheduleWithFixedDelay(
                  task.getRunnable(), startTime, task.getInterval()));
         }
         else {
            this.scheduledFutures.add(this.taskScheduler.scheduleWithFixedDelay(
                  task.getRunnable(), task.getInterval()));
         }
      }
   }
}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37

2.4 接下來看下定時任務run（extends自Runnable接口）方法： 
//說明：每次執行定時任務結束後，會先設置下下次定時任務的執行時間，以此來確認下次任務的執行時間。

public void run() {
    boolean periodic = isPeriodic();
    if (!canRunInCurrentRunState(periodic))
        cancel(false);
    else if (!periodic)
        ScheduledFutureTask.super.run();
    else if (ScheduledFutureTask.super.runAndReset()) {
        setNextRunTime();
        reExecutePeriodic(outerTask);
    }
}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11

備註1：從上面的代碼可以看出，如果多個定時任務定義的是同一個時間，那麼也是順序執行的，會根據程序加載Scheduled方法的先後來執行。 
但是如果某個定時任務執行未完成會出現什麼現象呢？ 
答：此任務一直無法執行完成，無法設置下次任務執行時間，之後會導致此任務後面的所有定時任務無法繼續執行，也就會出現所有的定時任務“失效”現象。 
所以應用springBoot中定時任務的方法中，一定不要出現“死循環”、“http持續等待無響應”現象，否則會導致定時任務程序無法正常。再就是非特殊需求情況下可以把定時任務“分散”下。