Spring Boot定时任务

Spring Boot定时任务

（SpringBoot高级）

 Scheduled定时任务器

 整合Quartz定时任务框架

一、         Scheduled定时任务器

Scheduled定时任务器：是Spring3.0以后自带的一个定时任务器。

1         在pom文件中添加Scheduled的坐标

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">   <modelVersion>4.0.0</modelVersion>   <parent>     <groupId>org.springframework.boot</groupId>     <artifactId>spring-boot-starter-parent</artifactId>     <version>1.5.10.RELEASE</version>   </parent>   <groupId>com.bjsxt</groupId>   <artifactId>25-spring-boot-scheduled</artifactId>   <version>0.0.1-SNAPSHOT</version>     <properties>   <java.version>1.7</java.version>   <thymeleaf.version>3.0.2.RELEASE</thymeleaf.version>   <thymeleaf-layout-dialect.version>2.0.4</thymeleaf-layout-dialect.version>   </properties>     <dependencies>     <!-- springBoot的启动器 -->     <dependency>         <groupId>org.springframework.boot</groupId>         <artifactId>spring-boot-starter-web</artifactId>     </dependency>     <!-- springBoot的启动器 -->     <dependency>         <groupId>org.springframework.boot</groupId>         <artifactId>spring-boot-starter-thymeleaf</artifactId>     </dependency>     <!-- 添加Scheduled坐标 -->     <dependency>         <groupId>org.springframework</groupId>         <artifactId>spring-context-support</artifactId>     </dependency>   </dependencies> </project>

2         编写定时任务类

/**  * Scheduled定时任务  *  *  */ @Component publicclass ScheduledDemo {       /**      * 定时任务方法      * @Scheduled:设置定时任务      * cron属性：cron表达式。定时任务触发是时间的一个字符串表达形式      */     @Scheduled(cron="0/2 * * * * ?")     publicvoid scheduledMethod(){         System.out.println("定时器被触发"+new Date());     } }

 

3         在启动类中开启定时任务的使用

/**  *  *Scheduled  *  */ @SpringBootApplication @EnableScheduling publicclass App {       publicstaticvoid main(String[] args) {         SpringApplication.run(App.class, args);     } }

4         cron表达式讲解

Cron表达式是一个字符串，分为6或7个域，每一个域代表一个含义

Cron有如下两种语法格式：

（1） Seconds Minutes Hours Day MonthWeek Year

（2）Seconds Minutes Hours Day Month Week

一、结构

corn从左到右（用空格隔开）：秒分小时月份中的日期月份星期中的日期年份

二、各字段的含义

位置	时间域名	允许值	允许的特殊字符
1	秒	0-59	, - * /
2	分钟	0-59	, - * /
3	小时	0-23	, - * /
4	日	1-31	, - * / L W C
5	月	1-12	, - * /
6	星期	1-7	, - * ? / L C #
7	年(可选)	1970-2099	, - * /

 

Cron表达式的时间字段除允许设置数值外，还可使用一些特殊的字符，提供列表、范围、通配符等功能，细说如下：

●星号(*)：可用在所有字段中，表示对应时间域的每一个时刻，例如，*在分钟字段时，表示“每分钟”；

●问号（?）：该字符只在日期和星期字段中使用，它通常指定为“无意义的值”，相当于占位符；

●减号(-)：表达一个范围，如在小时字段中使用“10-12”，则表示从10到12点，即10,11,12；

●逗号(,)：表达一个列表值，如在星期字段中使用“MON,WED,FRI”，则表示星期一，星期三和星期五；

●斜杠(/)：x/y表达一个等步长序列，x为起始值，y为增量步长值。如在分钟字段中使用0/15，则表示为0,15,30和45秒，而5/15在分钟字段中表示5,20,35,50，你也可以使用*/y，它等同于0/y；

●L：该字符只在日期和星期字段中使用，代表“Last”的意思，但它在两个字段中意思不同。L在日期字段中，表示这个月份的最后一天，如一月的31号，非闰年二月的28号；如果L用在星期中，则表示星期六，等同于7。但是，如果L出现在星期字段里，而且在前面有一个数值X，则表示“这个月的最后X天”，例如，6L表示该月的最后星期五；

●W：该字符只能出现在日期字段里，是对前导日期的修饰，表示离该日期最近的工作日。例如15W表示离该月15号最近的工作日，如果该月15号是星期六，则匹配14号星期五；如果15日是星期日，则匹配16号星期一；如果15号是星期二，那结果就是15号星期二。但必须注意关联的匹配日期不能够跨月，如你指定1W，如果1号是星期六，结果匹配的是3号星期一，而非上个月最后的那天。W字符串只能指定单一日期，而不能指定日期范围；

●LW组合：在日期字段可以组合使用LW，它的意思是当月的最后一个工作日；

