Spring Boot中的定时任务

在spring+springmvc中，我们如果要实现一个定时任务的话，可以有两种方式，一是使用@Scheduled注解,另外一种方式就是使用第三方框架Quartz，而spring boot是基于spring+springmvc的一种增强，当然也具备了这两种方式实现定时任务了，下面我们来看看这两种方式的具体实现

通过注解@Scheduled实现定时任务

创建spring boot项目，在Web中选择Spring Web Starter即可，项目创建计算创建完成了

我们在启动类中添加@EnableScheduling注解，开启定时任务，然后我们就可以配置定时任务了，下面就在启动类中配置定时任务

package com.zhouym.timingtasks;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;

import java.util.Date;

@SpringBootApplication
@EnableScheduling
public class TimingtasksApplication {

    public static void main(String[] args) {
        SpringApplication.run(TimingtasksApplication.class, args);
    }

    @Scheduled(fixedRate = 2000)
    public void fixedRate() {
        System.out.println("fixedRate：" + new Date());
    }

    @Scheduled(fixedDelay = 3000)
    public void fixedDelay() {
        System.out.println("fixedDelay：" + new Date());
    }

    @Scheduled(initialDelay = 2000, fixedDelay = 2000)
    public void initialDelay() {
        System.out.println("initialDelay：" + new Date());
    }
   
}

1、@Scheduled注解表示开启一个定时任务
2、fixedRate属性表示任务执行之间的间隔时间，就是两次任务的开始时间间隔，即第二次任务开始时，第一次任务可能还没结束
3、fixedDelay表示任务执行之间的时间间隔，具体是指本次任务结束到下次任务开始之间的时间间隔
4、initiaDelay表示首次任务启动的延时时间
5、时间单位是毫秒

除了这几个基本属性之外，@Scheduled 注解也支持 cron 表达式，使用 cron 表达式，可以非常丰富的描述定时任务的时间。cron 表达式格式如下：
[秒] [分] [小时] [日] [月] [周] [年]
具体取值如下：

需要注意的是，月份中的日期和星期可能会起冲突，因此在配置时这两个得有一个是 ?
通配符含义：

? 表示不指定值，即不关心某个字段的取值时使用。需要注意的是，月份中的日期和星期可能会起冲突，因此在配置时这两个得有一个是 ?
* 表示所有值，例如:在秒的字段上设置 *,表示每一秒都会触发
, 用来分开多个值，例如在周字段上设置 “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”,则表示在本月的最后一个工作日触发(一般指发工资 )

在 @Scheduled 注解中来一个简单的 cron 表达式，每隔5秒触发一次，如下：

@Scheduled(cron = "0/5 * * * * *")
public void cron() {
    System.out.println(new Date());
}

通过第三方框架Quartz实现定时任务

在上面说的通过@Scheduled注解来实现定时任务，对于一些简单的定时任务还可以处理，复杂的一些定时任务就得Quartz来实现了，下面来看看具体的实现

创建spring boot项目，导入quartz依赖即可

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-quartz</artifactId>
</dependency>
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
</dependency>

也需要在启动类上面添加@EnableScheduling注解

package com.zhouym.quartz;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

@SpringBootApplication
@EnableScheduling
public class QuartzApplication {

    public static void main(String[] args) {
        SpringApplication.run(QuartzApplication.class, args);
    }

}

Quartz 在使用过程中，有两个关键概念，一个是JobDetail（要做的任务），另一个是触发器（什么时候做），要定义 JobDetail，需要先定义 Job，Job 的定义有两种方式：

第一种方式

package com.zhouym.quartz;

import org.springframework.stereotype.Component;

import java.util.Date;

/**
 * 〈〉
 *
 * @author zhouym
 * @create 2019/8/9
 * @since 1.0.0
 */
@Component
public class MyJob1 {

    public void sayHello(){
        System.out.println("myjob1："+new Date());
    }
}

通过@Component注解将MyJob1注册到spring容器中，交给容器管理，这种是无法进行参数传递的，这也是它的一种缺陷

