Springboot实现定时任务的多种方式
作者:mmseoamin日期:2023-12-20

No nonsense

一. 使用@Scheduled注解

@Component
public class MyScheduledTask {
    
    //每天凌晨0点0分0秒时触发执行
    @Scheduled(cron = "0 0 0 * * ?") 
    public void Timing() {
        // 执行定时任务业务逻辑
    }
}

解释:

  1. @Component注解是Spring框架中被用于声明一个Bean的注解, 被该注解修饰的类将被Spring自动扫描到, 并注册为一个Bean, 该注解通常与其他注解(如@Service,@Repository,@Controller)一起使用,用于将类标记为特定类型的组件。
  2. @Scheduled注解用于指定方法或者类的某个方法为定时任务, 它可以使用cron表达式或者固定的时延来定义任务的执行时间。
  3. cron表达式是一种用于定义定时任务执行时间的字符串格式, 它包含六个或七个部分, 分别表示秒, 分, 小时, 日期, 月份, 星期和年份(可选)用空格将这些部分 分隔开,具体每个部分的取值范围和特殊符号含义请参考cron表达式的相关文档。
  4. "0 0 0 * * ?"是一个cron表达式的例子,它表示每天的凌晨0点0分0秒触发任务执行。
  5. 所以当将@Component和@Scheduled注解一起使用时, 被@Component注解修饰的类将会被Spring识别为一个组件, 并包含一个定时任务方法, 该方法将在每天凌晨0点0分0秒时触发执行。

二. 使用SchedulingConfigurer接口

@Configuration
@EnableScheduling
public class MyScheduledTask implements SchedulingConfigurer {
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        taskRegistrar.addCronTask(() -> {
            // 执行任务逻辑
        }, "0 0 0 * * ?");
    }
}

解释:

  1. 通过实现SchedulingConfigurer接口,重写configureTasks方法,可以配置多个定时任务,并指定其执行时间

  2. 在Spring Boot中,我们需要创建一个类,并使用@Configuration注解进行标注。然后,我们需要实现SchedulingConfigurer接口, 并实现其中的configureTasks方法, 在configureTasks方法中, 我们可以使用ScheduledTaskRegistrar对象来添加一个或多个定时任务,并指定其执行时间。

  3. 让我们逐一解释各个部分的作用:

    (1) @Configuration注解:这是一个Spring框架的注解,用于标注配置类。通过将一个类标记为@Configuration,Spring会将其识别为一个配置类,并在运行时加载这个类中定义的Bean定义和组件。

    (2) @EnableScheduling注解:这是一个Spring框架的注解,用于在Spring应用程序中启用定时任务功能。通过在配置类上添加@EnableScheduling注解,Spring会自动检测标记有@Scheduled注解的方法,并在指定时间触发这些方法的执行。

    (3) SchedulingConfigurer接口:这是Spring框架提供的一个接口,用于配置定时任务。通过实现该接口,并重写其中的configureTasks方法,我们可以在应用程序的启动过程中,自定义配置定时任务的执行时间和逻辑。

    (4) configureTasks方法:这是SchedulingConfigurer接口中的一个方法,用于配置定时任务。通过使用参数类型为ScheduledTaskRegistrar的ScheduledTaskRegistrar对象,我们可以在该方法中添加定时任务并设置其执行时间。

  4. 在configureTasks方法中, ScheduledTaskRegistrar对象提供了一系列的方法用于配置定时任务:

    (1) addCronTask:添加一个基于cron表达式的定时任务。

    (1) addFixedDelayTask:添加一个固定延迟时间的定时任务。

    (1) addFixedRateTask:添加一个固定速率的定时任务。

    (1) addTriggerTask:添加一个基于Trigger的定时任务。

三. 使用@EnableScheduling注解和@Scheduled注解结合

@Configuration
@EnableScheduling
public class MyScheduledTask {
    @Scheduled(cron = "0 0 0 * * ?") // 每天凌晨执行
    public void executeTask() {
        // 执行任务逻辑
    }
}

解释:

  1. 使用@EnableScheduling注解和@Scheduled注解结合, 在配置类上添加@EnableScheduling注解,表示启用定时任务功能,在需要执行定时任务的方法上添加@Scheduled注解,定义任务的执行时间。
  2. 关于@Configuration @EnableScheduling @Scheduled(cron = “0 0 0 * * ?”)上面有介绍。

四. 使用@Async注解和ThreadPoolTaskScheduler实现定时任务的异步执行

@Configuration
@EnableAsync
public class MyScheduledTask {
    @Async
    @Scheduled(cron = "0 0 0 * * ?") // 每天凌晨执行
    public void executeTask() {
        // 执行任务逻辑
    }
    @Bean
    public ThreadPoolTaskScheduler taskScheduler() {
        ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();
        scheduler.setPoolSize(10);
        return scheduler;
    }
}

解释:

  1. 使用@Async注解和ThreadPoolTaskScheduler, 通过在定时任务方法上添加@Async注解,同时配合使用ThreadPoolTaskScheduler来配置线程池,实现定时任务的异步执行。
  2. 在这种方式中,我们首先需要在配置类上添加@EnableAsync注解,用于启用异步任务的功能。
  3. 然后,我们需要在定时任务方法上添加@Async注解,表示该方法是一个异步任务。
  4. @Async注解告诉Spring,在调用该方法时应该创建一个新的线程来执行该方法,并立即返回。
  5. 为了配置线程池以供异步任务使用,我们需要在配置类中创建一个名为taskScheduler的ThreadPoolTaskScheduler的Bean,并进行相应的配置。ThreadPoolTaskScheduler是Spring提供的一个线程池调度器,用于执行异步任务。