Java定时任务之Quartz

红太狼 2022-11-09 11:24 257阅读 0赞

## Quartz ##

### 文章目录 ###

*   *  Quartz
     *   *  1. Quartz是什么
         *  2. HelloWorld程序
         *  3. 使用JobDetail
         *   *  3.1 JobDetail介绍
             *  3.2 JobDetail属性
         *  4. 使用Trigger
         *  5. 使用SimpleTrigger
         *  6. 使用CronTrigger
         *   *  6.1 CronTrigger介绍
             *  6.2 Cron表达式示例
             *  6.3 Cron表达式案例
         *  7. 使用Scheduler
         *   *  7.1 Scheduler工厂模式
             *  7.2 Scheduler主要函数
         *  8. quartz.properties配置文件的使用
         *   *  8.1 配置文件位置及加载顺序
             *  8.2 组成部分

### 1. Quartz是什么 ###

*  Quartz框架是一个开源的企业级**任务调度**服务，已经被作为任务调度的良好解决方案
 *  Quartz对任务调度进行了高度抽象，提出了3个核心概念，并在org.quartz包中通过接口和类进行了描述：
    
     *  **任务 JOB**：要执行的动作
     *  **触发器 Trigger**: 什么时候被执行，执行几次
     *  **调度器 Scheduler**：负责绑定触发器和任务，并进行任务调度
 *  市场上常见的定时任务框架：
    
     *  **Quartz**
     *  **Spring Task**

### 2. HelloWorld程序 ###

*  创建maven工程，导入依赖

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

一个最简单的应用包含两个类:

*  HelloJob.java
    
    任务类，需要实现 **Job 接口**，重写的execute()方法中定义要执行的任务，**实现Job类之后此类成为任务类**
 *  SimpleExample.java  
    主线程，main()方法中用于任务的调度，执行等操作

代码实现：

*  HelloJob.java

public class HelloJob implements Job { 
    
    	//重写的方法中定义要执行的任务
    	@Override
    	public void execute(JobExecutionContext context) throws JobExecutionException { 
    		System.out.println("Hello World! - " + new Date());
    	}
    }
    //可以通过JobExecutionContext对象访问到Quartz运行时的环境以及Job本身的明细数据

*  SimpleExample.java

public class SimpleExample { 
    
    	public static void main(String[] args) throws Exception { 
    		
    		//使用JobDetail创建一个任务
            //参数1表示所要执行的任务类
            //参数2表示此任务的自定义名称
            //参数3表示此任务自定义的分组名称
      	    JobDetail job = JobBuilder.newJob(HelloJob.class).withIdentity("HelloJob", "group1").build();
            
            //不指定组则默认的分组名称是DEFAULT
            
            //创建一个触发器
            //每隔2秒执行一次，执行10次
            Trigger trigger = TriggerBuilder.newTrigger()
                .withIdentity("自定义名称", "分组名")
                .startNow() //立即执行
                .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                              .withIntervalInSeconds(2).withRepeatCount(10))
                .build();
    
    		/**第一次运行的结果不算做定时任务，也就是会打印11次*/
            
            // 创建调度者工厂，通过工厂获取调度类
    		SchedulerFactory sfc = new StdSchedulerFactory();
    		
    		// 创建一个调度者
    		Scheduler sched = sfc.getScheduler();
    		
    		// 调度者绑定触发器和任务，并进行任务调度
    		sched.scheduleJob(jobDetail, trigger);
    		
    		// 启动调度
    		sched.start();
    		
            // 让主线程main方法sleep20s，不会结束main方法，若main方法结束则不会执行任务
    		Thread.sleep(20000);
    		
            // 关闭调度
    		sched.shutdown();
    	}
    }

### 3. 使用JobDetail ###

#### 3.1 JobDetail介绍 ####

JobDetail为Job实例提供了许多的设置属性 (以及JobDataMap成员变量属性) ，他用来存储Job实例的状态信息，调度者需要借助JobDetail对象来添加Job实例

#### 3.2 JobDetail属性 ####

1.  name：自定义名称
2.  group：自定义分组
3.  jobClass：Job的实现类
4.  jobDataMap：实现了Map接口；存储在JobExecutionContext中；可以用来装载k-v键值对

