关于Quartz2.2.1的简单使用

最新推荐文章于 2025-04-10 11:11:01 发布

-ion

最新推荐文章于 2025-04-10 11:11:01 发布

阅读量4.4k

点赞数 1

分类专栏： java 文章标签： java java开发 quartz web

本文链接：https://blog.youkuaiyun.com/caokai1992/article/details/50070923

版权

java 专栏收录该内容

16 篇文章

订阅专栏

Quartz 是一个开源的作业调度框架，它完全由 Java 写成，并设计用于 J2SE 和 J2EE 应用中。它提供了巨大的灵活性而不牺牲简单性。你能够用它来为执行一个作业而创建简单的或复杂的调度。

了解Quartz体系结构

Quartz对任务调度的领域问题进行了高度的抽象，提出了调度器、任务和触发器这3个核心的概念，并在org.quartz通过接口和类对重要的这些核心概念进行描述
Quartz 调度包的两个基本单元是作业和触发器。作业是能够调度的可执行任务，触发器提供了对作业的调度。

调度器：调度器用于将与作业触发器关联,一个作业可关联多个触发器,这样每个触发器被可以触发的作业执行;一个触发器可用于控制多个作业，触发触发时，全部作业将获得调度。Quartz的调度器由Scheduler接口体现。
作业：只需实现org.quartz.job接口即可.Job接口包含一个方法 execute(),execute方法体是被调度的作业体。一旦实现Job接口和execute()方法， Quartz确定作业运作的时候，它将调用 execute()方法体。
触发器：有SimpleTrigger和CronTrigger两种类型。

使用准备

下载Quartz2.1.1所需要的jar : http://download.youkuaiyun.com/download/yxue1118/7989923

由于Quartz2.1.1需要jta-1.1.jar的支持，需要另行下载jta到项目中，如果输出找不到javax.transaction.UserTransaction时，则是缺失jta-1.1.jar。

在实验项目中，由于使用了logback代替log4j，所以无需编写log4j.properties文件，项目中导入的jar如下：

quartz-2.2.1.jar

quartz-jobs-2.2.1.jar

jta-1.1.jar

slf4j-api-1.6.6.jar

一、手动执行方式

通过main方法作为入口，手动执行来启动Quartz。

1、实现Job接口，并在execute方法中描述需要Quartz来帮你做的事情，这里需要Quartz来帮我们在控制台输出：Hello World!

public class TestQuartzJob implements Job{

	@Override
	public void execute(JobExecutionContext context) throws JobExecutionException {
		System.out.println("Hello, World! - executing its JOB at " + new Date());
	}

}

2、入口main方法代码，需要构建Scheduler对象，构建作业和触发器，我们设置每10秒执行一次作业，并执行11次。

public class QuartzTest {
	public static void main(String[] args) throws SchedulerException {
		//创建一个SchedulerFactory工厂实例
		SchedulerFactory schedulerFactory = new StdSchedulerFactory();
		//通过SchedulerFactory构建Scheduler对象
		Scheduler scheduler = schedulerFactory.getScheduler();
		
		//用于描叙Job实现类及其他的一些静态信息，构建一个作业实例
		JobDetail jobDetail = JobBuilder.newJob(TestQuartzJob.class)
				.withIdentity("TestQuartzJob","Test_group")//给作业起一个名字和组名
                .build();
		
		//构建一个触发器，规定触发的规则
		Trigger trigger= TriggerBuilder//创建一个新的TriggerBuilder来规范一个触发器
                .newTrigger()//给触发器起一个名字和组名
                .withIdentity("TestQuartzTrigger","Test_group")
                .startNow()//立即执行
                .withSchedule(SimpleScheduleBuilder.simpleSchedule()//这里使用SimpleTrigger类型触发器
                        .withIntervalInSeconds(10) //时间间隔，单位秒
                        .withRepeatCount(10)//输出次数，repeatForever()则为一直输出
                        )
                .build();//产生触发器
		
		//向Scheduler中添加job任务和trigger触发器
		scheduler.scheduleJob(jobDetail,trigger);
		
		//启动
		scheduler.start();
	}
}

3、运行main方法，输出一下结果：

Hello, World! - executing its JOB at Fri Nov 27 16:05:32 CST 2015
Hello, World! - executing its JOB at Fri Nov 27 16:05:42 CST 2015
Hello, World! - executing its JOB at Fri Nov 27 16:05:52 CST 2015
Hello, World! - executing its JOB at Fri Nov 27 16:06:02 CST 2015
Hello, World! - executing its JOB at Fri Nov 27 16:06:12 CST 2015
Hello, World! - executing its JOB at Fri Nov 27 16:06:22 CST 2015
Hello, World! - executing its JOB at Fri Nov 27 16:06:32 CST 2015
Hello, World! - executing its JOB at Fri Nov 27 16:06:42 CST 2015
Hello, World! - executing its JOB at Fri Nov 27 16:06:52 CST 2015
Hello, World! - executing its JOB at Fri Nov 27 16:07:02 CST 2015
Hello, World! - executing its JOB at Fri Nov 27 16:07:12 CST 2015

