Quartz实现定时任务

以你之姓@ 2023-02-21 06:18 45阅读 0赞

# 前言 #

一般在项目中，除非定时任务涉及到的业务实在是太简单，使用@Scheduled 注解来解决定时任务，否则大部分情况可能都是使用Quartz来做定时任务。在Spring Boot中使用Quartz ，只需要在创建项目时，添加Quartz依赖即可：

# 创建项目 #

创建一个Spring Boot项目，选择Quartz依赖

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BlbmdqdW5sZWU_size_16_color_FFFFFF_t_70][]

## 开启定时任务 ##

项目创建完成后，也要添加开启定时任务的注解

@SpringBootApplication
    @EnableScheduling
    public class QuartzApplication {
        public static void main(String[] args) {
            SpringApplication.run(QuartzApplication.class, args);
        }
    
    }

# 实现定时任务 #

Quartz 在使用过程中，有两个关键概念，一个是JobDetail（要做的事情），另一个是触发器（什么时候做），要定义 JobDetail，需要先定义 Job，Job 的定义有两种方式：

## 直接定义一个Bean ##

@Component
    public class MyJob1 {
        public void sayHello() {
            System.out.println("MyJob1>>>"+new Date());
        }
    }

关于这种定义方式说两点：  
1.首先将这个 Job 注册到 Spring 容器中。  
2.这种定义方式有一个缺陷，就是无法传参。

## 继承 QuartzJobBean ##

public class MyJob2 extends QuartzJobBean {
        HelloService helloService;
        public HelloService getHelloService() {
            return helloService;
        }
        public void setHelloService(HelloService helloService) {
            this.helloService = helloService;
        }
        @Override
        protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
            helloService.sayHello();
        }
    }

和第1种方式相比，这种方式支持传参，任务启动时，executeInternal 方法将会被执行。  
Job 有了之后，接下来创建类QuartzConfig，配置 JobDetail 和 Trigger 触发器

## QuartzConfig ##

package com.yjn.quartz;
    
    import org.quartz.JobDataMap;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.scheduling.quartz.*;
    
    import java.util.Date;
    
    @Configuration
    public class QuartzConfig {
        @Bean
        MethodInvokingJobDetailFactoryBean methodInvokingJobDetailFactoryBean() {
            MethodInvokingJobDetailFactoryBean bean = new MethodInvokingJobDetailFactoryBean();
            bean.setTargetBeanName("myJob1");
            bean.setTargetMethod("sayHello");
            return bean;
        }
        @Bean
        JobDetailFactoryBean jobDetailFactoryBean() {
            JobDetailFactoryBean bean = new JobDetailFactoryBean();
            bean.setJobClass(MyJob2.class);
            JobDataMap map = new JobDataMap();
            map.put("helloService", helloService());
            bean.setJobDataMap(map);
            return bean;
        }
        @Bean
        SimpleTriggerFactoryBean simpleTriggerFactoryBean() {
            SimpleTriggerFactoryBean bean = new SimpleTriggerFactoryBean();
            bean.setStartTime(new Date());
            bean.setRepeatCount(5);
            bean.setJobDetail(methodInvokingJobDetailFactoryBean().getObject());
            bean.setRepeatInterval(3000);
            return bean;
        }
        @Bean
        CronTriggerFactoryBean cronTrigger() {
            CronTriggerFactoryBean bean = new CronTriggerFactoryBean();
            bean.setCronExpression("0/10 * * * * ?");
            bean.setJobDetail(jobDetailFactoryBean().getObject());
            return bean;
        }
        @Bean
        SchedulerFactoryBean schedulerFactoryBean() {
            SchedulerFactoryBean bean = new SchedulerFactoryBean();
            bean.setTriggers(cronTrigger().getObject(), simpleTriggerFactoryBean().getObject());
            return bean;
        }
        @Bean
        HelloService helloService() {
            return new HelloService();
        }
    }

关于这个配置说如下几点：

*  JobDetail 的配置有两种方式：MethodInvokingJobDetailFactoryBean 和 JobDetailFactoryBean
 *  使用 MethodInvokingJobDetailFactoryBean 可以配置目标 Bean 的名字和目标方法的名字，这种方式不支持传参
 *  使用 JobDetailFactoryBean 可以配置 JobDetail ，任务类继承自 QuartzJobBean ，这种方式支持传参，将参数封装在 JobDataMap 中进行传递
 *  Trigger 是指触发器，Quartz 中定义了多个触发器，这里向大家展示其中两种的用法，SimpleTrigger 和 CronTrigger
 *  SimpleTrigger 有点类似于前面说的 @Scheduled 的基本用法
 *  CronTrigger 则有点类似于 @Scheduled 中 cron 表达式的用法

## 测试 ##

## 启动项目 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BlbmdqdW5sZWU_size_16_color_FFFFFF_t_70 1][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BlbmdqdW5sZWU_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200629091958248.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BlbmdqdW5sZWU=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BlbmdqdW5sZWU_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200629092242112.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BlbmdqdW5sZWU=,size_16,color_FFFFFF,t_70