**示例一：**

//获取JobDetail中的属性值
    jobDetail.getKey().getName(); //获取name属性值
    jobDetail.getKey().getGroup(); //获取group属性值
    jobDetail.getJobClass().getName(); //获取jobClass属性值

**示例二：**

//在JobDetail中使用JobDataMap
    JobDetail jobDetail = JobBuilder.newJob(HelloJob.class).withIdentity("HelloJob", "group1")
        //使用JobDataMap
        .usingJobData("k1", "v1")
        .usingJobData("k2", "v2")
        .build();
    
    //在Trigger中使用JobDataMap
    Trigger trigger = TriggerBuilder.newTrigger()
        .withIdentity("自定义名称", "分组名")
        //使用JobDataMap
        .usingJobData("k1", "v1")
        .startNow() //立即执行
        .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                      .withIntervalInSeconds(2).withRepeatCount(10))
        .build();

**示例三：**

获取JobDataMap的值

public class HelloJob implements Job { 
        @Override
        public void execute(JobExecutionContext context) throws JobExecutionException { 
            //获取JobDetail数据
            JobKey key = context.getJobDetail().getKey();
            System.out.println("JobDetail名称：" + key.getName() + "JobDetail分组：" + key.getGroup());
    
            //获取Trigger数据
            TriggerKey trigger = context.getTrigger().getKey();
            System.out.println("Trigger名称：" + key.getName() + "Trigger分组：" + key.getGroup());
    
            //获取JobDetail中的JobDataMap数据
            JobDataMap J_jobDataMap = context.getJobDetail().getJobDataMap();
            J_jobDataMap.getString("k1");
            J_jobDataMap.getString("k2");
    
            //获取Trigger中的JobDataMap数据
            JobDataMap T_jobDataMap = context.getTrigger().getJobDataMap();
            T_jobDataMap.getString("k1");
    
            //同时获取JobDetail以及Trigger中的JobDataMap数据
            JobDataMap mergedJobDataMap = context.getMergedJobDataMap();
            mergedJobDataMap.getString("k1"); //Trigger中key会覆盖JobDetail中的key
        }
    }

\*\*注意：\*\*在Job的实现类中添加JobDataMap同名的键值对的key的属性，并添加setter方法，初始化Job实例时会自动的调用这些setter方法为同名的key的属性赋予JobDataMap对应的value值

### 4. 使用Trigger ###

设置任务执行的开始时间和结束时间

Trigger trigger = TriggerBuilder.newTrigger()
        .withIdentity("自定义名称", "分组名")
        //设置开始时间
        .startAt(new Date())
        //设置结束时间
        .endAt(new Date())
        .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                      .withIntervalInSeconds(2).withRepeatCount(10))
        .build();

获取任务的开始和结束时间

public class HelloJob implements Job { 
        @Override
        public void execute(JobExecutionContext context) throws JobExecutionException { 
            Trigger trigger = context.getTrigger();
            trigger.getStartTime();
            trigger.getEndTime();
        }
    }

### 5. 使用SimpleTrigger ###

SimpleTrigger simpleTrigger = (SimpleTrigger) TriggerBuilder
        .newTrigger()
        .withIdentity("自定义名称","自定义分组")
        .startAt(new Date())
        .withSchedule(
        SimpleScheduleBuilder
        .simpleSchedule()
        .withIntervalInSeconds(2)
        .withRepeatCount(
            SimpleTrigger.REPEAT_INDEFINITELY
        )
    )
        .build();

注意：

1.  重复次数可以是0次、正整数、以及如下的常量表达式

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70][]

1.  重复执行间隔必须是0或正整数
2.  一旦指定了endTime参数，那么会覆盖重复次数的效果

### 6. 使用CronTrigger ###

#### 6.1 CronTrigger介绍 ####

常见的触发器有两种：SimpleTrigger、CronTrigger

**CronTrigger和SimpleTrigger的对比：**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JydWNlTGl1X2NvZGU_size_16_color_FFFFFF_t_70]

