09.Quartz 核心API简介

ゝ一纸荒年。 2022-02-20 04:37 263阅读 0赞

笔者认为, 若想灵活操作Quartz, 那么需要对Quartz的核心类和接口有一定的了解. quartz 最核心的类时Scheduler, 用于对定时任务的管理.

## 1. Quartz 核心类 ##

### 1. Quartz 常用接口 ###

*  Job: 定时任务接口, 定时任务触发时会执行其execute方法. 自定义任务类必须实现, 并重写execute方法
 *  JobListener: Job监听器接口, 自定义Job监听器时必须实现此接口。
 *  TriggerListener: Trigger 监听器接口, 自定义trigger 监听器时需实现此接口
 *  SchedulerListener: Scheduler 监听器接口, 自定义Scheduler 监听器时需要实现此接口

### 1.2 Quartz 常用工具类 ###

*  Scheduler: 定时任务管理的核心类, 可以对定时任务进行添加调度, 暂停调度, 删除调度等操作
 *  JobDetail: 定义定时任务的相关信息
 *  JobBuilder: 便捷构建JobDetail 的工具类
 *  TriggerBuilder: 便捷构建Trigger 的工具类
 *  SimpleScheduleBuilder: 用于构建简单类型的触发器
 *  CronSchedulerBuilder: 用于构建cron类型的调度器
 *  DateBuilder: 快速构建触发器的起止时间

### 1.3 标识符ID ###

*  JobKey: 定义job 的唯一ID, 由名称和分组名组成唯一
 *  TriggerKey: 定义Trigger的唯一ID, 由名称和分组构成唯一
 *  KeyMatcher: 用于指定key 匹配模式, 在自定义监听器匹配任务时使用
 *  GroupMatcher: 用于指定分组匹配模式, 在自定义监听器匹配任务时使用

## 2.Scheduler API ##

Scheduler 提供了很多API, 用于对job和Trigger的管理. Scheduler API的源码注释也比较清楚, 笔者这里只罗列其中常用的方法, 并做简单的说明.

<table> 
 <thead> 
  <tr> 
   <th align="left">方法签名</th> 
   <th align="left">方法描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">void start()</td> 
   <td align="left">启动调度器, 开始调度</td> 
  </tr> 
  <tr> 
   <td align="left">void startDelayed(int seconds)</td> 
   <td align="left">secondes秒之后开始调度</td> 
  </tr> 
  <tr> 
   <td align="left">Date scheduleJob(JobDetail jobDetail, Trigger trigger)</td> 
   <td align="left">添加调度任务, 绑定任务和触发器. 如果定时任务已存在, 则抛出异常, 不能进行覆盖</td> 
  </tr> 
  <tr> 
   <td align="left">Date scheduleJob(Trigger trigger)</td> 
   <td align="left">对已存在的job添加触发器, 可以实现多个触发器调度同一任务, trigger 需要指定关联的job</td> 
  </tr> 
  <tr> 
   <td align="left">void scheduleJob(JobDetail , Set&lt;? extends Trigger&gt; , boolean replace)</td> 
   <td align="left">添加调度任务, 可绑定多个触发器. 当replace设置为true时, 可以覆盖更新已存在job</td> 
  </tr> 
  <tr> 
   <td align="left">boolean unscheduleJob(TriggerKey triggerKey)</td> 
   <td align="left">取消调度, 删除关联的触发器. 当触发器关联的job没有触发器关联且job的durable为false时, 删除定时任务</td> 
  </tr> 
  <tr> 
   <td align="left">Date rescheduleJob(TriggerKey triggerKey, Trigger newTrigger)</td> 
   <td align="left">更新定时任务的触发器; 删除原来的触发器triggerKey, 新增触发器newTrigger, 并绑定新触发器和原理的job. 需要注意的是, 新触发器必须关联原job</td> 
  </tr> 
  <tr> 
   <td align="left">void addJob(JobDetail jobDetail, boolean replace)</td> 
   <td align="left">新增job, 可指定是否覆盖已存在job</td> 
  </tr> 
  <tr> 
   <td align="left">boolean deleteJob(JobKey jobKey)</td> 
   <td align="left">通过jobkey删除唯一job</td> 
  </tr> 
  <tr> 
   <td align="left">boolean deleteJobs(List jobKeys)</td> 
   <td align="left">删除多个job</td> 
  </tr> 
  <tr> 
   <td align="left">void triggerJob(JobKey jobKey)</td> 
   <td align="left">主动触发job, 执行一次</td> 
  </tr> 
  <tr> 
   <td align="left">void pauseJob(JobKey jobKey)</td> 
   <td align="left">暂停job, 暂停job关联的所有触发器的调度</td> 
  </tr> 
  <tr> 
   <td align="left">void pauseTrigger(TriggerKey triggerKey)</td> 
   <td align="left">暂停trigger的调度</td> 
  </tr> 
  <tr> 
   <td align="left">void resumeJob(JobKey jobKey)</td> 
   <td align="left">恢复job, 即恢复jo关联的所有触发器的调度</td> 
  </tr> 
  <tr> 
   <td align="left">void resumeTrigger(TriggerKey triggerKey)</td> 
   <td align="left">恢复触发器调度</td> 
  </tr> 
  <tr> 
   <td align="left">void pauseAll()</td> 
   <td align="left">停止所有调度</td> 
  </tr> 
  <tr> 
   <td align="left">void resumeAll()</td> 
   <td align="left">恢复所有调度</td> 
  </tr> 
  <tr> 
   <td align="left">List getJobGroupNames()</td> 
   <td align="left">获取所有的job分组</td> 
  </tr> 
  <tr> 
   <td align="left">Set getJobKeys(GroupMatcher matcher)</td> 
   <td align="left">获取一组或多组的所有job</td> 
  </tr> 
  <tr> 
   <td align="left">List&lt;? extends Trigger&gt; getTriggersOfJob(JobKey jobKey)</td> 
   <td align="left">获取job的所有触发器</td> 
  </tr> 
  <tr> 
   <td align="left">List getTriggerGroupNames()</td> 
   <td align="left">获取所有的触发器组</td> 
  </tr> 
  <tr> 
   <td align="left">Set getTriggerKeys(GroupMatcher matcher)</td> 
   <td align="left">获取一组或多组下所有的触发器</td> 
  </tr> 
  <tr> 
   <td align="left">JobDetail getJobDetail(JobKey jobKey)</td> 
   <td align="left">获取定时job定义详情</td> 
  </tr> 
  <tr> 
   <td align="left">Trigger getTrigger(TriggerKey triggerKey)</td> 
   <td align="left">获取触发器</td> 
  </tr> 
  <tr> 
   <td align="left">TriggerState getTriggerState(TriggerKey triggerKey)</td> 
   <td align="left">获取触发器状态</td> 
  </tr> 
  <tr> 
   <td align="left">boolean checkExists(JobKey jobKey)</td> 
   <td align="left">校验job是否存在</td> 
  </tr> 
  <tr> 
   <td align="left">boolean checkExists(TriggerKey triggerKey)</td> 
   <td align="left">校验trigger是否存在</td> 
  </tr> 
  <tr> 
   <td align="left">void clear()</td> 
   <td align="left">清除所有调度数据, 会删除所有数据, 谨慎使用</td> 
  </tr> 
  <tr> 
   <td align="left">void shutdown()</td> 
   <td align="left">关闭调度</td> 
  </tr> 
 </tbody> 
</table>