springboot定時任務處理

定時任務是一種很常見的應用場景，springboot中的定時任務完全用的spring的那一套，用起來比較簡單，需要注意的是線程池配置的那一塊

使用 @EnableScheduling 注解就可以開啟定時任務

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(SchedulingConfiguration.class)
@Documented
public @interface EnableScheduling {

}

這個注解引用了 SchedulingConfiguration.class 類

@Configuration
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
public class SchedulingConfiguration {

    @Bean(name = TaskManagementConfigUtils.SCHEDULED_ANNOTATION_PROCESSOR_BEAN_NAME)
    @Role(BeanDefinition.ROLE_INFRASTRUCTURE)
    public ScheduledAnnotationBeanPostProcessor scheduledAnnotationProcessor() {
        return new ScheduledAnnotationBeanPostProcessor();
    }

}

這個配置類也很簡單，主要定義了 ScheduledAnnotationBeanPostProcessor 類型的ben，這個類的作用就是把標志了 
@Scheduled(fixedDelay = 1*1000) 注解的方法收集起來，封裝成一個個定時任務，再構造用於執行任務的線程池

@Component
public class ScheduleOneTest {
    private static final Logger LOGGER = LoggerFactory.getLogger(ScheduleOneTest.class);

    @Scheduled(fixedDelay = 1*1000)
    public void doWork(){
        LOGGER.info("任務一正在執行");
        try {
            Thread.sleep( 5 * 60 * 1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        LOGGER.info("任務一執行結束");
    }

需要注意的是，默認情況下，spring只構造了包含一個線程的線程池

 ScheduledTaskRegistrar類
        if (this.taskScheduler == null) {
            this.localExecutor = Executors.newSingleThreadScheduledExecutor();
            this.taskScheduler = new ConcurrentTaskScheduler(this.localExecutor);
        }

所以如果我們有多個任務需要執行，實際上是不能並發執行的，因為只有一個工作線程

@Component
public class ScheduleTwoTest {

    private static final Logger LOGGER = LoggerFactory.getLogger(ScheduleTwoTest.class);

    @Scheduled(fixedDelay = 1*1000)
    public void doWork(){
        LOGGER.info("任務二正在執行");
        try {
            Thread.sleep( 5 * 60 * 1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        LOGGER.info("任務二執行結束");
    }
}

像上面這樣，兩個一樣的任務，同時只能執行一個，必須等一個執行完，另一個才會執行，那么我們如何為spring的定時任務提供包含多個線程的線程池呢？

@Configuration
public class ScheduleConfig implements SchedulingConfigurer {

    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
//        taskRegistrar.setTaskScheduler(poolTaskScheduler());
        taskRegistrar.setScheduler(threadPoolTaskScheduler());
    }

    @Bean(name = "taskScheduler", destroyMethod = "shutdown")
    public ScheduledThreadPoolExecutor threadPoolTaskScheduler(){
//        ThreadPoolTaskScheduler poolTaskScheduler = new ThreadPoolTaskScheduler();
//        poolTaskScheduler.setPoolSize(Runtime.getRuntime().availableProcessors() * 5);
//        return poolTaskScheduler;
        return new ScheduledThreadPoolExecutor(Runtime.getRuntime().availableProcessors() * 5);
    }

}

看上面代碼，實現 SchedulingConfigurer 接口，重寫 configureTasks 方法，上面注釋掉的代碼和沒注釋掉的功能是一樣的，需要注意的是，線程池的bean名稱需要設置為 taskScheduler

 public void setScheduler(Object scheduler) {
        Assert.notNull(scheduler, "Scheduler object must not be null");
        if (scheduler instanceof TaskScheduler) {
            this.taskScheduler = (TaskScheduler) scheduler;
        }
        else if (scheduler instanceof ScheduledExecutorService) {
            this.taskScheduler = new ConcurrentTaskScheduler(((ScheduledExecutorService) scheduler));
        }
        else {
            throw new IllegalArgumentException("Unsupported scheduler type: " + scheduler.getClass());
        }
    }

這樣就可以為spring的定時任務提供指定線程個數的線程池了，至於定時任務的用法，挺簡單的，請參考其他資料

 

cron表達式詳解：    

一個cron表達式有至少6個（也可能7個）有空格分隔的時間元素。

       按順序依次為
      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           , - * /