Spring Quartz 实现多任务定时调用

文章转自CSDN  排版略有改动

Spring Quartz 实现多任务定时调用

前言

最近项目需求，需要用 Spring Quartz 实现定时任务，原来也玩过，但是有些记得不太清楚，CSDN上搜索发现此文写的通俗易懂着实好文，特引入到知识库。

介绍

Quartz框架提供了任务调度的支持，比如，在何时执行何种任务。它是一个开源的由OpenSymphony维护的项目，支持普通POJO任务，甚至可以是EJB组件。 

1. POJO（Plain Old Java Objects）简单的Java对象，实际就是普通JavaBeans；也被称为Data对象，大量应用于表现现实中的对象。 
2. EJB是sun的JavaEE服务器端组件模型，设计目标与核心应用是部署分布式应用程序。简单来说就是把已经编写好的程序（即：类）打包放在服务器上执行。

  实现

1. 利用 maven 做项目依赖包管理 

<dependency> 
<groupId>org.quartz-scheduler</groupId> 
<artifactId>quartz</artifactId> 
<version>2.2.1</version> 
</dependency> 
<dependency> 
<groupId>commons-collections</groupId> 
<artifactId>commons-collections</artifactId> 
<version>3.2.1</version> 
</dependency> 

2. 实现指定业务 
Quartz 框架的最重要事情就是我们希望实现它在在何时执行何种任务。而指定的业务代码，和其他的 java 类方法的实现是一致的，位于同一级别。

/**
 * 定时器
 * 在指定的时间去做指定的业务
 * Created by zggdczfr on 2016/11/6.
 */
public class QuartzJob {
    //自定义 Logger 类，与 log4j 提供的日志记录不同
    private static final Logger LOGGER = Logger.getLogger(QuartzJob.class);
    public void work(){
        try {
            //实现业务逻辑代码
            LOGGER.log(Level.DEBUG, "Spring Quartz 自定义任务执行");
        } catch (Exception e){
            LOGGER.log(Level.ERROR, "Spring Quartz 自定义任务执出错，错误提示: {0}", e);
        }
    }
}

3. 将指定业务嵌入到现有的框架代码 
通常情况下，都是采用 XML 配置文件来嵌入现有的框架中。 
首先，说明一下，我通常使用的项目框架是 SSM(Spring+SpringMVC+MyBatis) 框架，所以我需要做两件事情。

首先，是实现 Quartz 自身的配置文件 
通常情况下，我会在resources文件夹下创建新的文件夹spring，专门用来存放与 Spring 框架集成的配置文件。因此，我们在spring文件夹中创建 spring-quartz.xml文件。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">
<beans>
    <!-- 要调用的工作类 -->
    <bean id="quartzJob" class="com.qg.quartz.QuartzJob"></bean>
    <!-- 定义调用对象和调用对象的方法 -->
    <bean id="jobtask" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
        <!-- 调用的类 -->
        <property name="targetObject">
            <ref bean="quartzJob" />
        </property>
        <!-- 调用类中的方法 -->
        <property name="targetMethod">
            <value>work</value>
        </property>
    </bean>
    <!-- 定义触发时间 -->
    <bean id="doTime" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
        <property name="jobDetail">
            <ref bean="jobtask" />
        </property>
        <!-- cron表达式 -->
        <property name="cronExpression">
            <!--1小时刷新一次-->
            <value>0 0 */1 * * ?</value>
        </property>
    </bean>
    <!-- 总管理类 如果将lazy-init='false'那么容器启动就会执行调度程序 -->
    <bean id="startQuertz" lazy-init="false" autowire="no"
          class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
        <property name="triggers">
            <list>
                //注意这里是列表
                <ref bean="doTime"/>
            </list>
        </property>
    </bean>
</beans>

接下来，就是将 XML 配置文件集成到项目中，结合 Spring 
在 web.xml启动项中添加启动配置。
 

<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:spring/spring-*.xml</param-value>
    <!--classpath:spring-quartz.xml 用于做任务调度-->
  </context-param>

这样子，就实现了 Spring Quartz 的任务调度了。

附录：cron表达式

通常情况下，我们使用 cron 表达式来配置任务调度的执行时间。接下来的 cron 表达式资料，均来源于网络，集合了几位大神的笔记。 
cron的表达式是字符串，实际上是由七子表达式，描述个别细节的时间表。这些子表达式意义如下： 
1. Seconds （秒） 
2. Minutes （分） 
3. Hours （时） 
4. Day-of-Month （天） 
5. Month （月） 
6. Day-of-Week （周） 
7. Year (年 可选字段) 
例 “0 0 12 ? * WED” 在每星期三下午12:00 执行； 

同时(“WED”)可以替换成 “MON-FRI”, “MON, WED, FRI”甚至”MON-WED,SAT”。

注意， cron 表达式规则
每一个字段都有一套可以指定有效值，如 
Seconds (秒) ：可以用数字0－59 表示；
Minutes(分) ：可以用数字0－59 表示；
Hours(时) ：可以用数字0-23表示；
Day-of-Month(天) ：可以用数字1-31 中的任一一个值，但要注意一些特别的月份；
Month(月) ：可以用0-11 或用字符串 “JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV and DEC” 表示；
Day-of-Week(*每周*)*：*可以用数字1-7表示（1 ＝ 星期日）或用字符口串“SUN, MON, TUE, WED, THU, FRI and SAT”表示；
“/”：为特别单位，表示为“每”如“0/15”表示每隔15分钟执行一次,“0”表示为从“0”分开始, “3/20”表示表示每隔20分钟执行一次，“3”表示从第3分钟开始执行；
“?”：表示每月的某一天，或第周的某一天；
“L”：用于每月，或每周，表示为每月的最后一天，或每个月的最后星期几如“6L”表示“每月的最后一个星期五”；
“W”：表示为最近工作日，如“15W”放在每月（day-of-month）字段上表示为“到本月15日最近的工作日”；
“#”：是用来指定“的”每月第n个工作日,例 在每周（day-of-week）这个字段中内容为”6#3” or “FRI#3” 则表示“每月第三个星期五”；
“*” 代表整个时间段。
常见的 cron 表达式
每隔5秒执行一次：*/5 * * * * ?
每隔1分钟执行一次：0 */1 * * * ?
每天23点执行一次：0 0 23 * * ?
每天凌晨1点执行一次：0 0 1 * * ?
每月1号凌晨1点执行一次：0 0 1 1 * ?
每月最后一天23点执行一次：0 0 23 L * ?
每周星期天凌晨1点实行一次：0 0 1 ? * L
在26分、29分、33分执行一次：0 26,29,33 * * * ?
每天的0点、13点、18点、21点都执行一次：0 0 0,13,18,21 * * ?