quartz--定时任务框架【含SpringBoot整合】

什么是quartz

quartz 是一款开源的任务调度库，能够集成于任何的java 应用。quartz就是基于java实现的任务调度框架，用于执行你想要执行的任何任务。

简单理解

1. 首先需要一个要执行的任务接口。比如发送邮件，更新数据等，然后实现这个接口
2. 有了任务之后，还需要一个触发器，触发器的作用是能够让任务去执行，触发器Trigger最基本的功能是指定Job的执行时间，执行间隔，运行次数等。
3. 有了任务和触发器，还需要把他们俩连接起来，即让Trigger去执行指定的Job，这时候就需要一个调度器（Scheduler）

quartz的核心

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

（1）JobDetail：Quartz每次执行Job时，都重新创建一个Job实例，会接收一个Job实现类，以便运行的时候通过newInstance()的反射调用机制去实例化Job。JobDetail是用来描述Job实现类以及相关静态信息，比如任务在scheduler中的组名等信息。
（2）Trigger（触发器）：描述触发Job执行的时间，触发规则，实现类SimpleTrigger和CronTrigger可以通过crom表达式定义出各种复杂的调度方案。
（3）Scheduler（调度器）：Trigger和JobDetail可以注册到Scheduler中。Scheduler可以将Trigger绑定到某一JobDetail上，这样当Trigger被触发时，对应的Job就会执行。一个Job可以对应多个Trigger，但一个Trigger只能对应一个Job。

简单实现的案例

导入依赖

 <dependency>
      <groupId>org.quartz-scheduler</groupId>
      <artifactId>quartz</artifactId>
      <version>2.3.2</version>
</dependency>

新建一个任务。随便打印点东西。模拟业务逻辑

public class TestJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("job执行。。。"+new Date());
    }
}

实现简单的定时任务

public class Test {
    public static void main(String[] args) {
        /*
        * 任务
        * */
        JobDetail jobDetail = JobBuilder.newJob(TestJob.class)
                .withIdentity("job1","group1")
                .build();

        /*
        * 触发器
        * */
        Trigger trigger = TriggerBuilder.newTrigger()
                .withIdentity("trigger1","trigger1")
                .startNow()//立即执行
                .withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(1)//间隔一秒
                        .repeatForever())//重复执行
                .build();

        /*
        * 调度器
        * */
        try {
            Scheduler schedule = StdSchedulerFactory.getDefaultScheduler();
            schedule.scheduleJob(jobDetail,trigger);
            schedule.start();
        } catch (SchedulerException e) {
            e.printStackTrace();
        }
    }
}

然后执行，则会一直打印定义的话。因为设置的是重复执行。

SpringBoot整合quartz

1、首先导入依赖

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

2、定义待执行的Job任务，实现Job接口，在execute中添加自己的业务逻辑

public class MyFirstJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH::mm:ss");
        System.out.println("任务执行......"+sdf.format(new Date()));
    }
}

3、构建调度配置类，创建JobDetail实例，定义Trigger注册到scheduler，启动scheduler开启调度

@Configuration
public class QuartzConfig {

    @Bean
    public JobDetail jobDetail(){
        return JobBuilder.newJob(MyFirstJob.class).storeDurably().build();
    }

    @Bean
    public Trigger trigger1(){
        SimpleScheduleBuilder scheduleBuilder = SimpleScheduleBuilder.simpleSchedule()
                //每秒执行一次
                .withIntervalInSeconds(1)
                //重复执行
                .repeatForever();
        return TriggerBuilder.newTrigger()
                .withIdentity("trigger1","group1")
                .withSchedule(scheduleBuilder)
                .forJob(jobDetail())
                .build();
    }
 }

运行测试。

但是通常情况下，不会这么写，都会使用cron表达式的形式。

@Configuration
public class QuartzConfig {

    @Bean
    public JobDetail jobDetail(){
        return JobBuilder.newJob(MyFirstJob.class).storeDurably().build();
    }
    
    //每五秒执行一次
    @Bean
    public Trigger trigger2(){
        return TriggerBuilder.newTrigger()
                .withIdentity("trigger2","group2")
                .withSchedule(CronScheduleBuilder.cronSchedule("0/5 * * * * ? *"))
                .forJob(jobDetail())
                .build();
    }
}

cron表达式，从左到右分别代表 秒 分 时 日 月 周几
如：每天的11点45分10秒执行，即"10 45 11 * * ?"
cron生成器
常用的表达式如下：

（1）0/2 * * * * ?   表示每2秒 执行任务
（1）0 0/2 * * * ?   表示每2分钟 执行任务
（1）0 0 2 1 * ?   表示在每月的1日的凌晨2点调整任务
（2）0 15 10 ? * MON-FRI   表示周一到周五每天上午10:15执行作业
（3）0 15 10 ? 6L 2002-2006   表示2002-2006年的每个月的最后一个星期五上午10:15执行作
（4）0 0 10,14,16 * * ?   每天上午10点，下午2点，4点
（5）0 0/30 9-17 * * ?   朝九晚五工作时间内每半小时
（6）0 0 12 ? * WED   表示每个星期三中午12点
（7）0 0 12 * * ?   每天中午12点触发
（8）0 15 10 ? * *   每天上午10:15触发
（9）0 15 10 * * ?     每天上午10:15触发
（10）0 15 10 * * ?   每天上午10:15触发
（11）0 15 10 * * ? 2005   2005年的每天上午10:15触发
（12）0 * 14 * * ?     在每天下午2点到下午2:59期间的每1分钟触发
（13）0 0/5 14 * * ?   在每天下午2点到下午2:55期间的每5分钟触发
（14）0 0/5 14,18 * * ?     在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
（15）0 0-5 14 * * ?   在每天下午2点到下午2:05期间的每1分钟触发
（16）0 10,44 14 ? 3 WED   每年三月的星期三的下午2:10和2:44触发
（17）0 15 10 ? * MON-FRI   周一至周五的上午10:15触发
（18）0 15 10 15 * ?   每月15日上午10:15触发
（19）0 15 10 L * ?   每月最后一日的上午10:15触发
（20）0 15 10 ? * 6L   每月的最后一个星期五上午10:15触发
（21）0 15 10 ? * 6L 2002-2005   2002年至2005年的每月的最后一个星期五上午10:15触发
（22）0 15 10 ? * 6#3   每月的第三个星期五上午10:15触发