前言
本文主要参考了一下三个文章来源: https://blog.csdn.net/liuxiao723846/article/details/90546619 https://www.cnblogs.com/javanoob/p/springboot_schedule.html https://www.cnblogs.com/yanghj010/p/10875151.html 做了一个汇总。
1.spring定时任务详解spring schedule和spring-quartz
1.1spring schedule
从实现的技术上来分类,java定时任务目前主要有三种:
Java自带的java.util.Timer类,这个类允许你调度一个java.util.TimerTask任务。使用这种方式可以让你的程序按照某一个频度执行,但不能在指定时间运行;而且作业类需要集成java.util.TimerTask,一般用的较少。 Quartz,这是一个功能比较强大的的调度器,可以让你的程序在指定时间执行,也可以按照某一个频度执行;使用起来需要继承org.springframework.scheduling.quartz.QuartzJobBean,配置稍显复杂,所以,一般会使用spring集成quartz,稍后会详细介绍; Spring3.0以后自带的task,即:spring schedule,可以将它看成一个轻量级的Quartz,而且使用起来比Quartz简单许多。
综上,spring中使用定时任务有两种方式:spring schedule和spring-quartz,接下来我们重点介绍这两种。使用前都需要引入spring的包。
1.1.1引入依赖
< dependency>
< groupId> org.springframework</ groupId>
< artifactId> spring-core</ artifactId>
< version> ${org.springframework.version}</ version>
< type> jar</ type>
< scope> compile</ scope>
</ dependency>
< dependency>
< groupId> org.springframework</ groupId>
< artifactId> spring-beans</ artifactId>
< version> ${org.springframework.version}</ version>
< type> jar</ type>
< scope> compile</ scope>
</ dependency>
< dependency>
< groupId> org.springframework</ groupId>
< artifactId> spring-context</ artifactId>
< version> ${org.springframework.version}</ version>
< type> jar</ type>
< scope> compile</ scope>
</ dependency>
< dependency>
< groupId> org.springframework</ groupId>
< artifactId> spring-context-support</ artifactId>
< version> ${org.springframework.version}</ version>
</ dependency>
1.1.2 spring schedule
1.1.2.1 xml配置的方式:
1)application.xml:
首先在application.xml中引入task的命名空间,以及通过task标签定义任务。
<?xml version="1.0" encoding="UTF-8"?>
< beans xmlns = " http://www.springframework.org/schema/beans"
xmlns: xsi= " http://www.w3.org/2001/XMLSchema-instance"
xmlns: task= " http://www.springframework.org/schema/task"
xsi: schemaLocation= " http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-4.0.xsd" >
< task: scheduler id = " myScheduler" />
< task: scheduled-tasks scheduler = " myScheduler" >
< task: scheduled ref = " doSomethingTask" method = " doSomething" cron = " 0 * * * * *" />
</ task: scheduled-tasks>
</ beans>
2)任务类:
import org. springframework. scheduling. annotation. Scheduled ;
import org. springframework. stereotype. Component ;
@Component
public class DoSomethingTask {
public void doSomething ( ) {
System . out. println ( "do something" ) ;
}
}
1.1.2.2 @schedule 注解方式:
1)application.xml
同样在application.xml中引入task的命名空间,以及启用注解驱动的定时任务。
<?xml version="1.0" encoding="UTF-8"?>
< beans xmlns = " http://www.springframework.org/schema/beans"
xmlns: xsi= " http://www.w3.org/2001/XMLSchema-instance"
xmlns: task= " http://www.springframework.org/schema/task"
xsi: schemaLocation= " http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-4.0.xsd" >
< task: annotation-driven/>
</ beans>
2)任务类:
import org. springframework. scheduling. annotation. Scheduled ;
import org. springframework. stereotype. Component ;
@Component
public class DoSomethingTask {
@Scheduled ( cron= "0 * * * * *" )
public void doSomething ( ) {
System . out. println ( "do something" ) ;
}
}
1.1.2.3 Cron表达式:
由6~7项组成,中间用空格分开。从左到右依次是:秒、分、时、日、月、周几、年(可省略)。值可以是数字,也可以是以下符号: *:所有值都匹配 ?:无所谓,不关心,通常放在“周几”里 ,:或者 /:增量值 -:区间
1.2spring-quartz
1.2.1 依赖
maven中需要引入:quartz.jar、spring-context-support.jar。
1.2.2 示例:
1.2.2.1 定义任务类:(spring集成的quartz不需要集成任何类)
@Service
public class QuartzTest {
public void test ( ) {
System . out. println ( "It's time to run :" + new Date ( ) . toString ( ) ) ;
}
}
1.2.2.2 spring-quartz.xml配置有两种:
a)SimpleTrigger方式:
< bean name = " quartzScheduler" class = " org.springframework.scheduling.quartz.SchedulerFactoryBean" >
< property name = " triggers" >
< list>
< ref local = " quartzTestTrigger" />
</ list>
</ property>
</ bean>
< bean id = " quartzTestTrigger" class = " org.springframework.scheduling.quartz.SimpleTriggerBean" >
< property name = " jobDetail" ref = " quartzTestJob" />
< property name = " startDelay" value = " 20000" />
< property name = " repeatInterval" value = " 30000" />
</ bean>
< bean id = " quartzTestJob" class = " org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean" >
< property name = " targetObject" ref = " quartzTest" > </ property>
< property name = " targetMethod" value = " autoRun" > </ property>
< property name = " concurrent" value = " false" > </ property>
</ bean>
b)CronTrigger方式:
< bean name = " quartzScheduler" class = " org.springframework.scheduling.quartz.SchedulerFactoryBean" >
< property name = " triggers" >
< list>
< ref local = " quartzTestTrigger" />
</ list>
</ property>
< property name = " startupDelay" value = " 500" />
</ bean>
< bean id = " quartzTestTrigger" class = " org.springframework.scheduling.quartz.CronTriggerFactoryBean" >
< property name = " jobDetail" ref = " quartzTestJob" />
< property name = " cronExpression" >
< value> 0 */1 * * * ?</ value>
</ property>
</ bean>
< bean id = " quartzTestJob" class = " org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean" >
< property name = " targetObject" ref = " quartzTest" > </ property>
< property name = " targetMethod" value = " autoRun" > </ property>
< property name = " concurrent" value = " false" > </ property>
</ bean>
最后,在spring主配置文件application.xml中把上面的application-quartz.xml 包含进去即可。
2.SpringBoot之旅 – 定时任务两种(Spring Schedule 与 Quartz 整合 )实现
2.1 简述
最近在项目中使用到定时任务,之前一直都是使用Quartz 来实现,最近看Spring 基础发现其实Spring 提供 Spring Schedule 可以帮助我们实现简单的定时任务功能。 下面说一下两种方式在Spring Boot 项目中的使用。
2.2 Spring Schedule 实现定时任务
Spring Schedule 实现定时任务有两种方式 1. 使用XML配置定时任务, 2. 使用 @Scheduled 注解。 因为是Spring Boot 项目 可能尽量避免使用XML配置的形式,主要说注解的形式.
Spring Schedule 提供三种形式的定时任务:
2.2.1 固定等待时间 @Scheduled(fixedDelay = 时间间隔 )
@Component
public class ScheduleJobs {
public final static long SECOND = 1 * 1000 ;
FastDateFormat fdf = FastDateFormat. getInstance ( "yyyy-MM-dd HH:mm:ss" ) ;
@Scheduled ( fixedDelay = SECOND * 2 )
public void fixedDelayJob ( ) throws InterruptedException {
TimeUnit. SECONDS. sleep ( 2 ) ;
System. out. println ( "[FixedDelayJob Execute]" + fdf. format ( new Date ( ) ) ) ;
}
}
2.2.2 固定间隔时间 @Scheduled(fixedRate = 时间间隔 )
@Component
public class ScheduleJobs {
public final static long SECOND = 1 * 1000 ;
FastDateFormat fdf = FastDateFormat. getInstance ( "yyyy-MM-dd HH:mm:ss" ) ;
@Scheduled ( fixedRate = SECOND * 4 )
public void fixedRateJob ( ) {
System. out. println ( "[FixedRateJob Execute]" + fdf. format ( new Date ( ) ) ) ;
}
}
2.2.3 Corn表达式 @Scheduled(cron = Corn表达式)
@Component public class ScheduleJobs { public final static long SECOND = 1 * 1000; FastDateFormat fdf = FastDateFormat.getInstance(“yyyy-MM-dd HH:mm:ss”);
@Scheduled(cron = "0/4 * * * * ?")
public void cronJob() {
System.out.println("[CronJob Execute]"+fdf.format(new Date()));
}
}
2.2.4 使用步骤
@SpringBootApplication
@EnableScheduling
public class TxMsgBank1Service {
public static void main ( String [ ] args) {
SpringApplication . run ( TxMsgBank1Service . class , args) ;
}
}
注解@EnableScheduling开启定时任务功能。
2.3 Spring Boot 整合 Quartz 实现定时任务
2.3.1 Spring Boot 整合 Quartz添加Maven依赖
<dependency>
<groupId>org.quartz-scheduler</groupId>
<artifactId>quartz</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
</dependency>
Spring 项目整合 Quartz 主要依靠添加 SchedulerFactoryBean 这个 FactoryBean ,所以在maven 依赖中添加 spring-context-support 。
2.3.2 配置类
首先添加 QuartzConfig 类 来声明相关Bean
@Configuration
public class QuartzConfig {
@Autowired
private SpringJobFactory springJobFactory;
@Bean
public SchedulerFactoryBean schedulerFactoryBean ( ) {
SchedulerFactoryBean schedulerFactoryBean = new SchedulerFactoryBean ( ) ;
schedulerFactoryBean. setJobFactory ( springJobFactory) ;
return schedulerFactoryBean;
}
@Bean
public Scheduler scheduler ( ) {
return schedulerFactoryBean ( ) . getScheduler ( ) ;
}
}
这里我们需要注意 我注入了一个 自定义的JobFactory ,然后 把其设置为SchedulerFactoryBean 的 JobFactory。其目的是因为我在具体的Job 中 需要Spring 注入一些Service。 所以我们要自定义一个jobfactory, 让其在具体job 类实例化时 使用Spring 的API 来进行依赖注入。
2.3.3 SpringJobFactory 具体实现:
@Component
public class SpringJobFactory extends AdaptableJobFactory {
@Autowired
private AutowireCapableBeanFactory capableBeanFactory;
@Override
protected Object createJobInstance ( TriggerFiredBundle bundle) throws Exception {
Object jobInstance = super. createJobInstance ( bundle) ;
capableBeanFactory. autowireBean ( jobInstance) ;
return jobInstance;
}
}
2.3.4 具体使用 (摘取自项目代码):
@Service
public class QuartzEventServiceImpl implements QuartzEventService {
private static final String JOB_GROUP = "event_job_group" ;
private static final String TRIGGER_GROUP = "event_trigger_group" ;
@Autowired
private Scheduler scheduler;
@Override
public void addQuartz ( Event event) throws SchedulerException {
JSONObject eventData = JSONObject. parseObject ( event. getEventData ( ) ) ;
Date triggerDate = eventData. getDate ( "date" ) ;
JobDetail job = JobBuilder. newJob ( EventJob. class) . withIdentity ( event. getId ( ) . toString ( ) , JOB_GROUP) . usingJobData ( buildJobDateMap ( event) ) . build ( ) ;
Trigger trigger = TriggerBuilder. newTrigger ( ) . withIdentity ( event. getId ( ) . toString ( ) , TRIGGER_GROUP) . startAt ( triggerDate) . build ( ) ;
scheduler. scheduleJob ( job, trigger) ;
}
cron表达式详解
Cron表达式是一个字符串,字符串以5或6个空格隔开,分为6或7个域,每一个域代表一个含义,Cron有如下两种语法格式:
(1) Seconds Minutes Hours DayofMonth Month DayofWeek Year
(2)Seconds Minutes Hours DayofMonth Month DayofWeek
一、结构
corn从左到右(用空格隔开):秒 分 小时 月份中的日期 月份 星期中的日期 年份
二、各字段的含义
字段 允许值 允许的特殊字符 秒(Seconds) 0~59的整数 , - * / 四个字符 分(Minutes ) 0~59的整数 , - * / 四个字符 小时(Hours ) 0~23的整数 , - * / 四个字符 日期(DayofMonth ) 1~31的整数(但是你需要考虑你月的天数) ,- * ? / L W C 八个字符 月份(Month ) 1~12的整数或者 JAN-DEC , - * / 四个字符 星期(DayofWeek ) 1~7的整数或者 SUN-SAT (1=SUN) , - * ? / L C # 八个字符 年(可选,留空)(Year ) 1970~2099 , - * / 四个字符
注意事项:
每一个域都使用数字,但还可以出现如下特殊字符,它们的含义是:
(1)*:表示匹配该域的任意值。假如在Minutes域使用*, 即表示每分钟都会触发事件。
(2)?:只能用在DayofMonth和DayofWeek两个域。它也匹配域的任意值,但实际不会。因为DayofMonth和DayofWeek会相互影响。例如想在每月的20日触发调度,不管20日到底是星期几,则只能使用如下写法: 13 13 15 20 * ?, 其中最后一位只能用?,而不能使用*,如果使用*表示不管星期几都会触发,实际上并不是这样。
(3)-:表示范围。例如在Minutes域使用5-20,表示从5分到20分钟每分钟触发一次
(4)/:表示起始时间开始触发,然后每隔固定时间触发一次。例如在Minutes域使用5/20,则意味着5分钟触发一次,而25,45等分别触发一次.
(5),:表示列出枚举值。例如:在Minutes域使用5,20,则意味着在5和20分每分钟触发一次。
(6)L:表示最后,只能出现在DayofWeek和DayofMonth域。如果在DayofWeek域使用5L,意味着在最后的一个星期四触发。
(7)W:表示有效工作日(周一到周五),只能出现在DayofMonth域,系统将在离指定日期的最近的有效工作日触发事件。例如:在 DayofMonth使用5W,如果5日是星期六,则将在最近的工作日:星期五,即4日触发。如果5日是星期天,则在6日(周一)触发;如果5日在星期一到星期五中的一天,则就在5日触发。另外一点,W的最近寻找不会跨过月份 。
(8)LW:这两个字符可以连用,表示在某个月最后一个工作日,即最后一个星期五。
(9)#:用于确定每个月第几个星期几,只能出现在DayofMonth域。例如在4#2,表示某月的第二个星期三。
三、常用表达式例子
(1)0 0 2 1 * ? * 表示在每月的1日的凌晨2点调整任务
(2)0 15 10 ? * MON-FRI 表示周一到周五每天上午10:15执行作业
(3)0 15 10 ? 6L 2002-2006 表示2002-2006年的每个月的最后一个星期五上午10:15执行作
(4)0 0 10,14,16 * * ? 每天上午10点,下午2点,4点
(5)0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时
(6)0 0 12 ? * WED 表示每个星期三中午12点
(7)0 0 12 * * ? 每天中午12点触发
(8)0 15 10 ? * * 每天上午10:15触发
(9)0 15 10 * * ? 每天上午10:15触发
(10)0 15 10 * * ? * 每天上午10:15触发
(11)0 15 10 * * ? 2005 2005年的每天上午10:15触发
(12)0 * 14 * * ? 在每天下午2点到下午2:59期间的每1分钟触发
(13)0 0/5 14 * * ? 在每天下午2点到下午2:55期间的每5分钟触发
(14)0 0/5 14,18 * * ? 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
(15)0 0-5 14 * * ? 在每天下午2点到下午2:05期间的每1分钟触发
(16)0 10,44 14 ? 3 WED 每年三月的星期三的下午2:10和2:44触发
(17)0 15 10 ? * MON-FRI 周一至周五的上午10:15触发
(18)0 15 10 15 * ? 每月15日上午10:15触发
(19)0 15 10 L * ? 每月最后一日的上午10:15触发
(20)0 15 10 ? * 6L 每月的最后一个星期五上午10:15触发
(21)0 15 10 ? * 6L 2002-2005 2002年至2005年的每月的最后一个星期五上午10:15触发
(22)0 15 10 ? * 6#3 每月的第三个星期五上午10:15触发
注:
(1)有些子表达式能包含一些范围或列表
例如:子表达式(天(星期))可以为 “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”表示这个月的倒数第6天,“FRIL”表示这个月的最一个星期五 注意:在使用“L”参数时,不要指定列表或范围,因为这会导致问题