*  CronTrigger主要用于处理Cron表达式定义的任务，比如每个月20号，每个星期一执行某任务
 *  CronTrigger允许用户更精准地控制任务的运行日期和时间，而不仅仅是定义工作的频度
 *  CronTrigger通过Cron表达式定义准确的运行时间点

**创建CronTrigger的语法如下：**

要使用CronTrigger，必须掌握Cron表达式

![在这里插入图片描述][20190806221325595.png]

Cron表达式由6~7个通过空格分隔的时间元素组成，**第7个元素可选：**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JydWNlTGl1X2NvZGU_size_16_color_FFFFFF_t_70 1]

Cron表达式的每个字段，都可以显式地规定一个值（如49）、一个范围（如1-6）、一个列表（如1,3,5）或者一个通配符（如\*）

Cron表达式有几个**特殊的字符**，说明如下：

*  “ - ”：中划线，表示一个范围 ；例如：1-10
 *  “ , ”：使用逗号间隔的数据，表示一个列表；例如：1,8,10
 *  “ \* ”：表示每一个值，它可以用于所有字段；例如：在小时字段表示每小时 \*
 *  “ ? ”：该字符仅用于“月份中的哪一天”字段和“星期几”字段，表示不指定值
 *  “ / ”：通常表示为x/y，x为起始值，y表示值的增量
 *  “ L ”：表示最后一天或最后一个星期几，仅在日期和星期字段中使用
 *  “ \# ”：只能用于“星期几”字段，表示这个月的第几个周几；例如：“6\#3”指这个月第三个周五

#### 6.2 Cron表达式示例 ####

语法格式：

> 秒 分 时 天 月 星期 年

**星期的表达式中，1表示周日，类推5表示周四，6表示周五**

常用表达式例子：

（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触发

#### 6.3 Cron表达式案例 ####

CronTrigger cronTrigger = (CronTrigger) TriggerBuilder
        .newTrigger()
        .withIdentity("自定义名称", "自定义分组")
        .withSchedule(
        CronScheduleBuilder.cronSchedule("Cron表达式")
    )
        .build();

### 7. 使用Scheduler ###

#### 7.1 Scheduler工厂模式 ####

所有的Scheduler实例都应该由SchedulerFactory来创建

#### 7.2 Scheduler主要函数 ####

1.  Date schedulerJob(JobDetaile jobDetail, Trigger trigger)：绑定任务类和触发器，并返回最近一次要执行的任务的时间
2.  void start()：执行任务
3.  void standby()：将任务暂时挂起，可以使用start()唤醒
4.  void shutdown()：结束任务的执行，无法通过start()唤醒
    
     *  shutdown(true)：等待所有正在执行的Job执行完毕之后关闭scheduler
     *  shutdown(false)：直接关闭scheduler

### 8. quartz.properties配置文件的使用 ###

Quartz启动的时候会读取quartz.properties配置文件的信息

#### 8.1 配置文件位置及加载顺序 ####

首先读取工程路径下的quartz.proerties文件，若没有，则读取引入的quartz.jar

包中的quartz.properties配置文件

#### 8.2 组成部分 ####

1.  调度器属性

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 1]

1.  线程池属性

*  threadCount：线程的数量，至少为1（无默认值）(一般设置为1-100的整数合适)
 *  threadPriority：线程的优先级，默认值是5
 *  org.quartz.threadPool.class：线程池实现，默认值是SimpleThreadPool

1.  作业存储设置

描述了调度器实例的生命周期中，Job和Trigger信息是如何被存储的

1.  插件配置

满足特定需求用到的Quartz插件的配置

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70]: /images/20221023/0ed1d88d3ad14e048d00f3fdc3bd3f5c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JydWNlTGl1X2NvZGU_size_16_color_FFFFFF_t_70]: /images/20221023/e310e87bce194045903d49fb69a1f833.png
[20190806221325595.png]: /images/20221023/2c158f05754544808adecd9939660c1d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JydWNlTGl1X2NvZGU_size_16_color_FFFFFF_t_70 1]: /images/20221023/adfd37d9a55a4a1eb6f4deedfb52631b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70 1]: /images/20221023/1a4f06d26b5c40c6bcdf58e9a417499c.png