Spring 定时任务--quartz

素颜马尾好姑娘i 2022-07-14 10:13 227阅读 0赞

# Spring定时任务的几种实现 #

近日项目开发中需要执行一些定时任务，比如需要在每天凌晨时候，分析一次前一天的日志信息，借此机会整理了一下定时任务的几种实现方式，由于项目采用spring框架，所以我都将结合

spring框架来介绍。

## 一．分类 ##

*  ### 从实现的技术上来分类，目前主要有三种技术（或者说有三种产品）： ###

1.  Java自带的java.util.Timer类，这个类允许你调度一个java.util.TimerTask任务。使用这种方式可以让你的程序按照某一个频度执行，但不能在指定时间运行。一般用的较少，这篇文章将不做详细介绍。
2.  使用Quartz，这是一个功能比较强大的的调度器，可以让你的程序在指定时间执行，也可以按照某一个频度执行，配置起来稍显复杂，稍后会详细介绍。
3.  Spring3.0以后自带的task，可以将它看成一个轻量级的Quartz，而且使用起来比Quartz简单许多，稍后会介绍。

*  ### 从作业类的继承方式来讲，可以分为两类： ###

1.  作业类需要继承自特定的作业类基类，如Quartz中需要继承自org.springframework.scheduling.quartz.QuartzJobBean；java.util.Timer中需要继承自java.util.TimerTask。
2.  作业类即普通的java类，不需要继承自任何基类。

注:个人推荐使用第二种方式，因为这样所以的类都是普通类，不需要事先区别对待。

*  ##### 从任务调度的触发时机来分，这里主要是针对作业使用的触发器，主要有以下两种： #####

1.  每隔指定时间则触发一次，在Quartz中对应的触发器为：org.springframework.scheduling.quartz.SimpleTriggerBean
2.  每到指定时间则触发一次，在Quartz中对应的调度器为：org.springframework.scheduling.quartz.CronTriggerBean

注：并非每种任务都可以使用这两种触发器，如java.util.TimerTask任务就只能使用第一种。Quartz和spring task都可以支持这两种触发条件。

**下面重点介绍一下quartz：**

spring对quartz的配置共分四步：

1.  配置实际执行业务逻辑类，即普通的spring bean
2.  配置JobDetail类，如上例中的MethodInvokingJobDetailFactoryBean，该工厂类需要指定执行业务逻辑的bean及调用的方法名
3.  配置Trigger（任务触发）类，如上例中的CronTriggerFactoryBean，是基于cron表达式触发任务，需要指定JobDetail和cron表达式
4.  配置scheduler（定时任务）类，如上例中的SchedulerFactoryBean，是将trigger注册到定时任务中，使trigger生效

以上就是对基本方法调用的任务和基于cron表达式触发的一个定时任务的例子，实际在Java Web项目中也大多采用这种模式。

## 二．用法说明 ##

详细介绍每种任务调度工具的使用方式，包括Quartz和spring task两种。

## Quartz ##

### 第一种，作业类继承自特定的基类：org.springframework.scheduling.quartz.QuartzJobBean。 ###

**第一步：定义作业类**

Java代码   ![收藏代码][icon_star.png]

1.  **import** org.quartz.JobExecutionContext;  
2.  **import** org.quartz.JobExecutionException;  
3.  **import** org.springframework.scheduling.quartz.QuartzJobBean;  
4.  **public** **class** Job1 **extends** QuartzJobBean \{  
5.    
6.  **private** **int** timeout;  
7.  **private** **static** **int** i = 0;  
8.  //调度工厂实例化后，经过timeout时间开始执行调度  
9.  **public** **void** setTimeout(**int** timeout) \{  
10. **this**.timeout = timeout;  
11. \}  
12.   
13. /\*\* 
14. \* 要调度的具体任务 
15. \*/  
16. @Override  
17. **protected** **void** executeInternal(JobExecutionContext context)  
18. **throws** JobExecutionException \{  
19.   System.out.println("定时任务执行中…");  
20. \}  
21. \}

