SpringBoot项目快速整合Quartz

2024-03-12 22:32:02

1. 依赖引入

在SpringBoot项目中使用Quartz是需要引入相关的依赖信息的。

<!--quartz依赖-->
<dependency>
    <groupId>org.quartz-scheduler</groupId>
    <artifactId>quartz</artifactId>
    <version>2.2.1</version>
  </dependency>
<!--SpringBoot中Scheduled坐标-->
 <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>spring-context-support</artifactId>
 </dependency>
 <!--Spring tx 坐标-->
 <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>spring-tx</artifactId>
 </dependency>

2. 步骤流程

定义任务类实现quertz包的Job接口，并实现其中execute()方法，定义任务内容
定义quertz相关配置类，创建JobDetailFactoryBean、SimpleTriggerFactoryBean、SchedulerFactoryBean对象并使用@Bean注入Spring容器中管理
- 工厂类是SpringBoot提供的，工厂类存在于spring-context-support依赖的org.springframework.scheduling.quartz包中，定义创建相关对象时需要引入相依赖
- JobDetailFactoryBean定义时需要设置定义的任务类
- SimpleTriggerFactoryBean定义时需要传入JobDetailFactoryBean对象并配置触发策略
- SchedulerFactoryBean定义时需要传入SimpleTriggerFactoryBean对象
在启动类上使用@EnableScheduing注解表示开启SpringBoot定时任务
启动服务，定时任务会按照定义策略执行
- 启动服务时可能会报找不到类的错误，此时查看是否引入spring-tx依赖

3. 示例代码

3.1 定义任务类

任务类仍然是要实现Job，并实现其中的execute接口来定义任务内容。

public class DoTaskTest implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        Long startTime = System.currentTimeMillis();
        SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        try {
            Thread.sleep(2000);
            Long endTime = System.currentTimeMillis();
            System.out.println("执行任务，执行时间：" + format.format(new Date(startTime)) + ",耗时:" + (endTime-startTime));
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

3.2 配置类

在SpringBoot中使用时定义的配置类，可以将任务对象、触发器和调度器都交给Spring容器进行管理，在需要时取出来使用。

@Configuration
public class QuartzConfig {
    /**
     * ① 创建Job对象
     */
    @Bean
    public JobDetailFactoryBean jobDetailFactoryBean(){
        JobDetailFactoryBean factoryBean = new JobDetailFactoryBean();
        factoryBean.setJobClass(DoTaskTest.class);
        return factoryBean;
    }

    /**
     * 创建Trigger对象
     */
    @Bean
    public SimpleTriggerFactoryBean simpleTriggerFactoryBean(JobDetailFactoryBean jobDetailFactoryBean){
        SimpleTriggerFactoryBean factoryBean = new SimpleTriggerFactoryBean();
        factoryBean.setJobDetail(jobDetailFactoryBean.getObject());
        factoryBean.setRepeatCount(10);
        factoryBean.setStartDelay(5000);
        factoryBean.setRepeatInterval(2000);
        return factoryBean;
    }

    /**
     * 创建Scheduler对象
     */
    @Bean
    public SchedulerFactoryBean schedulerFactoryBean(SimpleTriggerFactoryBean simpleTriggerFactoryBean){
        SchedulerFactoryBean factoryBean = new SchedulerFactoryBean();
        factoryBean.setTriggers(simpleTriggerFactoryBean.getObject());
        return factoryBean;
    }
}

3.3 启动类

@EnableScheduling注解用来开启定时任务，可以标注在启动类或者Quartz的配置类上。

@SpringBootApplication
@EnableScheduling
public class OctoberApplication {

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

}

4. 总结

在SpringBoot项目中整合Quartz还是比较容易的，这样在项目启动时就会自动执行任务类中的任务。

但是，对于实际的使用场景，定时任务肯定是不止一个的，这种情况下又该如何来定义任务、动态的实现触发器配置以及启停调度器呢。

码农公寓