SpringBoot使用@Scheduled创建定时任务

本章目标

基于SpringBoot架构完成注解@Scheduled的定时任务配置

本文转自SpringBoot使用@Scheduled创建定时任务
本文转自springboot 基于@Scheduled注解 实现定时任务

创建定时任务类，需要加入@Configuration，标明这是一个配置类；加入@EnableScheduling，开启定时任务，在任务方法上加 @Scheduled注解，设置定时参数。

package com.example.config;


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.annotation.Async;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;

import java.time.LocalTime;
import java.util.concurrent.TimeUnit;

@Configuration
@EnableScheduling
public class ScheduledTaskConfig {
    private static final Logger LOGGER = LoggerFactory.getLogger(ScheduledTaskConfig.class);



    // fixrate属性是调用开始到后一个次用之间的间隔，所以如果间隔小，但是方法耗时，方法会直接执行
    @Scheduled(fixedRate = 1000L)
    public void task1() throws InterruptedException {
        LOGGER.info("执行定时任务task1: 线程是：" + Thread.currentThread().getName() + "时间：" + LocalTime.now());
        TimeUnit.SECONDS.sleep(3);
    }
}

结果：

Scheduled注解的属性配置

cron定时属性

@Scheduled(cron = “0/5 * * * * ?”)

cron属性
cron属性值是一个String类型的时间表达式，各部分的含义如下：

Seconds : 可出现", - * /“四个字符，有效范围为0-59的整数
Minutes : 可出现”, - * /“四个字符，有效范围为0-59的整数
Hours : 可出现”, - * /“四个字符，有效范围为0-23的整数
DayofMonth : 可出现”, - * / ? L W C"八个字符，有效范围为0-31的整数
Month : 可出现", - * /“四个字符，有效范围为1-12的整数或JAN-DEc
DayofWeek : 可出现”, - * / ? L C #“四个字符，有效范围为1-7的整数或SUN-SAT两个范围。1表示星期天，2表示星期一，依次类推
Year : 可出现”, - * /"四个字符，有效范围为1970-2099年

举几个例子如下：

“0 0 12 * * ?” 每天中午十二点触发
“0 30 10 ? * *” 每天早上10：30触发
“0 15 10 * * ?” 每天早上10：15触发
“0 15 10 * * ? *” 每天早上10：15触发
“0 15 10 * * ? 2018” 2018年的每天早上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触发

在线Cron生成器

fixedRate属性

@Scheduled(fixedRate = 1000L)

fixedRate属性是上一个调用开始后再次调用的延时（不用等待上一次调用完成），这样就会存在重复执行的问题，不推荐使用。

可以看到每一次打印的间隔都是2秒钟，也就是配置线程休眠的时间，证实了该方法并没有等到执行完再开始下一次执行。

fixedDelay属性

@Scheduled(fixedDelay = 1000L)

fixedDelay属性的效果与上面的fixedRate则是相反的，配置了该属性后会等到方法执行完成后延迟配置的时间再次执行该方法。

可以看到控制台打印，时间间隔是4秒钟，我们在方法内仅仅使线程休眠了3秒钟，配置方法的延迟执行时间则是1秒钟，证明在方法执行完成后延迟配置时间后再次执行该方法。

initialDelay属性

initialDelay属性跟上面的fixedDelay、fixedRate有着密切的关系，该属性的作用是第一次执行延迟时间，只是做延迟的设定，并不会控制其他逻辑，所以要配合fixedDelay或者fixedRate来使用。

重启项目，查看控制台输出，等待了10秒钟后才看到了第一次打印内容

项目成功启动的时间为11:26:12而第一次输出的时间则是11:26:22，证明配置的延迟时间生效了，第一次加载完成之后每间隔2秒钟执行该方法。

总结

本章主要学习基于SpringBoot内置的定时任务的配置使用，主要涉及两个注解，四个属性的配置：