** 第二步：spring配置文件中配置作业类JobDetailBean**

Xml代码   ![收藏代码][icon_star.png]

1.  **<****bean** name="job1" class="org.springframework.scheduling.quartz.JobDetailBean"**>**  
2.  **<****property** name="jobClass" value="com.gy.Job1" **/>**  
3.  **<****property** name="jobDataAsMap"**>**  
4.  **<****map****>**  
5.  **<****entry** key="timeout" value="0" **/>**  
6.  **</****map****>**  
7.  **</****property****>**  
8.  **</****bean****>**

说明：org.springframework.scheduling.quartz.JobDetailBean有两个属性，jobClass属性即我们在java代码中定义的任务类，jobDataAsMap属性即该任务类中需要注入的属性值。

**第三步：配置作业调度的触发方式（触发器）**

Quartz的作业触发器有两种，分别是

org.springframework.scheduling.quartz.SimpleTriggerBean

org.springframework.scheduling.quartz.CronTriggerBean

第一种SimpleTriggerBean，只支持按照一定频度调用任务，如每隔30分钟运行一次。

配置方式如下：

Xml代码   ![收藏代码][icon_star.png]

1.  **<****bean** id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean"**>**  
2.  **<****property** name="jobDetail" ref="job1" **/>**  
3.  **<****property** name="startDelay" value="0" **/>**  
4.  **<****property** name="repeatInterval" value="2000" **/>**  
5.  **</****bean****>**

第二种CronTriggerBean，支持到指定时间运行一次，如每天12:00运行一次等。

配置方式如下：

Xml代码   ![收藏代码][icon_star.png]

1.  **<****bean** id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean"**>**  
2.  **<****property** name="jobDetail" ref="job1" **/>**  
3.  <!—每天12:00运行一次 --**>**  
4.  **<****property** name="cronExpression" value="0 0 12 \* \* ?" **/>**  
5.  **</****bean****>**

关于cronExpression表达式的语法参见附录。

**第四步：配置调度工厂 **

Xml代码   ![收藏代码][icon_star.png]

1.  **<****bean** class="org.springframework.scheduling.quartz.SchedulerFactoryBean"**>**  
2.  **<****property** name="triggers"**>**  
3.  **<****list****>**  
4.  **<****ref** bean="cronTrigger" **/>**  
5.  **</****list****>**  
6.  **</****property****>**  
7.  **</****bean****>**

说明：该参数指定的就是之前配置的触发器的名字。

**第五步：启动你的应用即可，即将工程部署至tomcat或其他容器。**

### 第二种，作业类不继承特定基类。 ###

Spring能够支持这种方式，归功于两个类：

org.springframework.scheduling.timer.MethodInvokingTimerTaskFactoryBean

org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean

这两个类分别对应spring支持的两种实现任务调度的方式，即前文提到到java自带的timer task方式和Quartz方式。这里我只写MethodInvokingJobDetailFactoryBean的用法，使用该类的好处是,我们的任务类不再需要继承自任何类，而是普通的pojo。

**第一步：编写任务类**

Java代码   ![收藏代码][icon_star.png]

1.  **public** **class** Job2 \{  
2.  **public** **void** doJob2() \{  
3.  System.out.println("不继承QuartzJobBean方式-调度进行中...");  
4.  \}  
5.  \}

可以看出，这就是一个普通的类，并且有一个方法。

**第二步：配置作业类**

Xml代码   ![收藏代码][icon_star.png]

1.  **<****bean** id="job2"  
2.  class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean"**>**  
3.  **<****property** name="targetObject"**>**  
4.  **<****bean** class="com.gy.Job2" **/>**  
5.  **</****property****>**  
6.  **<****property** name="targetMethod" value="doJob2" **/>**  
7.  **<****property** name="concurrent" value="false" **/>**  
8.  **</****bean****>**

说明：这一步是关键步骤，声明一个MethodInvokingJobDetailFactoryBean，有两个关键属性：targetObject指定任务类，targetMethod指定运行的方法。往下的步骤就与方法一相同了，为了完整，同样贴出。

**第三步：配置作业调度的触发方式（触发器）**

Quartz的作业触发器有两种，分别是

org.springframework.scheduling.quartz.SimpleTriggerBean

org.springframework.scheduling.quartz.CronTriggerBean

第一种SimpleTriggerBean，只支持按照一定频度调用任务，如每隔30分钟运行一次。

配置方式如下：

Xml代码   ![收藏代码][icon_star.png]

1.  **<****bean** id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean"**>**  
2.  **<****property** name="jobDetail" ref="job2" **/>**  
3.  **<****property** name="startDelay" value="0" **/>**  
4.  **<****property** name="repeatInterval" value="2000" **/>**  
5.  **</****bean****>**

第二种CronTriggerBean，支持到指定时间运行一次，如每天12:00运行一次等。

配置方式如下：

Xml代码   ![收藏代码][icon_star.png]

1.  **<****bean** id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean"**>**  
2.  **<****property** name="jobDetail" ref="job2" **/>**  
3.  <!—每天12:00运行一次 --**>**  
4.  **<****property** name="cronExpression" value="0 0 12 \* \* ?" **/>**  
5.  **</****bean****>**

以上两种调度方式根据实际情况，任选一种即可。

**第四步：配置调度工厂 **

Xml代码   ![收藏代码][icon_star.png]

说明：该参数指定的就是之前配置的触发器的名字。

**第五步：启动你的应用即可，即将工程部署至tomcat或其他容器。**

到此，spring中Quartz的基本配置就介绍完了，当然了，使用之前，要导入相应的spring的包与Quartz的包，这些就不消多说了。

其实可以看出Quartz的配置看上去还是挺复杂的，没有办法，因为Quartz其实是个重量级的工具，如果我们只是想简单的执行几个简单的定时任务，有没有更简单的工具，有！

请看Spring task的介绍。

时间的配置如下：   
<value>0 26 16 \* \* ?value>

时间大小由小到大排列，从秒开始，顺序为 秒，分，时，天，月，年    \*为任意 ？为无限制。由此上面所配置的内容就是，在每天的16点26分启动znrwdb方法   
具体时间设定可参考   
"0/10 \* \* \* \* ?" 每10秒触发   
"0 0 12 \* \* ?" 每天中午12点触发   
"0 15 10 ? \* \*" 每天上午10:15触发   
"0 15 10 \* \* ?" 每天上午10:15触发   
"0 15 10 \* \* ? \*" 每天上午10:15触发   
"0 15 10 \* \* ? 2005" 2005年的每天上午10:15触发   
"0 \* 14 \* \* ?" 在每天下午2点到下午2:59期间的每1分钟触发   
"0 0/5 14 \* \* ?" 在每天下午2点到下午2:55期间的每5分钟触发   
"0 0/5 14,18 \* \* ?" 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发   
"0 0-5 14 \* \* ?" 在每天下午2点到下午2:05期间的每1分钟触发   
"0 10,44 14 ? 3 WED" 每年三月的星期三的下午2:10和2:44触发   
"0 15 10 ? \* MON-FRI" 周一至周五的上午10:15触发   
"0 15 10 15 \* ?" 每月15日上午10:15触发   
"0 15 10 L \* ?" 每月最后一日的上午10:15触发   
"0 15 10 ? \* 6L" 每月的最后一个星期五上午10:15触发   
"0 15 10 ? \* 6L 2002-2005" 2002年至2005年的每月的最后一个星期五上午10:15触发   
"0 15 10 ? \* 6\#3" 每月的第三个星期五上午10:15触发   
每隔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 \* \* ?

[icon_star.png]: /images/20220714/6ffe94942008430baaf9649df38e46d7.png