SpringBoot如何使用@Scheduled创建定时任务？-CFANZ编程社区

前言

随着软件业务日益复杂，有时候需要创建一些定时任务以满足特定业务需求。在Java编程语言中，使用Spring框架可以轻松地创建出定时任务。

SpringBoot作为Spring框架中的一员，在创建定时任务方面也提供了便利性和灵活性。

本文将介绍SpringBoot如何使用@Scheduled创建定时任务。

摘要

本文主要包括以下内容：

源代码解析
应用场景案例
优缺点分析
类代码方法介绍
测试用例
全文小结
总结

简介

SpringBoot中提供了@Scheduled注释，该注释是用来声明一个方法是计划任务的方法。@Scheduled被定义在org.springframework.scheduling.annotation包下。

SpringBoot支持各种类型的计划任务，例如固定间隔调用、固定延迟调用、CRON表达式调用等。

下面是一个简单的使用@Scheduled注释的示例：

@Component
public class MyScheduler {
 
    @Scheduled(fixedDelay = 1000)
    public void scheduleTaskWithFixedDelay() {
        // 代码块
    }
 
    @Scheduled(fixedRate = 2000)
    public void scheduleTaskWithFixedRate() {
        // 代码块
    }
 
    @Scheduled(cron = "0 0 12 * * ?")
    public void scheduleTaskWithCronExpression() {
        // 代码块
    }
}

在上面的示例中，我们创建了一个MyScheduler类，并使用@Component注释将该类声明为Spring组件。然后我们在该类中定义了三个方法，每个方法都使用@Scheduled注释声明为一个计划任务方法。

第一个方法scheduleTaskWithFixedDelay()使用fixedDelay属性声明一个固定间隔任务，每1秒执行一次。

第二个方法scheduleTaskWithFixedRate()使用fixedRate属性声明一个固定速率任务，每2秒执行一次。

第三个方法scheduleTaskWithCronExpression()使用cron属性声明一个基于CRON表达式的计划任务，该任务在每天中午12点触发。

源代码解析

@Scheduled注释有多个属性，每个属性都用来定义计划任务的执行方式。下面是@Scheduled注释的常见属性列表：

fixedDelay：固定间隔时间，执行完毕后等待指定的间隔时间（单位毫秒）后执行下一次任务。
fixedRate：固定速率时间，从上一次开始执行到本次开始执行的间隔时间（单位毫秒），不考虑执行时间。
initialDelay：初始化延迟时间，第一次执行之前要等待的时间（单位毫秒）。
cron：CRON表达式，用于执行任务的时间计划。例如："0 0 12 * * ?"表示每天中午12点执行该任务。
zone：时区，默认为当前系统时区。

需要注意的是，以上各个属性中的时间单位均为毫秒。

应用场景案例

定时任务执行某些特定业务。

例如，每天清除某些临时文件、每周计算某些数据等等。

定时任务进行监控。

例如，每隔一段时间对服务器状态进行检查、监控数据库是否正常等等。

定时任务进行消息提醒。

例如，每天定时发送某些邮件提醒、每月定时发送统计数据等等。

优缺点分析

优点：

简单易用。

SpringBoot提供了@Scheduled注释，使得创建定时任务非常方便，开发人员只需定义好任务的执行方式即可。

灵活可配置。

SpringBoot支持多种计划任务的执行方式，并且可以配置不同的属性来满足不同的业务需求。

缺点：

任务间隔时间不可靠。

由于计划任务的执行时间取决于前一次任务的执行时间和任务的间隔时间，所以计划任务的执行间隔时间可能会出现偏差，导致任务的执行不够准确。

不适用于复杂业务。

如果需要执行的任务比较复杂、耗时较长，那么使用@Scheduled注释可能会影响系统的性能和稳定性。

类代码方法介绍

下面是@Scheduled注释中常用的属性及其含义：

fixedDelay：固定间隔时间，执行完毕后等待指定的间隔时间（单位毫秒）后执行下一次任务。
fixedRate：固定速率时间，从上一次开始执行到本次开始执行的间隔时间（单位毫秒），不考虑执行时间。
initialDelay：初始化延迟时间，第一次执行之前要等待的时间（单位毫秒）。
cron：CRON表达式，用于执行任务的时间计划。例如："0 0 12 * * ?"表示每天中午12点执行该任务。
zone：时区，默认为当前系统时区。

下面是示例代码：

@Component
public class MyScheduler {
 
    /**
     * 固定间隔时间
     */
    @Scheduled(fixedDelay = 1000)
    public void scheduleTaskWithFixedDelay() {
        // 代码块
    }
 
    /**
     * 固定速率时间
     */
    @Scheduled(fixedRate = 2000)
    public void scheduleTaskWithFixedRate() {
        // 代码块
    }
 
    /**
     * 初始化延迟时间
     */
    @Scheduled(initialDelay = 1000, fixedRate = 2000)
    public void scheduleTaskWithInitialDelay() {
        // 代码块
    }
 
    /**
     * 基于CRON表达式的计划任务
     */
    @Scheduled(cron = "0 0 12 * * ?")
    public void scheduleTaskWithCronExpression() {
        // 代码块
    }
 
}

在上面的示例中，我们创建了一个MyScheduler类，并使用@Component注释将该类声明为Spring组件。然后我们在该类中定义了四个方法，每个方法都使用@Scheduled注释声明为一个计划任务方法。

第一个方法scheduleTaskWithFixedDelay()使用fixedDelay属性声明一个固定间隔任务，每1秒执行一次。

第二个方法scheduleTaskWithFixedRate()使用fixedRate属性声明一个固定速率任务，每2秒执行一次。

第三个方法scheduleTaskWithInitialDelay()使用initialDelay属性声明初始化延迟时间为1秒，并使用fixedRate属性声明一个固定速率任务，每2秒执行一次。

第四个方法scheduleTaskWithCronExpression()使用cron属性声明一个基于CRON表达式的计划任务，该任务在每天中午12点触发。

测试用例

在测试用例中，我们将演示如何使用@Scheduled注释创建定时任务。

@SpringBootTest
class DemoApplicationTests {
 
    @Test
    void contextLoads() {
    }
 
}

我们在contextLoads()方法中创建一个计划任务，并验证任务是否能够按照我们的期望执行。

@SpringBootTest
class DemoApplicationTests {
 
    @Autowired
    private MyScheduler myScheduler;
 
    @Test
    void contextLoads() throws InterruptedException {
 
        // 等待任务执行
        Thread.sleep(5000);
 
        // 验证任务是否执行
        Mockito.verify(myScheduler, Mockito.times(2)).scheduleTaskWithFixedDelay();
        Mockito.verify(myScheduler, Mockito.times(2)).scheduleTaskWithFixedRate();
        Mockito.verify(myScheduler, Mockito.times(2)).scheduleTaskWithInitialDelay();
        Mockito.verify(myScheduler, Mockito.times(2)).scheduleTaskWithCronExpression();
    }
 
}

在上面的示例中，我们首先在Test类中使用@Autowired注释注入了MyScheduler组件，在contextLoads()方法中等待任务执行，并通过Mockito.verify()。