从结果中可以看出，实际的输出结果比我们在withRepeatCount中设置的要多一次。

二、在Tomcat容器中使用Quartz

之上是通过main入口启动，但在实际的项目运行中不可能使用这样的方式，我们可以通过在web.xml文件里面进行配置实现启动容器时加载Quartz。实验项目中，我定义了三个配置文件：quartz.properties，quartzjob.xml，web.xml

1、web.xml，我们在web.xml中加入以下配置就可以了。

<!-- quartz定时器相关配置 -->
	<context-param>
         <param-name>quartz:config-file</param-name>
         <param-value>/quartz.properties</param-value>
     </context-param>
     <context-param>
         <param-name>quartz:shutdown-on-unload</param-name>
         <param-value>true</param-value>
     </context-param>
     <context-param>
         <param-name>quartz:wait-on-shutdown</param-name>
         <param-value>true</param-value>
     </context-param>
     <context-param>
         <param-name>quartz:start-scheduler-on-load</param-name>
         <param-value>true</param-value>
     </context-param>
     
     <servlet> 
        <servlet-name>QuartzInitializer</servlet-name> 
        <servlet-class>org.quartz.ee.servlet.QuartzInitializerServlet</servlet-class> 
        <init-param>
            <param-name>shutdown-on-unload</param-name>
            <param-value>true</param-value>
        </init-param>
        <load-on-startup>2</load-on-startup>
    </servlet>

2、quartz.properties

##实例名称
org.quartz.scheduler.instanceName: DefaultQuartzScheduler
org.quartz.scheduler.rmi.export: false
org.quartz.scheduler.rmi.proxy: false
org.quartz.scheduler.wrapJobExecutionInUserTransaction: false

org.quartz.threadPool.class: org.quartz.simpl.SimpleThreadPool
##线程个数
org.quartz.threadPool.threadCount: 1
org.quartz.threadPool.threadPriority: 5
org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread: true

##org.quartz.jobStore.class: org.quartz.simpl.RAMJobStore

org.quartz.plugin.jobInitializer.class = org.quartz.plugins.xml.XMLSchedulingDataProcessorPlugin
org.quartz.plugin.jobInitializer.fileNames = quartzjob.xml
org.quartz.plugin.jobInitializer.failOnFileNotFound = true
org.quartz.plugin.jobInitializer.scanInterval = 10
org.quartz.plugin.jobInitializer.wrapInUserTransaction = false

##关闭quartz新版本检测功能
org.quartz.scheduler.skipUpdateCheck =true

3、quartzjob.xml

<?xml version='1.0' encoding='utf-8'?>
<job-scheduling-data xmlns="http://www.quartz-scheduler.org/xml/JobSchedulingData"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.quartz-scheduler.org/xml/JobSchedulingData http://www.quartz-scheduler.org/xml/job_scheduling_data_1_8.xsd"
  version="1.8">
    <schedule>
        <job>
            <name>GetAccessToken_Job</name>
            <group>MYJOB_GROUP</group>
            <description>The job description</description>
            <job-class>com.hly.wecat.quartz.TestQuartzJob</job-class>
        </job>
        <trigger>
            <cron>
                <name>GetAccessToken_Trigger</name>
                <group>MYTRIGGER_GROUP</group>
                <job-name>GetAccessToken_Job</job-name>
                <job-group>MYJOB_GROUP</job-group>
                <cron-expression>0 0/1 * * * ?</cron-expression>
            </cron>
        </trigger>
    </schedule>
</job-scheduling-data>

4、实现Job接口，并在execute方法中描述需要Quartz来帮你做的事情，这里需要Quartz来帮我们在控制台输出： Hello World!

public class TestQuartzJob implements Job{

	@Override
	public void execute(JobExecutionContext context) throws JobExecutionException {
		System.out.println("Hello, World! - executing its JOB at " + new Date());
	}

}

由于我之前说到我使用logback替代了log4j，完成以上配置后，在tomcat7中能完美运行，但是控制台中会频繁输出Quartz的日志，这是由于Quartz中的日志输出级别是为Debug的，解决方法，在logback.xml配置文件中加上以下配置，把org.quartz包下的日志设置为warn级别。

<logger name="org.quartz" level="WARN" additivity="false"/>

三、cron-expression表达式详解

对于使用Quartz，另一个头疼的问题是cron-expression表达式，对cron不理解的可以看看以下下面的介绍，cron的介绍是我从网上摘抄过来的，算是比较详细的一篇了。

