Springboot实现定时任务的4种方式举例详解

一. 使用@Scheduled注解

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

解释:

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

解释:

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

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

• 让我们逐一解释各个部分的作用:
  (1) @Configuration注解：这是一个Spring框架的注解，用于标注配置类。通过将一个类标记为@Configuration，Spring会将其识别为一个配置类，并在运行时加载这个类中定义的Bean定义和组件。

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

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

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

• 在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() {
        // 执行任务逻辑
    }
}

解释:

• 使用@EnableScheduling注解和@Scheduled注解结合, 在配置类上添加@EnableScheduling注解，表示启用定时任务功能，在需要执行定时任务的方法上添加@Scheduled注解，定义任务的执行时间。
• 关于@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;
    }
}

解释:

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

拓展：@Scheduled的参数

（1）：cron：

[秒] [分] [小时] [日] [月] [周] [年]

@Scheduled(cron = "*/5 * * * * ?")
public void test(){}

每隔5秒执行一次：*/5 * * * * ?

每隔1分钟执行一次：0 */1 * * * ?

每天23点执行一次：0 0 23 * * ?

每天凌晨1点执行一次：0 0 1 * * ?

每月1号凌晨1点执行一次：0 0 1 1 * ?

每月最后一天23点执行一次：0 0 23 L * ?

每周星期六凌晨1点实行一次：0 0 1 ? * L

在26分、29分、33分执行一次：0 26,29,33 * * * ?

每天的0点、13点、18点、21点都执行一次：0 0 0,13,18,21 * * ?

• *：表示所有值。 例如:在分的字段上设置 *,表示每一分钟都会触发。
• ?：表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作，但不关心是周几，所以需要周位置的那个字段设置为”?” 具体设置为 0 0 0 10 * ?
• -：表示区间。例如 在小时上设置 “10-12”,表示 10,11,12点都会触发。
• ,： 表示指定多个值，例如在周字段上设置 “MON,WED,FRI” 表示周一，周三和周五触发
• /：用于递增触发。如在秒上面设置”5/15” 表示从5秒开始，每增15秒触发(5,20,35,50)。 在月字段上设置’1/3’所示每月1号开始，每隔三天触发一次。

通配符说明可以去查询相关资料

cron还支持占位符：

@Scheduled(cron = "${time.cron}")
public void test(){}

（2） fixedDelay：上一次执行完毕时间点之后多长时间再执行。

@Scheduled(fixedDelay = 5000) //上一次执行完毕时间点之后5秒再执行
public void test(){}

（3） fixedDelayString：与 fixedDelay 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。

@Scheduled(fixedDelayString = "5000") //上一次执行完毕时间点之后5秒再执行
public void test(){}

@Scheduled(fixedDelayString = "${time.fixedDelayString}") //上一次执行完毕时间点之后5秒再执行
public void test(){}

（4） fixedRate：上一次开始执行时间点之后多长时间再执行。

@Scheduled(fixedRate = 5000) //上一次开始执行时间点之后5秒再执行
public void test(){}

（5） fixedRateString：与 fixedRate 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。

@Scheduled(fixedRateString = "${time.fixedRateString}") //上一次开始执行时间点之后5秒再执行
public void test(){}

（6） initialDelay：第一次延迟多长时间后再执行。

@Scheduled(initialDelay = 1000, fixedRate = 5000) //第一次延迟1秒后执行，之后按fixedRate的规则每5秒执行一次
public void test(){}

（6） initialDelayString：与 initialDelay 意思相同，只是使用字符串的形式。唯一不同的是支持占位符。

@Scheduled(initialDelayString = "${time.initialDelayString}", fixedRate = 5000) //第一次延迟1秒后执行，之后按fixedRate的规则每5秒执行一次
public void test(){}

总结 

到此这篇关于Springboot实现定时任务的4种方式的文章就介绍到这了,更多相关Springboot实现定时任务内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

最新评论