Spring Quartz 的基础使用

梦里梦外; 2022-12-23 06:46 134阅读 0赞

### Spring Quartz 定时任务 ###

*  前言
 *  一、Cron 表达式
 *   *  （1）Cron 参数介绍
     *  （2）Cron 表达式的占位符
     *  （3）Cron 表达式的示例
 *  二、使用Quartz（注解的方式）
 *   *  （1）引入依赖
     *  （2）任务调度的类
     *  （3）开启任务调度
 *  三、其他调度属性
 *   *  （1）fixedDelay
     *  （2）fixedRate
     *  （3）initialDelay
 *  三、使用Quartz（XML配置的方式）
 *   *  （1）任务调度的类
     *  （2）Spring配置文件
 *  四、 其他
 *   *  （1）参考资料
     *  （2）工具

# 前言 #

Quartz 是一个完全由 Java 编写的开源的任务调度框架，按照规定的计划完成任务，如每周三的凌晨一点进行数据备份，或者按时间隔触发一次任务调度，如每十分钟同步一些状态信息，可以通过配置和注解两种方式来使用。

# 一、Cron 表达式 #

使用 Quartz 前必须要了解 Cron 周期计划。Cron 表达式的参数共有七位，第七位表示年份，可以忽略；第四位表示一个月的某一天，第六位表示一个周的某一天，这两个只会使用一个，另外一个使用符号 ? 占位，否则会有冲突。

## （1）Cron 参数介绍 ##

<table> 
 <thead> 
  <tr> 
   <th>位数</th> 
   <th>说明（取值范围）</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>第一位</td> 
   <td>秒钟（0-59）</td> 
  </tr> 
  <tr> 
   <td>第二位</td> 
   <td>分钟（0-59）</td> 
  </tr> 
  <tr> 
   <td>第三位</td> 
   <td>小时（0-23）</td> 
  </tr> 
  <tr> 
   <td>第四位</td> 
   <td>某一月的第某天（1-31）</td> 
  </tr> 
  <tr> 
   <td>第五位</td> 
   <td>月份（1-12）</td> 
  </tr> 
  <tr> 
   <td>第六位</td> 
   <td>某一周的第某天，可以使用数字1-7，也可以使用单词缩写</td> 
  </tr> 
  <tr> 
   <td>第七位</td> 
   <td>年份（1970-2099）</td> 
  </tr> 
 </tbody> 
</table>

> 注意：第六位参数需要注意，在西方一周的第一天是周日，所以 1=周日，7=周六；  
> 扩展：一周的单词缩写：SUN，MON，TUE，WED，THU，FRI，SAT。

## （2）Cron 表达式的占位符 ##

<table> 
 <thead> 
  <tr> 
   <th>占位符</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>*</td> 
   <td>表示任意时刻</td> 
  </tr> 
  <tr> 
   <td>?</td> 
   <td>一般用于第四位参数或第六位参数的占位</td> 
  </tr> 
  <tr> 
   <td>-</td> 
   <td>表示一个区间范围</td> 
  </tr> 
  <tr> 
   <td>/</td> 
   <td>表示间隔多久</td> 
  </tr> 
  <tr> 
   <td>,</td> 
   <td>表示枚举</td> 
  </tr> 
  <tr> 
   <td>L</td> 
   <td>一般用于第四位参数或第六位参数，最后一月或最后一周</td> 
  </tr> 
  <tr> 
   <td>W</td> 
   <td>表示有效的工作日（1-5）</td> 
  </tr> 
  <tr> 
   <td>#</td> 
   <td>表示第几个星期几</td> 
  </tr> 
  <tr> 
   <td>LW</td> 
   <td>表示某月的最后一个工作日</td> 
  </tr> 
 </tbody> 
</table>

## （3）Cron 表达式的示例 ##

