【SpringBoot】SpringBoot 中使用定时任务

1.SpringBoot 集成定时任务

1、引入依赖

SpringBoot 已经默认集成了定时任务的依赖，只需要引入基本的依赖就可以使用定时任务。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2、添加 @EnableScheduling 注解

在启动类中需要加入 @EnableScheduling 注解，意思是开启定时任务。

@EnableScheduling
@SpringBootApplication
public class App {
    public static void main( String[] args ) {
        SpringApplication.run(App.class, args);
    }
}

3、添加 @Scheduled 注解

创建定时任务实现类：每秒种打印一次日志，并打印当前时间验证当前任务执行周期

@Scheduled 注解中使用的是 cron 表达式。【Cron】学习：cron 表达式

@Component
public class ScheduleTask {

    private static final Logger logger = LoggerFactory.getLogger(ScheduleTask.class);

    private int count = 0;

    @Scheduled(cron="*/1 * * * * ?")
    private void process() {
        logger.info("this is scheduler task runing  "+(count++) + ",当前时间为：" + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
    }

}

运行结果如下：

由控制台打印信息知：确实是每 1 秒执行 1 次。

并且，由控制台打印信息知：执行这个任务的线程一直是 scheduling-1 这个线程。这就意味着，这个定时任务启动是由单独的一个线程去执行的。

这时候，可能会有几个问题：

1、如果任务执行的时间比执行周期要长，这个任务会怎么执行？
2、如果有多个任务执行，还会是一个线程去执行这个任务吗？

2. 示例分析

首先，验证第一个问题：

1、当任务执行的时间比执行周期长时，任务的执行情况：

@Scheduled(cron="*/1 * * * * ?")
private void process2() {
    try {
        Thread.sleep(3000);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }
    logger.info("this is scheduler task runing  "+(count++) + ",当前时间为：" + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
}

运行结果如下：

执行结果：每次任务的执行时间间隔为 4 秒，并且是同一个线程在执行。

2、如果有多个任务执行，任务的执行情况：

@Component
public class ScheduleTask {

    private static final Logger logger = LoggerFactory.getLogger(ScheduleTask.class);

    private int count = 0;

    @Scheduled(cron="*/1 * * * * ?")
    private void process() {
        logger.info("this is scheduler task runing  "+(count++) + ",当前时间为：" + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
    }

    @Scheduled(cron="*/1 * * * * ?")
    private void process2() {
        try {
            Thread.sleep(3000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        logger.info("this is scheduler task runing  "+(count++) + ",当前时间为：" + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
    }
}

运行结果如下：

执行结果：第二个每秒执行一次的任务的并没有按照设定的执行周期执行，运行结果并没有达到预期。并且两个任务都是由同一个线程去运行。

示例分析中问题2的原因就是执行多个任务并不是多个线程执行，导致执行第一个任务时，第二个任务进入等待状态。

SpringBoot 中提供了多线程运行定时任务的方式。

3. 配置线程池

增加一个配置类，设置线程池，并设置线程池大小，这里的线程池大小就仁者见仁了，和你程序中的任务的个数有关系，也和机器的核数有关系。

@Configuration
public class ScheduleConfig implements SchedulingConfigurer {

    @Override
    public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) {
        scheduledTaskRegistrar.setScheduler(Executors.newScheduledThreadPool(3));
    }
}

通过配置线程池就能让每个任务独立执行，不受其他任务的影响，因为是在不同的线程中执行的，但如果涉及到公共资源就另当别论了。

执行结果：

4. 配置周期

上述中的执行周期都是以 cron 表达式定义的，这种方式最灵活，但是上文中的表达式都写到代码中去了，不便于修改，这里提供一种配置方式，直接用表达式获取 yml 中的配置信息。

scheduleTask:
  cron1: "*/1 * * * * ?"
  cron2: "*/1 * * * * ?"

在yml中添加cron的配置信息。然后在Java注解中可以直接获取

@Scheduled(cron="${scheduleTask.cron1}")
private void process() {
    logger.info("this is scheduler task runing  "+(count++) + ",当前时间为：" + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
}

---

【参考资料】

springBoot中使用定时任务