第二种方式，我们通过继承QuartzJobBean实现默认方法

package com.zhouym.quartz;

import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.scheduling.quartz.QuartzJobBean;

import java.util.Date;

/**
 * 〈〉
 *
 * @author zhouym
 * @create 2019/8/9
 * @since 1.0.0
 */

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();
    }
}

创建一个helloservice类，定义方法

package com.zhouym.quartz;

import java.util.Date;

/**
 * 〈〉
 *
 * @author zhouym
 * @create 2019/8/9
 * @since 1.0.0
 */
public class HelloService {
    public void sayHello(){
        System.out.println("helloService："+new Date());
    }
}

和第1种方式相比，这种方式支持传参，任务启动时，executeInternal 方法将会被执行。

有了job，接下来创建quartz配置类，配置触发器

package com.zhouym.quartz;

import org.quartz.JobDataMap;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.quartz.*;

import java.util.Date;

/**
 * 〈触发器配置类〉
 *
 * @author zhouym
 * @create 2019/8/9
 * @since 1.0.0
 */
@Configuration
public class QuartzConfig {

    //JobDetail触发器
    @Bean
    MethodInvokingJobDetailFactoryBean methodInvokingJobDetailFactoryBean(){
        MethodInvokingJobDetailFactoryBean bean = new MethodInvokingJobDetailFactoryBean();
        bean.setTargetBeanName("myJob1");
        bean.setTargetMethod("sayHello");
        return bean;
    }
    @Bean
    JobDetailFactoryBean jobDetailFactoryBean(){
        JobDetailFactoryBean bean = new JobDetailFactoryBean();
        bean.setJobClass(MyJob2.class);
        JobDataMap map = new JobDataMap();
        map.put("helloService",helloService());
        bean.setJobDataMap(map);
        return bean;

    }

    //Trigger触发器
    @Bean
    SimpleTriggerFactoryBean simpleTriggerFactoryBean(){
        SimpleTriggerFactoryBean bean = new SimpleTriggerFactoryBean();
        //设置开始的时间
        bean.setStartTime(new Date());
        //设置重复次数
        bean.setRepeatCount(5);
        //绑定触发器
        bean.setJobDetail(methodInvokingJobDetailFactoryBean().getObject());
        //设置重复的间隔时间
        bean.setRepeatInterval(2000);
        return bean;
    }
    @Bean
    CronTriggerFactoryBean cronTriggerFactoryBean(){
        CronTriggerFactoryBean bean = new CronTriggerFactoryBean();
        //设置定时任务的表达式
        bean.setCronExpression("0/5 * * * * ?");
        //绑定触发器
        bean.setJobDetail(jobDetailFactoryBean().getObject());
        return bean;
    }
    @Bean
    SchedulerFactoryBean schedulerFactoryBean(){
        SchedulerFactoryBean bean = new SchedulerFactoryBean();
        bean.setTriggers(simpleTriggerFactoryBean().getObject(),cronTriggerFactoryBean().getObject());
        return bean;
    }

    @Bean
    HelloService helloService(){
        return new HelloService();
    }

}

关于这个配置说如下几点：
1、 JobDetail 的配置有两种方式：MethodInvokingJobDetailFactoryBean 和 JobDetailFactoryBean 。
2、使用 MethodInvokingJobDetailFactoryBean 可以配置目标 Bean 的名字和目标方法的名字，这种方式不支持传参。
3、 使用 JobDetailFactoryBean 可以配置 JobDetail ，任务类继承自 QuartzJobBean ，这种方式支持传参，将参数封装在 JobDataMap 中进行传递。
4、Trigger 是指触发器，Quartz 中定义了多个触发器，这里向大家展示其中两种的用法，SimpleTrigger 和 CronTrigger 。
5、SimpleTrigger 有点类似于前面说的 @Scheduled 的基本用法。
6、CronTrigger 则有点类似于 @Scheduled 中 cron 表达式的用法。

我们运行启动类，来看看控制台的输出结果