<table> 
 <thead> 
  <tr> 
   <th>cron</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>0 0 3 * * ？</td> 
   <td>每月每天凌晨3点触发</td> 
  </tr> 
  <tr> 
   <td>0 0 3 1 * ？</td> 
   <td>每月1日凌晨3点触发</td> 
  </tr> 
  <tr> 
   <td>0 0 12 ？ * WEN</td> 
   <td>星期三中午12点触发, WEN也可以使用数字3表示</td> 
  </tr> 
  <tr> 
   <td>0 0 3 ？* MON-FRI</td> 
   <td>周一至周五凌晨3点触发,MON-FRI 也可以使用1-5来表示</td> 
  </tr> 
  <tr> 
   <td>0 0/5 8 * * ？</td> 
   <td>每天7点至7:55分每隔5分钟触发一次</td> 
  </tr> 
  <tr> 
   <td>5/15 0 * * * ？</td> 
   <td>从第 5 秒开始，每 15 秒一次</td> 
  </tr> 
  <tr> 
   <td>0 10,20 8 * * ？</td> 
   <td>每天的8点10分，8点20分触发</td> 
  </tr> 
  <tr> 
   <td>0 0 1-3 * * ？</td> 
   <td>每天的1点至三点每小时触发一次</td> 
  </tr> 
  <tr> 
   <td>0 0 8 L * ？</td> 
   <td>每月最后一天的8点触发</td> 
  </tr> 
  <tr> 
   <td>0 10 12 ？ * 6#3</td> 
   <td>每月的第三个星期五的12:10分触发</td> 
  </tr> 
  <tr> 
   <td>0 10 12 ？ * 6L 2022</td> 
   <td>表示2022年每月最后一个星期五10:22分触发</td> 
  </tr> 
 </tbody> 
</table>

# 二、使用Quartz（注解的方式） #

## （1）引入依赖 ##

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

## （2）任务调度的类 ##

使用 @Scheduled 注解，配置它的 cron 属性。

/** * @Author bls * @Description <p> 一段任务调度的代码 </p> * @Date 2020/12/02 09:58 */
    @Service
    public class QuartzJob { 
        @Scheduled(cron = "30 * * * * ?")
        public void cronScheduled(){ 
            System.out.println("在每时每刻的第 30 秒执行这次输出。");
        }
    
    }

## （3）开启任务调度 ##

添加 @EnableScheduling 注解，表示开启任务调度。SpringBoot 项目建议在启动类上添加，MVC 项目则在当前类上添加即可。

# 三、其他调度属性 #

## （1）fixedDelay ##

每个3000毫秒执行一次，无论上次是否会执行成功，下次都会执行

@Scheduled(fixedRate = 3000)
        public void fixedRateScheduled(){ 
            System.out.println("the night nice");
        }

## （2）fixedRate ##

每个3000毫秒执行一次，无论上次是否会执行成功，下次都会执行

@Scheduled(fixedRate = 3000)
        public void fixedRateScheduled(){ 
            System.out.println("the night nice");
        }

## （3）initialDelay ##

initialDelay 表示初始化延迟1000毫秒后，执行具体的任务调度，之后按照fixedRate进行任务调度

@Scheduled(initialDelay = 1000,fixedRate = 3000)
        public void initialDelayStringScheduled(){ 
            System.out.println("the night nice");
        }

# 三、使用Quartz（XML配置的方式） #

## （1）任务调度的类 ##

public class QuartzJob{ 
        public void work(){ 
            System.out.println("Quartz的任务调度！！！");
        }
    }

## （2）Spring配置文件 ##

当 Spring 容器被加载的时候，任务就会开始进行调度。

# 四、 其他 #

## （1）参考资料 ##

[https://www.ibm.com/developerworks/cn/java/j-quartz/index.html][https_www.ibm.com_developerworks_cn_java_j-quartz_index.html]

## （2）工具 ##

也可以使用 cron 的表达式生成器，百度即可，自己使用的：  
[https://qqe2.com/cron][https_qqe2.com_cron]

[https_www.ibm.com_developerworks_cn_java_j-quartz_index.html]: https://www.ibm.com/developerworks/cn/java/j-quartz/index.html
[https_qqe2.com_cron]: https://qqe2.com/cron