1. 主程序入口@EnableScheduling 开启定时任务
2. 定时方法上@Scheduled设置定时
3. cron属性 按cron规则执行
4. fixedRate属性 以固定速率执行
5. fixedDelay属性 上次执行完毕后延迟再执行
6. initialDelay属性 第一次延时执行，第一次执行完毕后延迟后再次执行

避坑注意

本文转自spring scheduled单线程和多线程使用过程中的大坑！！不看到时候绝对后悔！

SpringBoot使用@scheduled定时执行任务的时候是在一个单线程中，如果有多个任务，其中一个任务执行时间过长，则有可能会导致其他后续任务被阻塞直到该任务执行完成。也就是会造成一些任务无法定时执行的错觉。

解决方法1

scheduled调度时，创建的是单线程，使用线程池配置多个线程。但是需要注意的是，**多个任务是使用多个线程执行的，但是对于一个任务来说，如果卡死（堵塞，比如一致等待某个请求的结果），下一次定时执行也不会执行。**通俗的解释是：同一个任务使用的还是同一个线程。

@Bean
    public TaskScheduler taskScheduler() {
        ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
        scheduler.setPoolSize(10);
        return scheduler;
    }

package com.example.config;


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.annotation.Async;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;

import java.time.LocalTime;
import java.util.concurrent.TimeUnit;

@Configuration
@EnableScheduling
public class ScheduledTaskConfig {
    private static final Logger LOGGER = LoggerFactory.getLogger(ScheduledTaskConfig.class);


    @Bean
    @Primary
    public TaskScheduler taskScheduler() {
        ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
        scheduler.setPoolSize(5);
        return scheduler;
    }

    @Scheduled(fixedRate = 1000L)
    public void task1() throws InterruptedException {
        LOGGER.info("执行定时任务task1: 线程是：" + Thread.currentThread().getName() + "时间：" + LocalTime.now());
        TimeUnit.SECONDS.sleep(Integer.MAX_VALUE);
    }



    @Scheduled(fixedDelay = 2000L)
    public void task2() throws InterruptedException {
        LOGGER.info("执行定时任务task2: 线程是：" + Thread.currentThread().getName() + "时间：" + LocalTime.now());
        TimeUnit.SECONDS.sleep(3);

    }


}

会看到task1卡死，一致等不到执行。

解决方法2

还有一种方法可以解决这种一个任务多个线程的问题，前面的方法多数针对的是多个任务多个线程。
该方法是只要有一个任务就会创建一个线程来执行任务。
类上加入@EnableAsync注解，任务方法上加入@Async注解

package com.example.config;


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.annotation.Async;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;

import java.time.LocalTime;
import java.util.concurrent.TimeUnit;

@Configuration
@EnableScheduling
@EnableAsync
public class ScheduledTaskConfig {
    private static final Logger LOGGER = LoggerFactory.getLogger(ScheduledTaskConfig.class);

    @Scheduled(fixedRate = 1000L)
    @Async
    public void task1() throws InterruptedException {
        LOGGER.info("执行定时任务task1: 线程是：" + Thread.currentThread().getName() + "时间：" + LocalTime.now());
        TimeUnit.SECONDS.sleep(Integer.MAX_VALUE);
    }



    @Scheduled(fixedDelay = 2000L)
    @Async
    public void task2() throws InterruptedException {
        LOGGER.info("执行定时任务task2: 线程是：" + Thread.currentThread().getName() + "时间：" + LocalTime.now());
        TimeUnit.SECONDS.sleep(3);

    }
}

可以看到同一个任务使用的是不同的线程执行，但是如果一个任务是堵塞了，但创建的线程数和线程池中的线程一样时，同样会卡死，比如本例中，线程池中创建5个线程，task1是堵塞的，当这些线程都用来执行task1线程时，就会卡死。

定时任务突然停止问题排查

本文转自spring boot中得定时任务执行一段时间后突然停了 排查过程