SpringBoot+Quartz job实现定时任务（1）基础知识及快速实现

spring boot + quartz job实现定时任务(1) 基础知识及快速实现

（1）什么是Quartz?
（2）Quartz的特点；
（3）Quartz专用词汇说明；
（4）Quartz任务调度的两种实现方法；

接下来看下具体的内容：

（1）什么是Quartz?

Quartz是一个完全由Java编写的开源作业调度框架，为在Java应用程序中进行作业调度提供了简单却强大的机制。Quartz允许开发人员根据时间间隔来调度作业。它实现了作业和触发器的多对多的关系，还能把多个作业与不同的触发器关联。简单地创建一个org.quarz.Job接口的Java类。

（2）Quartz的特点；

作为一个优秀的开源调度框架，Quartz 具有以下特点：

① 强大的调度功能，例如支持丰富多样的调度方法，可以满足各种常规及特殊需求；

② 灵活的应用方式，例如支持任务和调度的多种组合方式，支持调度数据的多种存储方式；

③ 分布式和集群能力，Terracotta 收购后在原来功能基础上作了进一步提升。

④ Quartz 很容易与 Spring 集成实现灵活可配置的调度功能。

（3）Quartz专用词汇说明；

下面是本文中用到的一些专用词汇，在此声明：

scheduler:

任务调度器

trigger:

触发器，用于定义任务调度时间规则

job:

任务，即被调度的任务

misfire:

错过的，指本来应该被执行但实际没有被执行的任务调度

（4）Quartz任务调度的两种实现方法

4.1注解实现任务调度

注解实现任务调度理解和实现起来都非常方便，如果在实际应用中没有复杂的业务场景可以使用注解来实现任务调度。

注解实现业务调度分为两步：

1.创建业务调度类，并添加@Component、@EnableScheduling注解。

2.创建业务调度任务，并添加@Scheduled注解来设置触发间隔。

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

import java.util.Date;

@Component
@EnableScheduling
public class AnnotationCompleteJob {
    //[秒] [分] [小时] [日] [月] [周]
    @Scheduled(cron = "0/2 * * * * ?")
    public void work() throws Exception{
        System.out.println("执行任务调度"+ new Date());
    }

    @Scheduled(cron = "0 0/1 * * * ?")
    public void second(){
        System.out.println("每分钟执行一次"+new Date());
    }

    @Scheduled(fixedRate = 5000)//每5秒执行一次
    public void play() throws Exception {
        System.out.println("每5秒执行Quartz定时器任务："+new Date());
    }

}

项目运行后，@Scheduled注解的方法会随项目启动，按照设定好的间隔立即执行任务，如果需要项目开启间隔一段时间运行可以在@Scheduled括号里添加参数initialDelay，initialDelay表示首次延迟多长时间后执行,单位ms。

不过在实验过程中发现，initialDelay不能与cron表达式同时使用。

4.2创建对象实现任务调度

Quartz 任务调度的核心元素是 scheduler, trigger 和 job，其中 trigger 和 job 是任务调度的元数据，scheduler 是实际执行调度的控制器。

在 Quartz 中，trigger 是用于定义调度时间的元素，即按照什么时间规则去执行任务。Quartz 中主要提供了四种类型的 trigger：SimpleTrigger，CronTirgger，DateIntervalTrigger，和 NthIncludedDayTrigger。这四种 trigger 可以满足企业应用中的绝大部分需求。

在 Quartz 中，job 用于表示被调度的任务。主要有两种类型的 job：无状态的（stateless）和有状态的（stateful）。对于同一个 trigger 来说，有状态的 job 不能被并行执行，只有上一次触发的任务被执行完之后，才能触发下一次执行。

Job 主要有两种属性：volatility 和 durability，其中 volatility 表示任务是否被持久化到数据库存储，而 durability 表示在没有 trigger 关联的时候任务是否被保留。两者都是在值为 true 的时候任务被持久化或保留。一个 job 可以被多个 trigger 关联，但是一个 trigger 只能关联一个 job。

在 Quartz 中， scheduler 由 scheduler 工厂创建：DirectSchedulerFactory 或者 StdSchedulerFactory。 第二种工厂 StdSchedulerFactory 使用较多，因为 DirectSchedulerFactory 使用起来不够方便，需要作许多详细的手工编码设置。 Scheduler 主要有三种：RemoteMBeanScheduler， RemoteScheduler 和 StdScheduler。本文以最常用的 StdScheduler 为例讲解。这也是笔者在项目中所使用的 scheduler 类。

这一篇文章，我们紧接着上一篇的文章，讲讲在Quartz在java project的项目中如何进行使用，在这里我们使用maven进行构建项目。先看下本章的大纲：

（1）新建工程quartz-java;
（2）配置pom.xml文件；
（3）编码说明；
（4）编写Job类；
（5）编写启动类进行代码测试；
（6）quartz.properties配置文件说明；

   接下里一起看下具体的内容：

（1）新建工程quartz-java;

   新建一个java project取名为quartz-java。

（2）配置pom.xml文件；

   在pom.xml文件中添加quartz的依赖：

<dependency>

            <groupId>org.quartz-scheduler</groupId>

            <artifactId>quartz</artifactId>

            <version>2.2.3</version>

</dependency>

（3）编码说明；

（一）首先我们需要定义一个任务类，比如为HelloJob ，该类需要继承Job类，然后添加execute(JobExecutionContext context)方法，在这个方法中就是我们具体的任务执行的地方。

（二）在哪里定义“在什么时候执行什么任务呢？”：那么我们需要Scheduler，此类的创建方式使用Quartz提供的工厂类StdSchedulerFactory.getDefaultScheduler()进行创建。

（三）如何触发呢：scheduler.scheduleJob(jobDetail,trigger);进行触发定时任务，在这里需要两个参数。jobDetail可以通过JobBuilder.newJob进行创建，在这里就需要制定一个Job类了，也就是我们第一步创建的HelloJob；trigger类的话，可以通过TriggerBuilder.newTrigger进行创建。

（4）编写Job类；

编写HelloJob任务类：

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

import java.util.Date;

public class HelloJob implements Job {

    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("Hello World! quartz job"+new Date());
    }
}

（5）编写启动类进行代码测试；

在Main方法中进行编码测试：

import com.sample.quartzjob.demo1.job.HelloJob;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;

import java.util.concurrent.TimeUnit;

public class App {
    public static void main(String[] args) throws SchedulerException, InterruptedException {
        //获取schduler实例
        Scheduler defaultScheduler = StdSchedulerFactory.getDefaultScheduler();
        defaultScheduler.start();
        System.out.println("scheduler start");

        //具体任务
        JobDetail jobDetail = JobBuilder.newJob(HelloJob.class).withIdentity("job1", "group1").build();

        //触发时间点
        SimpleScheduleBuilder simpleScheduleBuilder = SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(5).repeatForever();

        Trigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "group1").startNow().withSchedule(simpleScheduleBuilder).build();

        //交由schduler安排触发
        defaultScheduler.scheduleJob(jobDetail,trigger);

        //睡眠20s
        TimeUnit.SECONDS.sleep(20);
        defaultScheduler.shutdown();
        System.out.println("scheduler shut down");
    }
}

代码源码：
gitee
参考文献：

@Scheduled使用及讲解

SpringBoot整合Quartz定时任务 的简单实例

SpringBoot整合Quartz定时任务 的简单实例 2