●井号(#)：该字符只能在星期字段中使用，表示当月某个工作日。如6#3表示当月的第三个星期五(6表示星期五，#3表示当前的第三个)，而4#5表示当月的第五个星期三，假设当月没有第五个星期三，忽略不触发；

● C：该字符只在日期和星期字段中使用，代表“Calendar”的意思。它的意思是计划所关联的日期，如果日期没有被关联，则相当于日历中所有日期。例如5C在日期字段中就相当于日历5日以后的第一天。1C在星期字段中相当于星期日后的第一天。

Cron表达式对特殊字符的大小写不敏感，对代表星期的缩写英文大小写也不敏感。

 

例子:

@Scheduled(cron = "0 0 1 1 1?")//每年一月的一号的1:00:00 执行一次

 

@Scheduled(cron = "0 0 1  1 1,6?") //一月和六月的一号的1:00:00 执行一次

 

@Scheduled(cron = "0 0 1  11,4,7,10 ?") //每个季度的第一个月的一号的1:00:00 执行一次

 

@Scheduled(cron = "0 0 1  1 *?")//每月一号 1:00:00 执行一次

  

@Scheduled(cron="0 0 1 * * *")//每天凌晨1点执行一次

 

 

二、         Spring Boot 整合 Quartz定时任务框架

1         Quartz的介绍以及Quartz的使用思路

1.1     Quartz的介绍

1.2     Quartz的使用思路

1）job - 任务 - 你要做什么事？

2）Trigger - 触发器 - 你什么时候去做？

3）Scheduler - 任务调度 - 你什么时候需要去做什么事？

 

 

2         Quartz的基本使用方式

2.1     创建项目

2.2     修改pom文件添加Quartz的坐标

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">     <modelVersion>4.0.0</modelVersion>     <groupId>com.bjsxt</groupId>     <artifactId>26-quartz-demo</artifactId>     <version>0.0.1-SNAPSHOT</version>       <dependencies>         <!-- Quartz坐标 -->         <dependency>             <groupId>org.quartz-scheduler</groupId>             <artifactId>quartz</artifactId>             <version>2.2.1</version>         </dependency>     </dependencies> </project>

2.3     创建Job类

/**  * 定义任务类  *  *  */ publicclass QuartzDemo implements Job {       /**      * 任务被触发时所执行的方法      */     publicvoid execute(JobExecutionContext arg0) throws JobExecutionException {         System.out.println("Execute...."+new Date());     }   }

 

2.4     编写测试代码

publicclass QuartzMain {       publicstaticvoid main(String[] args) throws Exception {           // 1.创建Job对象：你要做什么事？         JobDetail job = JobBuilder.newJob(QuartzDemo.class).build();           /**          * 简单的trigger触发时间：通过Quartz提供一个方法来完成简单的重复调用 cron          * Trigger：按照Cron的表达式来给定触发的时间          */         // 2.创建Trigger对象：在什么时间做？         /*Trigger trigger = TriggerBuilder.newTrigger().withSchedule(SimpleScheduleBuilder.repeatSecondlyForever())                 .build();*/                         Trigger trigger = TriggerBuilder.newTrigger().withSchedule(CronScheduleBuilder.cronSchedule("0/2 * * * * ?"))                 .build();           // 3.创建Scheduler对象：在什么时间做什么事？         Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();         scheduler.scheduleJob(job, trigger);                 //启动         scheduler.start();     }   }

 

 

 

3         .Spring Boot整合Quartz定时框架

3.1     修改pom文件添加坐标

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">     <modelVersion>4.0.0</modelVersion>     <parent>         <groupId>org.springframework.boot</groupId>         <artifactId>spring-boot-starter-parent</artifactId>         <version>1.5.10.RELEASE</version>     </parent>     <groupId>com.bjsxt</groupId>     <artifactId>27-spring-boot-quartz</artifactId>     <version>0.0.1-SNAPSHOT</version>       <properties>         <java.version>1.7</java.version>         <thymeleaf.version>3.0.2.RELEASE</thymeleaf.version>         <thymeleaf-layout-dialect.version>2.0.4</thymeleaf-layout-dialect.version>     </properties>       <dependencies>         <!-- springBoot的启动器 -->         <dependency>             <groupId>org.springframework.boot</groupId>             <artifactId>spring-boot-starter-web</artifactId>         </dependency>         <!-- springBoot的启动器 -->         <dependency>             <groupId>org.springframework.boot</groupId>             <artifactId>spring-boot-starter-thymeleaf</artifactId>         </dependency>           <!-- Quartz坐标 -->         <dependency>             <groupId>org.quartz-scheduler</groupId>             <artifactId>quartz</artifactId>             <version>2.2.1</version>             <exclusions>                 <exclusion>                     <artifactId>slf4j-api</artifactId>                     <groupId>org.slf4j</groupId>                 </exclusion>             </exclusions>         </dependency>           <!-- 添加Scheduled坐标 -->         <dependency>             <groupId>org.springframework</groupId>             <artifactId>spring-context-support</artifactId>         </dependency>           <!-- Sprng tx 坐标 -->         <dependency>             <groupId>org.springframework</groupId>             <artifactId>spring-tx</artifactId>         </dependency>     </dependencies> </project>

 

 

3.2     编写Quartz的启动类

/**  * Quartz配置类  *  *  */ @Configuration publicclass QuartzConfig {           /**      * 1.创建Job对象      */     @Bean     public JobDetailFactoryBean jobDetailFactoryBean(){         JobDetailFactoryBean factory = new JobDetailFactoryBean();         //关联我们自己的Job类         factory.setJobClass(QuartzDemo.class);         returnfactory;     }         /**      * 2.创建Trigger对象      * 简单的Trigger      */     @Bean     public SimpleTriggerFactoryBean simpleTriggerFactoryBean(JobDetailFactoryBean jobDetailFactoryBean){         SimpleTriggerFactoryBean factory = new SimpleTriggerFactoryBean();         //关联JobDetail对象         factory.setJobDetail(jobDetailFactoryBean.getObject());         //该参数表示一个执行的毫秒数         factory.setRepeatInterval(2000);         //重复次数         factory.setRepeatCount(5);         returnfactory;     }         /**      * 3.创建Scheduler对象      */     @Bean     public SchedulerFactoryBean schedulerFactoryBean(SimpleTriggerFactoryBean simpleTriggerFactoryBean){         SchedulerFactoryBean factory = new SchedulerFactoryBean();         //关联trigger         factory.setTriggers(simpleTriggerFactoryBean.getObject());                 returnfactory;     } }

3.3     修改启动类

/**  *  *spring Boot 整合Quartz案例  *  */ @SpringBootApplication @EnableScheduling publicclass App {       publicstaticvoid main(String[] args) {         SpringApplication.run(App.class, args);     } }

 

 

4         Job类中注入对象

4.1     注入时会产生异常

因为在这个过程之中，原码是通过反射的机制来创建对象的，所以创建好的对象不是在springioc容器当中的

 因此会报一个空指针异常，原码就是通过反射将创建的对象直接返回

解决的办法就是手动重写原码的方法，然后将创建好的对象手动放置到springioc容器当中

也可以直接手动的去new出一个对象，最为简单直接

4.2     编写一个MyAdaptableJobFactory解决该问题

@Component("myAdaptableJobFactory") publicclass MyAdaptableJobFactory extends AdaptableJobFactory {       //AutowireCapableBeanFactory 可以将一个对象添加到SpringIOC容器中，并且完成该对象注入     @Autowired     private AutowireCapableBeanFactory autowireCapableBeanFactory;         /**      * 该方法需要将实例化的任务对象手动的添加到springIOC容器中并且完成对象的注入      */     @Override     protected Object createJobInstance(TriggerFiredBundle bundle) throws Exception {         Object obj = super.createJobInstance(bundle);         //将obj对象添加Spring IOC容器中，并完成注入         this.autowireCapableBeanFactory.autowireBean(obj);         returnobj;     }   }

 

4.3     修改QuartzConfig类

/**  * Quartz配置类  *  *  */ @Configuration publicclass QuartzConfig {           /**      * 1.创建Job对象      */     @Bean     public JobDetailFactoryBean jobDetailFactoryBean(){         JobDetailFactoryBean factory = new JobDetailFactoryBean();         //关联我们自己的Job类         factory.setJobClass(QuartzDemo.class);         returnfactory;     }         /**      * 2.创建Trigger对象      * 简单的Trigger      */     /*@Bean     public SimpleTriggerFactoryBean simpleTriggerFactoryBean(JobDetailFactoryBean jobDetailFactoryBean){         SimpleTriggerFactoryBean factory = new SimpleTriggerFactoryBean();         //关联JobDetail对象         factory.setJobDetail(jobDetailFactoryBean.getObject());         //该参数表示一个执行的毫秒数         factory.setRepeatInterval(2000);         //重复次数         factory.setRepeatCount(5);         return factory;     }*/         /**      * Cron Trigger      */     @Bean     public CronTriggerFactoryBean cronTriggerFactoryBean(JobDetailFactoryBean jobDetailFactoryBean){         CronTriggerFactoryBean factory = new CronTriggerFactoryBean();         factory.setJobDetail(jobDetailFactoryBean.getObject());         //设置触发时间         factory.setCronExpression("0/2 * * * * ?");         returnfactory;     }         /**      * 3.创建Scheduler对象      */     @Bean     public SchedulerFactoryBean schedulerFactoryBean(CronTriggerFactoryBean cronTriggerFactoryBean,MyAdaptableJobFactory myAdaptableJobFactory){         SchedulerFactoryBean factory = new SchedulerFactoryBean();         //关联trigger         factory.setTriggers(cronTriggerFactoryBean.getObject());         factory.setJobFactory(myAdaptableJobFactory);         returnfactory;     } }