SpringBoot开启定时任务

执于代码

于 2024-05-03 11:06:26 发布

阅读量830

点赞数 25

本文链接：https://blog.csdn.net/xiamaocheng/article/details/138411955

版权

spring boot 专栏收录该内容

74 篇文章 0 订阅

订阅专栏

SpringBoot开启定时任务

目录
参考资料和推荐阅读

Survive by day and develop by night.
talk for import biz , show your perfect code,full busy，skip hardness,make a better result,wait for change,challenge Survive.
happy for hardess to solve denpendies.

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.stereotype.Component;

@Component
public class MyJob implements Job {

    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("定时任务执行中...");
    }
}

配置定时任务：在application.properties或application.yml配置文件中添加相关的定时任务配置。

# 定时任务配置
spring.quartz.job-store-type=jdbc # 使用数据库存储定时任务
spring.quartz.jdbc.initialize-schema=always # 启动时自动初始化数据库表
spring.quartz.properties.org.quartz.threadPool.threadCount=10 # 定时任务线程池大小

启动定时任务：使用@EnableScheduling注解启用定时任务，这样Spring Boot会自动扫描并启动所有带有@Scheduled注解的定时任务。

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);
    }
}

配置定时任务触发器：在需要执行定时任务的方法上添加@Scheduled注解，并指定触发任务的时间表达式。

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

@Component
public class MyJob {

    @Scheduled(cron = "0 0/5 * * * ?") // 每5分钟触发一次
    public void execute() {
        System.out.println("定时任务执行中...");
    }
}

通过以上步骤，就可以实现Spring Boot整合定时任务。在定时任务的执行过程中，可以使用Quartz提供的丰富功能来管理、调度和监控定时任务。

5.源码分析

Spring Boot 提供了一种简单的方式来创建和管理定时任务。在Spring Boot中，我们可以通过使用@EnableScheduling注解来开启定时任务的支持，并通过@Scheduled注解来定义具体的定时任务。

下面是一个示例的Spring Boot整合定时任务的源码分析：

首先，我们需要在启动类上添加@EnableScheduling注解来开启定时任务的支持。这样，Spring Boot就会自动扫描并创建定时任务。

@SpringBootApplication
@EnableScheduling
public class Application {

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

接下来，我们可以在任意的Spring组件中定义定时任务。只需要在方法上添加@Scheduled注解，并指定定时任务的执行时间。

@Component
public class MyTask {

    // 每隔5秒执行一次
    @Scheduled(fixedRate = 5000)
    public void myTask() {
        System.out.println("定时任务执行中...");
    }
}

在上面的例子中，我们定义了一个名为myTask的定时任务方法。通过设置fixedRate参数为5000，表示定时任务每隔5秒执行一次。

最后，在启动应用程序后，定时任务就会自动执行。我们可以在控制台上看到定时任务的执行结果。

总结一下，整合定时任务的过程主要包括以下几个步骤：

在启动类上添加@EnableScheduling注解来开启定时任务的支持。
在任意的Spring组件中定义定时任务的方法，通过@Scheduled注解指定定时任务的执行时间。
启动应用程序，定时任务就会自动执行。

以上就是Spring Boot整合定时任务的源码分析。通过使用@EnableScheduling和@Scheduled注解，我们可以很方便地创建和管理定时任务。

@EnableScheduling是一个用于开启Spring的定时任务功能的注解。它可以放在Spring Boot应用的主类上，以启用定时任务的功能。

@Scheduled注解用于将方法标记为一个定时任务，并指定定时任务的执行规则。它可以放在类的方法上，用于指定方法的执行时间和频率。

@Scheduled注解有多个可选参数，包括cron、fixedDelay、fixedRate、initialDelay等。这些参数可以根据需求来设置定时任务的执行规则。

例如，使用@Scheduled(cron = “0 0 0 * * ?”)注解可以将某个方法指定为每天凌晨0点执行的定时任务。

需要注意的是，@EnableScheduling注解必须在Spring应用的主类上添加，才能启用定时任务的功能。而@Scheduled注解则可以放在任意Spring组件的方法上，用于指定定时任务的执行规则。

@EnableScheduling和@Scheduled是Spring框架中用于支持定时任务的注解。

@EnableScheduling注解是一个启用定时任务的注解，通常与@Configuration注解一起使用。它会启用Spring的任务执行器，并扫描应用中带有@Scheduled注解的方法。

@Scheduled注解用于标注一个方法是一个定时任务执行方法。它可以接受多种参数来配置定时任务的执行规则，如cron表达式、fixed rate、fixed delay等。

下面是对这两个注解的源码分析：

@EnableScheduling注解的源码如下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(SchedulingConfiguration.class)
public @interface EnableScheduling {
}

从源码可以看出，@EnableScheduling注解是一个元注解，它被@Import注解修饰，并引入了SchedulingConfiguration类。

SchedulingConfiguration类的源码如下：

@Configuration
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
public class SchedulingConfiguration {

    @Bean(TriggerTaskRegistrar.BEAN_NAME)
    @Role(BeanDefinition.ROLE_INFRASTRUCTURE)
    public TriggerTaskRegistrar taskRegistrar(ScheduledTaskRegistrar taskRegistrar) {
        return new TriggerTaskRegistrar(taskRegistrar);
    }

    @Bean
    @Role(BeanDefinition.ROLE_INFRASTRUCTURE)
    public ScheduledAnnotationBeanPostProcessor scheduledAnnotationProcessor() {
        return new ScheduledAnnotationBeanPostProcessor();
    }
}

从源码可以看出，SchedulingConfiguration类被@Configuration注解修饰，它定义了两个Bean：

taskRegistrar：通过ScheduledTaskRegistrar类创建一个TriggerTaskRegistrar对象。TriggerTaskRegistrar是用于注册和管理定时任务的对象。
scheduledAnnotationProcessor：创建一个ScheduledAnnotationBeanPostProcessor对象，用来处理带有@Scheduled注解的方法。

@Scheduled注解的源码如下：

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Scheduled {

    String CRON_DISABLED = "-";

    String cron() default "";

    String zone() default "";

    long fixedDelay() default -1;

    String fixedDelayString() default "";

    long fixedRate() default -1;

    String fixedRateString() default "";

    long initialDelay() default -1;

    String initialDelayString() default "";
}