在Spring + SpringMVC中实现定时任务主要有两种方式,一种是Spring框架自带的@Scheduled注解,一种是使用第三方框架Quartz,Spring Boot 源自 Spring + SpringMVC,同样是使用这两种方式来实现定时任务。
在定时任务中,因为执行频次的问题,我们需要corn表达式。
corn表达式
cron 表达式格式
[秒] [分] [小时] [日] [月] [周] [年]
具体取值如下:
序号 | 说明 | 是否必填 | 允许填写的值 | 允许的通配符 |
---|---|---|---|---|
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 | 年 | 否 | 1970-2099 | - * / |
这一块需要大家注意的是,月份中的日期和星期可能会起冲突,因此在配置时这两个得有一个是 ?
通配符讲解:
- ?表示不指定值,即不关心某个字段的取值时使用。
- *表示所有值,例如:在秒的字段上设置 *,表示每一秒都会触发
- , 用来分开多个值,例如在周字段上设置 “MON,WED,FRI” 表示周一,周三和周五触发
- -表示区间,例如在秒上设置 “10-12”,表示 10,11,12秒都会触发
- / 用于递增触发,如在秒上面设置"5/15" 表示从5秒开始,每增15秒触发(5,20,35,50)
- ##序号(表示每月的第几个周几),例如在周字段上设置"6##3"表示在每月的第三个周六,(用 在母亲节和父亲节再合适不过了)
- 周字段的设置,若使用英文字母是不区分大小写的 ,即 MON 与mon相同
- L 表示最后的意思。在日字段设置上,表示当月的最后一天(依据当前月份,如果是二月还会自动判断是否是润年), 在周字段上表示星期六,相当于"7"或"SAT"(注意周日算是第一天)。如果在"L"前加上数字,则表示该数据的最后一个。例如在周字段上设置"6L"这样的格式,则表示"本月最后一个星期五"
- W 表示离指定日期的最近工作日(周一至周五),例如在日字段上设置"15W",表示离每月15号最近的那个工作日触发。如果15号正好是周六,则找最近的周五(14号)触发, 如果15号是周未,则找最近的下周一(16号)触发,如果15号正好在工作日(周一至周五),则就在该天触发。如果指定格式为 “1W”,它则表示每月1号往后最近的工作日触发。如果1号正是周六,则将在3号下周一触发。(注,“W"前只能设置具体的数字,不允许区间”-")
- L 和 W 可以一组合使用。如果在日字段上设置"LW",则表示在本月的最后一个工作日触发(一般指发工资 )
corn表达式举例
"0 0 10,14,16 * * ?" 每天上午10点,下午2点,4点
"0 0/30 9-17 * * ?" 朝九晚五工作时间内每半小时
"0 0 12 ? * WED" 表示每个星期三中午12点
"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触发
学习了corn表达式,接下来我们就来学习定时任务的两种实现方式
@Scheduled
实现定时任务,首先需要开启定时任务
@SpringBootApplication
@EnableScheduling //开启定时任务
public class Springboot2trainApplication {
public static void main(String[] args) {
SpringApplication.run(Springboot2trainApplication.class, args);
}
}
实现定时任务类
@Component
public class MyScheduled {
/**
* 首先使用 @Scheduled 注解开启一个定时任务。
* fixedRate 表示任务执行之间的时间间隔,具体是指两次任务的开始时间间隔,即第二次任务开始时,第一次任务可能还没结束。
*/
@Scheduled(fixedRate = 2000)
public void fixedRate() {
System.out.println("fixedRate>>>"+new Date());
}
/**
* fixedDelay 表示任务执行之间的时间间隔,具体是指本次任务结束到下次任务开始之间的时间间隔。
*/
@Scheduled(fixedDelay = 2000)
public void fixedDelay() {
System.out.println("fixedDelay>>>"+new Date());
}
/**
* initialDelay 表示首次任务启动的延迟时间。
*/
@Scheduled(initialDelay = 2000,fixedDelay = 2000)
public void initialDelay() {
System.out.println("initialDelay>>>"+new Date());
}
/**
* cron 表达式,每隔5秒触发一次
*/
@Scheduled(cron = "0/5 * * * * *")
public void cron() {
System.out.println("cron>>>"+new Date());
}
}
Quartz
首先,引入jar包
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-quartz</artifactId>
</dependency>
同样实现定时任务,首先需要开启定时任务
@SpringBootApplication
@EnableScheduling //开启定时任务
public class Springboot2trainApplication {
public static void main(String[] args) {
SpringApplication.run(Springboot2trainApplication.class, args);
}
}
使用Quartz,有两种实现Job任务的方式
第一种方式,直接定义一个Bean:
/**
* 关于这种定义方式说两点:
* 首先将这个 Job 注册到 Spring 容器中。
* 这种定义方式有一个缺陷,就是无法传参。
*/
@Component
public class MyJob1 {
public void sayHello() {
System.out.println("MyJob1>>>"+new Date());
}
}
第二种定义方式,则是继承 QuartzJobBean 并实现默认的方法:
public class HelloService {
public void sayHello() {
System.out.println("hello service >>>"+new Date());
}
}
public class MyJob2 extends QuartzJobBean {
HelloService helloService;
public HelloService getHelloService() {
return helloService;
}
public void setHelloService(HelloService helloService) {
this.helloService = helloService;
}
@Override
protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
helloService.sayHello();
}
}
然后配置 JobDetail 和 Trigger 触发器
@Configuration
public class QuartzConfig {
/**
* 使用 MethodInvokingJobDetailFactoryBean 可以配置目标 Bean 的名字和目标方法的名字,这种方式不支持传参。
* @return
*/
@Bean
MethodInvokingJobDetailFactoryBean methodInvokingJobDetailFactoryBean() {
MethodInvokingJobDetailFactoryBean bean = new MethodInvokingJobDetailFactoryBean();
bean.setTargetBeanName("myJob1");
bean.setTargetMethod("sayHello");
return bean;
}
/**
* 使用 JobDetailFactoryBean 可以配置 JobDetail ,任务类继承自 QuartzJobBean ,这种方式支持传参,将参数封装在 JobDataMap 中进行传递。
* @return
*/
@Bean
JobDetailFactoryBean jobDetailFactoryBean() {
JobDetailFactoryBean bean = new JobDetailFactoryBean();
bean.setJobClass(MyJob2.class);
JobDataMap map = new JobDataMap();
map.put("helloService", helloService());
bean.setJobDataMap(map);
return bean;
}
/**
* SimpleTrigger 有点类似于前面说的 @Scheduled 的基本用法。
* @return
*/
@Bean
SimpleTriggerFactoryBean simpleTriggerFactoryBean() {
SimpleTriggerFactoryBean bean = new SimpleTriggerFactoryBean();
bean.setStartTime(new Date());
bean.setRepeatCount(2);//执行次数
bean.setJobDetail(methodInvokingJobDetailFactoryBean().getObject());
bean.setRepeatInterval(3000);//3秒间隔
return bean;
}
/**
* CronTrigger 则有点类似于 @Scheduled 中 cron 表达式的用法。
* @return
*/
@Bean
CronTriggerFactoryBean cronTrigger() {
CronTriggerFactoryBean bean = new CronTriggerFactoryBean();
bean.setCronExpression("0 0 12 * * ?");//每天12点
bean.setJobDetail(jobDetailFactoryBean().getObject());
return bean;
}
@Bean
SchedulerFactoryBean schedulerFactoryBean() {
SchedulerFactoryBean bean = new SchedulerFactoryBean();
bean.setTriggers(cronTrigger().getObject(), simpleTriggerFactoryBean().getObject());
return bean;
}
@Bean
HelloService helloService() {
return new HelloService();
}
}
Trigger 是指触发器,Quartz 中定义了多个触发器,这里向大家展示其中两种的用法,SimpleTrigger 和 CronTrigger 。
测试
启动项目就可以看到运行结果