版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/loongshawn/article/details/52078134
转载请注明来源-作者@loongshawn:http://blog.csdn.net/loongshawn/article/details/52078134
1、前言说明
《SpringBoot定时任务说明》这篇文章有说明过SpringBoot的定时任务实现方式,不过介绍的是一种轻量级的定时任务实现。但对于高级的定时需求,就难以满足了:比如工程运行过程中控制定时任务的开关等。这个时候就需要引入Quartz了,本文主要介绍了SpringBoot与Quartz的整合。
2、整合步骤
所需依赖,下述依赖包只截取了整合所需依赖,SpringBoot配置所需依赖不包括其中:
<properties>
<java.version>1.7</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<spring.version>4.2.7.RELEASE</spring.version>
</properties>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.1.1</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>1.1.1</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.quartz-scheduler</groupId>
<artifactId>quartz</artifactId>
<version>2.2.3</version>
</dependency>
项目整合的是最新版的Spring版本即4.2.7.RELEASE,同时Quartz也是最新版的2.2.3,如果融合工程后,出现错误,首先检查下版本是否有问题。
在Spring中使用Quartz有两种方式实现:第一种是任务类继承QuartzJobBean,第二种则是在配置文件里定义任务类和要执行的方法,类和方法可以是普通类。很显然,第二种方式远比第一种方式来的灵活。
这里采用的就是第二种方式。
<!-- 使用MethodInvokingJobDetailFactoryBean,任务类可以不实现Job接口,通过targetMethod指定调用方法-->
<bean id="taskJob" class="com.alibaba.task.TestTask"/>
<bean id="jobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
<property name="group" value="job_work"/>
<property name="name" value="job_work_name"/>
<!--false表示等上一个任务执行完后再开启新的任务-->
<property name="concurrent" value="false"/>
<property name="targetObject">
<ref bean="taskJob"/>
</property>
<property name="targetMethod">
<value>run</value>
</property>
</bean>
<!-- 调度触发器 -->
<bean id="myTrigger"
class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
<property name="name" value="work_default_name"/>
<property name="group" value="work_default"/>
<property name="jobDetail">
<ref bean="jobDetail" />
</property>
<property name="cronExpression">
<value>0/10 * * * * ?</value>
</property>
</bean>
<!-- 调度工厂 -->
<bean id="scheduler" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
<property name="triggers">
<list>
<ref bean="myTrigger"/>
</list>
</property>
</bean>
TestTask类则是一个普通的Java类,没有继承任何类和实现任何接口(当然可以用注解方式来声明bean):
public class TestTask {
/** 日志对象 */
private static final Logger LOG = LoggerFactory.getLogger(TestTask.class);
public void run() {
if (LOG.isInfoEnabled()) {
LOG.info("测试任务线程开始执行");
//new ScheduleJobService().getScheduleJob();
}
}
}
至此,简单的整合大功告成,run方法将每隔5秒执行一次,因为配置了concurrent等于false,所以假如run方法的执行时间超过5秒,在执行完之前即使时间已经超过了5秒下一个定时计划执行任务仍不会被开启,如果是true,则不管是否执行完,时间到了都将开启。
顺便贴一下cronExpression表达式备忘:
字段 | 允许值 | 允许的特殊字符 |
---|---|---|
秒 | 0-59 | – * / |
分 | 0-59 | – * / |
小时 | 0-23 | – * / |
日期 | 1-31 | – * ? / L W C |
月份 | 1-12 或者 JAN-DEC | – * / |
星期 | 1-7 或者 SUN-SAT | – * ? / L C # |
年 | (可选)留空1970-2099 | – * / |
表达式意义
表达式 | 允许值 |
---|---|
“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触发 |
0 6 * * * | 每天早上6点 |
0 /2 * * | 每两个小时 |
0 23-7/2,8 * * * | 晚上11点到早上8点之间每两个小时,早上八点 |
0 11 4 * 1-3 | 每个月的4号和每个礼拜的礼拜一到礼拜三的早上11点 |
0 4 1 1 * | 1月1日早上4点 |
3、运行结果
016-07-31-13-13 [main] [com.alibaba.App] [INFO] - oops: main入口函数编码-UTF-8
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v1.3.6.RELEASE)
2016-07-31-13-13 [main] [com.alibaba.App] [INFO] - Starting App on localhost with PID 1781 (/Users/xiaolong/Documents/workspace/quartz-springboot/target/classes started by xiaolong in /Users/xiaolong/Documents/workspace/quartz-springboot)
2016-07-31-13-13 [main] [com.alibaba.App] [INFO] - No active profile set, falling back to default profiles: default
2016-07-31-13-13 [main] [org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext] [INFO] - Refreshing org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@68231c67: startup date [Sun Jul 31 13:13:42 CST 2016]; root of context hierarchy
2016-07-31-13-13 [main] [org.springframework.beans.factory.xml.XmlBeanDefinitionReader] [INFO] - Loading XML bean definitions from class path resource [spring/applicationContext.xml]
2016-07-31-13-13 [main] [org.springframework.beans.factory.config.PropertyPlaceholderConfigurer] [INFO] - Loading properties file from class path resource [spring/config/application-dev.properties]
2016-07-31-13-13 [background-preinit] [org.hibernate.validator.internal.util.Version] [INFO] - HV000001: Hibernate Validator 5.2.4.Final
2016-07-31-13-13 [main] [org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainer] [INFO] - Tomcat initialized with port(s): 7001 (http)
2016-07-31-13-13 [main] [org.apache.catalina.core.StandardService] [INFO] - Starting service Tomcat
2016-07-31-13-13 [main] [org.apache.catalina.core.StandardEngine] [INFO] - Starting Servlet Engine: Apache Tomcat/8.0.36
2016-07-31-13-13 [localhost-startStop-1] [org.apache.catalina.core.ContainerBase.[Tomcat].[localhost].[/]] [INFO] - Initializing Spring embedded WebApplicationContext
2016-07-31-13-13 [localhost-startStop-1] [org.springframework.web.context.ContextLoader] [INFO] - Root WebApplicationContext: initialization completed in 884 ms
2016-07-31-13-13 [main] [org.quartz.impl.StdSchedulerFactory] [INFO] - Using default implementation for ThreadExecutor
2016-07-31-13-13 [main] [org.quartz.core.SchedulerSignalerImpl] [INFO] - Initialized Scheduler Signaller of type: class org.quartz.core.SchedulerSignalerImpl
2016-07-31-13-13 [main] [org.quartz.core.QuartzScheduler] [INFO] - Quartz Scheduler v.2.2.3 created.
2016-07-31-13-13 [main] [org.quartz.simpl.RAMJobStore] [INFO] - RAMJobStore initialized.
2016-07-31-13-13 [main] [org.quartz.core.QuartzScheduler] [INFO] - Scheduler meta-data: Quartz Scheduler (v2.2.3) 'scheduler' with instanceId 'NON_CLUSTERED'
Scheduler class: 'org.quartz.core.QuartzScheduler' - running locally.
NOT STARTED.
Currently in standby mode.
Number of jobs executed: 0
Using thread pool 'org.quartz.simpl.SimpleThreadPool' - with 10 threads.
Using job-store 'org.quartz.simpl.RAMJobStore' - which does not support persistence. and is not clustered.
2016-07-31-13-13 [main] [org.quartz.impl.StdSchedulerFactory] [INFO] - Quartz scheduler 'scheduler' initialized from an externally provided properties instance.
2016-07-31-13-13 [main] [org.quartz.impl.StdSchedulerFactory] [INFO] - Quartz scheduler version: 2.2.3
2016-07-31-13-13 [main] [org.quartz.core.QuartzScheduler] [INFO] - JobFactory set to: org.springframework.scheduling.quartz.AdaptableJobFactory@58cdc845
2016-07-31-13-13 [main] [org.springframework.context.support.DefaultLifecycleProcessor] [INFO] - Starting beans in phase 2147483647
2016-07-31-13-13 [main] [org.springframework.scheduling.quartz.SchedulerFactoryBean] [INFO] - Starting Quartz Scheduler now
2016-07-31-13-13 [main] [org.quartz.core.QuartzScheduler] [INFO] - Scheduler scheduler_$_NON_CLUSTERED started.
2016-07-31-13-13 [main] [org.apache.coyote.http11.Http11NioProtocol] [INFO] - Initializing ProtocolHandler ["http-nio-7001"]
2016-07-31-13-13 [main] [org.apache.coyote.http11.Http11NioProtocol] [INFO] - Starting ProtocolHandler ["http-nio-7001"]
2016-07-31-13-13 [main] [org.apache.tomcat.util.net.NioSelectorPool] [INFO] - Using a shared selector for servlet write/read
2016-07-31-13-13 [main] [org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainer] [INFO] - Tomcat started on port(s): 7001 (http)
2016-07-31-13-13 [main] [com.alibaba.App] [INFO] - Started App in 1.65 seconds (JVM running for 2.04)
2016-07-31-13-13 [scheduler_Worker-1] [com.alibaba.task.TestTask] [INFO] - 测试任务线程开始执行
2016-07-31-13-14 [scheduler_Worker-2] [com.alibaba.task.TestTask] [INFO] - 测试任务线程开始执行