SpringBoot定时任务

在 Spring Boot 中，定时任务是一种常见的需求，它允许我们按照预定的时间间隔或固定时间点执行特定的任务。下面将详细介绍 @Scheduled 注解的使用、定时任务的配置与调度以及动态定时任务的实现。

1. @Scheduled 注解的使用

@Scheduled 是 Spring 框架提供的一个注解，用于标记一个方法为定时任务方法。该注解可以指定任务的执行时间规则，有以下几种常用的方式：

示例代码

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

@Component
public class ScheduledTasks {

    // 固定延迟，上一次任务执行结束后，延迟 5 秒再执行下一次任务
    @Scheduled(fixedDelay = 5000)
    public void fixedDelayTask() {
        System.out.println("Fixed delay task executed at: " + System.currentTimeMillis());
    }

    // 固定速率，每隔 3 秒执行一次任务，无论上一次任务是否执行完毕
    @Scheduled(fixedRate = 3000)
    public void fixedRateTask() {
        System.out.println("Fixed rate task executed at: " + System.currentTimeMillis());
    }

    // 使用 Cron 表达式，每天凌晨 2 点执行任务
    @Scheduled(cron = "0 0 2 * * ?")
    public void cronTask() {
        System.out.println("Cron task executed at: " + System.currentTimeMillis());
    }
}

代码解释

• @Component：将该类标记为 Spring 组件，以便 Spring 能够自动扫描并管理该类。
• @Scheduled：用于标记定时任务方法。
  • fixedDelay：上一次任务执行结束后，延迟指定的毫秒数再执行下一次任务。
  • fixedRate：每隔指定的毫秒数执行一次任务，无论上一次任务是否执行完毕。
  • cron：使用 Cron 表达式指定任务的执行时间规则。

2. 定时任务的配置与调度

要启用 Spring Boot 的定时任务功能，需要在主应用类上添加 @EnableScheduling 注解。

示例代码

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

@SpringBootApplication
@EnableScheduling
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

代码解释

• @EnableScheduling：启用 Spring Boot 的定时任务功能，使得 @Scheduled 注解生效。

3. 动态定时任务的实现

动态定时任务允许我们在运行时修改任务的执行时间规则。实现动态定时任务的关键是使用 ScheduledTaskRegistrar 类。

示例代码

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;

import java.util.concurrent.Executor;
import java.util.concurrent.Executors;

@Configuration
@EnableScheduling
public class DynamicScheduledConfig implements SchedulingConfigurer {

    private String cronExpression = "0/5 * * * * ?"; // 初始 Cron 表达式，每 5 秒执行一次

    public void setCronExpression(String cronExpression) {
        this.cronExpression = cronExpression;
    }

    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        taskRegistrar.setScheduler(taskScheduler());
        taskRegistrar.addCronTask(() -> {
            System.out.println("Dynamic task executed at: " + System.currentTimeMillis());
        }, () -> cronExpression);
    }

    @Bean(destroyMethod="shutdown")
    public Executor taskScheduler() {
        return Executors.newScheduledThreadPool(1);
    }
}

代码解释

• DynamicScheduledConfig 类实现了 SchedulingConfigurer 接口，用于配置定时任务。
• cronExpression：用于存储任务的 Cron 表达式。
• setCronExpression 方法：用于动态修改任务的 Cron 表达式。
• configureTasks 方法：在该方法中配置定时任务，使用 addCronTask 方法添加一个动态的 Cron 任务。
• taskScheduler 方法：创建一个线程池，用于执行定时任务。

使用示例

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class DynamicScheduledController {

    @Autowired
    private DynamicScheduledConfig dynamicScheduledConfig;

    @GetMapping("/changeCron")
    public String changeCron(@RequestParam String cron) {
        dynamicScheduledConfig.setCronExpression(cron);
        return "Cron expression changed to: " + cron;
    }
}

代码解释

• DynamicScheduledController 类是一个 RESTful 控制器，提供了一个 /changeCron 接口，用于动态修改任务的 Cron 表达式。

通过以上步骤，我们可以在 Spring Boot 中使用 @Scheduled 注解创建定时任务，配置定时任务的调度，并实现动态定时任务。