当前位置：首页 > article >正文

@Scheduled注解的使用-SpringBoot-Springtask

article 2024/12/29 7:17:55

@Scheduled 注解是 Spring 框架中用于定时任务调度的核心注解之一。通过 @Scheduled 注解，开发者可以非常方便地在 Spring 应用程序中定义和配置各种定时任务，包括固定速率执行、固定延迟执行、cron 表达式执行等。本文将详细讲解 @Scheduled 注解的各个方面，包括其属性、使用方法、配置方式以及一些最佳实践。

基本概念

@Scheduled 注解用于标记一个方法，使其成为一个定时任务，按照指定的时间规则自动执行。被 @Scheduled 注解标记的方法必须是 void 返回类型，并且不能接受任何参数。

属性详解

@Scheduled 注解提供了多个属性，用于定义任务的执行规则：

fixedRate：
- 类型：long
- 描述：以毫秒为单位，定义任务两次执行之间的固定时间间隔。任务会以固定的时间间隔执行，即使前一次任务的执行时间超过了这个间隔。
- 示例：@Scheduled(fixedRate = 5000) 表示任务每 5 秒执行一次。
fixedDelay：
- 类型：long
- 描述：以毫秒为单位，定义任务两次执行之间的固定延迟时间。任务会在前一次执行完成后，等待指定的延迟时间后再执行下一次。
- 示例：@Scheduled(fixedDelay = 5000) 表示任务在前一次执行完成后，等待 5 秒再执行下一次。
initialDelay：
- 类型：long
- 描述：以毫秒为单位，定义任务首次执行前的初始延迟时间。任务会在应用程序启动后，等待指定的初始延迟时间后再首次执行。
- 示例：@Scheduled(fixedRate = 5000, initialDelay = 1000) 表示任务在应用程序启动后等待 1 秒，然后每 5 秒执行一次。
cron：
- 类型：String
- 描述：使用 cron 表达式定义任务的执行时间规则。cron 表达式非常灵活，可以定义复杂的执行时间规则。
- 示例：@Scheduled(cron = "0 0 12 * * ?") 表示任务每天中午 12 点执行。
zone：
- 类型：String
- 描述：定义 cron 表达式使用的时区。默认情况下，使用服务器的本地时区。
- 示例：@Scheduled(cron = "0 0 12 * * ?", zone = "GMT") 表示任务每天中午 12 点在 GMT 时区执行。

使用方法

要使用 @Scheduled 注解，首先需要在 Spring 配置类上启用任务调度功能，可以通过 @EnableScheduling 注解来实现：

@Configuration
@EnableScheduling
public class SchedulingConfig {
}

然后，在需要定时执行的方法上添加 @Scheduled 注解，并配置相应的属性：

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

    @Scheduled(fixedRate = 5000)
    public void runTaskAtFixedRate() {
        logger.info("Fixed rate task - {}", System.currentTimeMillis());
    }

    @Scheduled(fixedDelay = 5000)
    public void runTaskAtFixedDelay() {
        logger.info("Fixed delay task - {}", System.currentTimeMillis());
    }

    @Scheduled(initialDelay = 1000, fixedRate = 5000)
    public void runTaskWithInitialDelay() {
        logger.info("Task with initial delay - {}", System.currentTimeMillis());
    }

    @Scheduled(cron = "0 0 12 * * ?")
    public void runTaskAtNoon() {
        logger.info("Noon task - {}", System.currentTimeMillis());
    }
}

配置方式

除了在方法上直接使用 @Scheduled 注解外，还可以通过配置文件（如 XML 或 properties 文件）来定义定时任务的执行规则。这种方式适用于需要动态配置任务执行规则的场景。

XML 配置

在 Spring 的 XML 配置文件中，可以通过 <task:scheduled-tasks> 标签来配置定时任务：

<task:scheduled-tasks scheduler="scheduler">
    <task:scheduled ref="scheduledTasks" method="runTaskAtFixedRate" fixed-rate="5000"/>
    <task:scheduled ref="scheduledTasks" method="runTaskAtFixedDelay" fixed-delay="5000"/>
    <task:scheduled ref="scheduledTasks" method="runTaskWithInitialDelay" initial-delay="1000" fixed-rate="5000"/>
    <task:scheduled ref="scheduledTasks" method="runTaskAtNoon" cron="0 0 12 * * ?"/>
</task:scheduled-tasks>

<task:scheduler id="scheduler" pool-size="10"/>

Properties 配置

在 Spring Boot 应用程序中，可以通过 application.properties 文件来配置定时任务的执行规则：

# 定义定时任务的执行规则
scheduled.task.fixedRate=5000
scheduled.task.fixedDelay=5000
scheduled.task.initialDelay=1000
scheduled.task.cron=0 0 12 * * ?

然后在代码中使用 @Value 注解来读取这些配置：

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

    @Value("${scheduled.task.fixedRate}")
    private long fixedRate;

    @Value("${scheduled.task.fixedDelay}")
    private long fixedDelay;

    @Value("${scheduled.task.initialDelay}")
    private long initialDelay;

    @Value("${scheduled.task.cron}")
    private String cron;

    @Scheduled(fixedRateString = "${scheduled.task.fixedRate}")
    public void runTaskAtFixedRate() {
        logger.info("Fixed rate task - {}", System.currentTimeMillis());
    }

    @Scheduled(fixedDelayString = "${scheduled.task.fixedDelay}")
    public void runTaskAtFixedDelay() {
        logger.info("Fixed delay task - {}", System.currentTimeMillis());
    }

    @Scheduled(initialDelayString = "${scheduled.task.initialDelay}", fixedRateString = "${scheduled.task.fixedRate}")
    public void runTaskWithInitialDelay() {
        logger.info("Task with initial delay - {}", System.currentTimeMillis());
    }

    @Scheduled(cron = "${scheduled.task.cron}")
    public void runTaskAtNoon() {
        logger.info("Noon task - {}", System.currentTimeMillis());
    }
}