一个cron表达式有至少6个（也可能7个）有空格分隔的时间元素。按顺序依次为1.秒（0~59）2.分钟（0~59）3.小时（0~23）4.天（月）（0~31，但是你需要考虑你月的天数）5.月（0~11）6.天（星期）（1~7 1=SUN 或 SUN，MON，TUE，WED，THU，FRI，SAT）7.年份（1970－2099）其中每个元素可以是一个值(如6),一个连续区间(9-12),一个间隔时间(8-18/4)(/表示每隔4小时),一个列表(1,3,5),通配符。由于"月份中的日期"和"星期中的日期"这两个元素互斥的,必须要对其中一个设置?.

0 0 10,14,16 * * ? 每天上午10点，下午2点，4点0 0/30 9-17 * * ??? 朝九晚五工作时间内每半小时0 0 12 ? * WED 表示每个星期三中午12点，有些子表达式能包含一些范围或列表例如：子表达式（天（星期））可以为 “MON-FRI”，“MON，WED，FRI”，“MON-WED,SAT”

“*”字符代表所有可能的值因此，“*”在子表达式（月）里表示每个月的含义，“*”在子表达式（天（星期））表示星期的每一天

“/”字符用来指定数值的增量例如：在子表达式（分钟）里的“0/15”表示从第0分钟开始，每15分钟 ;在子表达式（分钟）里的“3/20”表示从第3分钟开始，每20分钟（它和“3，23，43”）的含义一样“？”字符仅被用于天（月）和天（星期）两个子表达式，表示不指定值当2个子表达式其中之一被指定了值以后，为了避免冲突，需要将另一个子表达式的值设为“？”

“L” 字符仅被用于天（月）和天（星期）两个子表达式，它是单词“last”的缩写，但是它在两个子表达式里的含义是不同的。在天（月）子表达式中，“L”表示一个月的最后一天 ,在天（星期）自表达式中，“L”表示一个星期的最后一天，也就是SAT，如果在“L”前有具体的内容，它就具有其他的含义了，例如：“6L”表示这个月的倒数第６天，“ＦＲＩＬ”表示这个月的最后一个星期五，注意：在使用“L”参数时，不要指定列表或范围，因为这会导致问题

============================================

CronTrigger配置完整格式为： [秒] [分] [小时] [日] [月] [周] [年]

序号说明是否必填允许填写的值允许的通配符

1 秒是 0-59 , - * /

2 分是 0-59 , - * /

3 小时是 0-23 , - * /

4 日是 1-31 , - * ? / L W

5 月是 1-12 or JAN-DEC , - * /

6 周是 1-7 or SUN-SAT , - * ? / L #

7 年否 empty 或 1970-2099 , - * /

通配符说明:*表示所有值. 例如:在分的字段上设置 "*",表示每一分钟都会触发。? 表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作，但不关心是周几，所以需要周位置的那个字段设置为"?" 具体设置为 0 0 0 10 * ?- 表示区间。例如在小时上设置 "10-12",表示 10,11,12点都会触发。, 表示指定多个值，例如在周字段上设置 "MON,WED,FRI" 表示周一，周三和周五触发/用于递增触发。如在秒上面设置"5/15" 表示从5秒开始，每增15秒触发(5,20,35,50)。在月字段上设置'1/3'所示每月1号开始，每隔三天触发一次。L 表示最后的意思。在日字段设置上，表示当月的最后一天(依据当前月份，如果是二月还会依据是否是润年[leap]), 在周字段上表示星期六，相当于"7"或"SAT"。如果在"L"前加上数字，则表示该数据的最后一个。例如在周字段上设置"6L"这样的格式,则表示“本月最后一个星期五" W 表示离指定日期的最近那个工作日(周一至周五). 例如在日字段上设置"15W"，表示离每月15号最近的那个工作日触发。如果15号正好是周六，则找最近的周五(14号)触发, 如果15号是周未，则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五)，则就在该天触发。如果指定格式为 "1W",它则表示每月1号往后最近的工作日触发。如果1号正是周六，则将在3号下周一触发。(注，"W"前只能设置具体的数字,不允许区间"-").# 序号(表示每月的第几个周几)，例如在周字段上设置"6#3"表示在每月的第三个周六.注意如果指定"#5",正好第五周没有周六，则不会触发该配置(用在母亲节和父亲节再合适不过了) ；小提示：'L'和 'W'可以一组合使用。如果在日字段上设置"LW",则表示在本月的最后一个工作日触发；周字段的设置，若使用英文字母是不区分大小写的，即MON与mon相同；常用示例:

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分每分触发

0 0/5 14 * * ? 每天下午的 2点到2点59分(整点开始，每隔5分触发)

0 0/5 14,18 * * ? 每天下午的 2点到2点59分、18点到18点59分(整点开始，每隔5分触发)

0 0-5 14 * * ? 每天下午的 2点到2点05分每分触发

0 10,44 14 ? 3 WED 3月分每周三下午的 2点10分和2点44分触发

0 15 10 ? * MON-FRI 从周一到周五每天上午的10点15分触发

0 15 10 15 * ? 每月15号上午10点15分触发