SpringBoot中定时任务的实现

本文转载自博主 江南一点雨 博文 https://www.cnblogs.com/lenve/p/10728897.html

定时任务的使用场景？

视频网站购买会员后，每天会给会员赠送成长值，每月会给会员送电影卷；比如一些定时需要生成的报表，邮件等；比如一些需要定时处理的任务等；

定时任务实现的几种方式：

1）Timer：这是Java自带的java.util.Timer类，这个类允许你调度一个java.util.TimerTask任务。使用这种方式可以让你的程序按照某一个频度执行，但不能在指定时间运行，一般使用比较少。

2）Spring Task：Spring3.0以后自带的Task，可以将它看成一个轻量级的Quartz，而且使用起来比Quartz简单许多；

3）ScheduledExecutorService：也是jdk自带的一个类，是基于线程池设计的定时任务类，每个调度任务都会分配到线程池中的一个线程去执行，也就是说，任务是并发执行的，互不影响；

4）Quartz：这是一个功能比较强大的调度器，可以让你的程序在指定的时间执行，也可以按照某一个频度执行，配置起来稍显复杂。

 

第一，二种方式过于简单，在实际开发中可能使用较少，这里我们着重了解下第三，四种方式。

@Scheduled

使用@Scheduled非常容易，直接创建一个SpringBoot项目，并且添加web依赖 spring-boot-starter-web，项目创建成功后，添加@EnableScheduling注解，开启定时任务；

@SpringBootApplication
@EnableScheduling
public class ScheduledApplication {

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

}

 

接下来配置定时任务：

    @Scheduled(fixedRate = 2000)
    public void fixedRate() {
        System.out.println("fixedRate>>>"+new Date());    
    }
    @Scheduled(fixedDelay = 2000)
    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）initialDelay表示首次任务启动的延迟时间；

5）所有时间的单位都是毫秒。

上面这是一个基本用法，除了这几个基本属性外，@Scheduled注解也支持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来做定时任务，在SpringBoot中使用Quartz，只需要在创建项目时，添加Quartz依赖即可。

项目创建完成后，也需要添加开启定时任务的注解：

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

 

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

第一种方式，直接定义一个Bean：

@Component
public class MyJob1 {
    public void sayHello() {
        System.out.println("MyJob1>>>"+new Date());
    }
}

 

 

关于这种定义方式说两点：

1）首先将这个Job注册到Spring容器中；

2）这种定义方式有一个缺陷，就是无法传参。

第二种定义方式，则是继承QuartzJobBean并实现默认的构造方法：

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();
    }
}
public class HelloService {
    public void sayHello() {
        System.out.println("hello service >>>"+new Date());
    }
}

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

Job有了之后，接下来创建类，配置JobDetail和Trigger触发器，如下：

@Configuration
public class QuartzConfig {
    @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;
    }
    @Bean
    SimpleTriggerFactoryBean simpleTriggerFactoryBean() {
        SimpleTriggerFactoryBean bean = new SimpleTriggerFactoryBean();
        bean.setStartTime(new Date());
        bean.setRepeatCount(5);
        bean.setJobDetail(methodInvokingJobDetailFactoryBean().getObject());
        bean.setRepeatInterval(3000);
        return bean;
    }
    @Bean
    CronTriggerFactoryBean cronTrigger() {
        CronTriggerFactoryBean bean = new CronTriggerFactoryBean();
        bean.setCronExpression("0/10 * * * * ?");
        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();
    }
}

关于这个配置说如下几点：

1）JobDetail的配置有两种方式：MethodInvokingJobDetailFactoryBean和JobDetailFactoryBean；

2）使用MethodInvokingJobDetailFactoryBean可以配置目标Bean的名字和目标方法的名字，这种方式不支持传参；

3）使用JobDetailFactoryBean可以配置JobDetail，任务类继承自QuartzJobBean，这种方式支持传参，将参数封装在JobDataMap中进行传递；

4）Trigger是指触发器，Quartz定义了多个触发器，这里向大家展示其中两种的用法，SimpleTrigger和CronTrigger；

5）SimpleTrigger有点类似前面说的@Scheduled的基本用法；

6）CronTrigger则有点类似于@Scheduled中的cron表达式用法。

全部定义完成之后，启动SpringBoot项目就可以看到定时任务的执行了。