springboot结合quartz框架完成定时任务开发（注解+xml）

Quartz简介

Quartz是OpenSymphony开源组织在Job scheduling领域又一个开源项目，它可以与J2EE与J2SE应用程序相结合也可以单独使用。Quartz可以用来创建简单或为运行十个，百个，甚至是好几万个Jobs这样复杂的程序。Jobs可以做成标准的Java组件或 EJBs。

核心组件

• 调度器：Scheduler。
• 任务：JobDetail。
• 触发器：Trigger，包括 SimpleTrigger 和 CronTrigger。

（1）Job（任务）：是一个接口，有一个方法 void execute(JobExecutionContext context) ，可以通过实现该接口来定义需要执行的任务（具体的逻辑代码）。

结合项目：目测通过实现该接口并重写execute方法来对原有业务逻辑进行抽取。以此实现对应代码逻辑的定时执行

JobDetail：Quartz每次执行Job时，都重新创建一个Job实例，会接收一个Job实现类，以便运行的时候通过newInstance()的反射调用机制去实例化Job。JobDetail是用来描述Job实现类以及相关静态信息，比如任务在scheduler中的组名等信息。

（2）Trigger（触发器）：描述触发Job执行的时间触发规则实现类SimpleTrigger和CronTrigger可以通过crom表达式定义出各种复杂的调度方案。

结合项目：设置触发条件。比如每天执行一次（通过cron表达式进行条件配置）

Calendar：是一些日历特定时间的集合。一个Trigger可以和多个 calendar关联，比如每周一早上10:00执行任务，法定假日不执行，则可以通过calendar进行定点排除。

常用示例：

（3）Scheduler（调度器）：代表一个Quartz的独立运行容器。Trigger和JobDetail可以注册到Scheduler中。Scheduler可以将Trigger绑定到某一JobDetail上，这样当Trigger被触发时，对应的Job就会执行。一个Job可以对应多个Trigger，但一个Trigger只能对应一个Job。

调度器是quartz的核心，quartz通过这个容器来实现触发器和任务的绑定以及执行。

创作初衷

网上quartz的教程大多要么只有配置类开发，要么只有注解开发，对于新手很不友好，学习起来十分复杂。笔者力求一篇文章入门quartz的两种开发模式，满足不同情况下的开发要求。

配置类注解开发

导入坐标

注意：boot的版本不同，引入Quartz的方法有所区别（maven下）

2.0以上的boot

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-quartz</artifactId>
</dependency>

1.5.x的boot

<dependency>
  <groupId>org.quartz-scheduler</groupId>
  <artifactId>quartz</artifactId>
  <version>2.3.0</version>
</dependency>
<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-context-support</artifactId>
</dependency>

第一个定时任务

一定要注意类的继承和方法的重写。这是个Job类，是最核心的部分，将来定时执行的任务就是job类中的方法。

@Component
public class TestQuartz extends QuartzJobBean {

    private final Logger logger = LoggerFactory.getLogger(TestQuartz.class);

    /**
     * 与thread的run方法类似，定时任务的具体实现写在这个方法中，
     * 每创建一个新的定时任务，都需要新建一个Java类并继承QuartzJobBean、实现executeInternal()。
     * @param jobExecutionContext
     * @throws JobExecutionException
     */
    @Override
    protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        try {
            //具体任务
            System.out.println("Quartz task is running at" + new Date());
        } catch (Exception e) {
            //任务失败进行日志记录
            logger.error("定时任务执行失败！error:{}",e.getMessage());
        }
    }
}

这是配置类，使用@Configuration启用注解

@Configuration
public class QuartzConfig
{
    /**
     * 定时任务1：
     * 同步用户信息Job（任务详情）
     */
    @Bean
    public JobDetail syncUserJobDetail()
    {
        JobDetail jobDetail = JobBuilder.newJob(SyncUserJob.class)
                .withIdentity("syncUserJobDetail") //给JobDetail起个名字
                .storeDurably() //即使没有Trigger关联时，也不需要删除该JobDetail
                .build();
        return jobDetail;
    }
 
    /**
     * 定时任务1：
     * 同步用户信息Job（触发器）
     */
    @Bean
    public Trigger syncUserJobTrigger()
    {
        //每隔5秒执行一次
        CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule("0/5 * * * * ?");
 
        //创建触发器
        Trigger trigger = TriggerBuilder.newTrigger()
                .forJob(syncUserJobDetail())//关联上述的JobDetail
                .withIdentity("syncUserJobTrigger")//给Trigger起个名字
                .withSchedule(cronScheduleBuilder)
                .build();
        return trigger;
    }
}

quartz定时任务的实现是通过job——jobdetail——trigger层层绑定，最后通过触发器trigger的定时启动逻辑来定时启动job类内部的代码逻辑。

XML配置文件开发

boot主类

非常简单，就默认的那一句话。
但是需要注意的是，需要额外加上@ImportResource注解，用于加载quartz配置文件

@SpringBootApplication
@ImportResource("applicationContext-quartz.xml")
public class SpringbootQuartzDemoApplication
{
    public static void main(String[] args)
    {
        SpringApplication.run(SpringbootQuartzDemoApplication.class, args);
    }
}

job类

@Service
public class SyncUserJob
{
    public void fun() {
        try {
            //具体任务
            System.out.println("fun执行，当前时间" + new Date());
        } catch (Exception e) {
            //任务失败进行日志记录
            System.out.println("执行失败！");
        }
    }
}

在这里我们加上@Service注解，如果我们不加注解的话，就需要在我们的这个quartz配置文件中将对应的bean配置进来，如果我们在这里（xml手动配置）配置，这个id就必须和targetObject的ref保持一致。如果我们不在这里配置，我们的argetObject的ref的取值就必须和我们的Job类的取名保持一致，只需要首字母改成小写即可。

重头戏：applicationContext-quartz.xml配置文件编写

所有的注意事项都在xml的注释中详细写明，不再另外赘述

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd">

    <!--  配置调度工厂，订制任务列表 -->
    <bean id="springJobSchedulerFactoryBean"
              class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
    <property name="triggers">
        <list>
            <ref bean="cronTrigger"/>
            <!-- <ref bean="cronTrigger2"/> -->
        </list>
    </property>
    </bean>

    <!-- 配置tirgger触发器，和调度工厂中调度的触发器保持名称一致，property的属性名不可更改,都是CronTriggerFactoryBean类的属性 -->
    <bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
        <!-- jobDetail -->
        <property name="jobDetail" ref="springQtzJobMethod"></property>
        <!-- cron表达式，执行时间 每 1 秒钟执行一次 -->
        <property name="cronExpression" value="0 0 1 * * ?"></property>
    </bean>

    <!-- 配置Job类 -->
    <!-- 配置JobDetail -->
    <bean id="springQtzJobMethod" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
        <!-- 执行目标job -->
        <property name="targetObject" ref="quartzJob"></property>
        <!-- 要执行的方法 -->
        <property name="targetMethod" value="run"></property>
        <!--配置为false不允许任务并发执行-->
        <property name="concurrent" value="false"/>
    </bean>
</beans>