Springboot系列-定时任务@Scheduled

Springboot系列-定时任务@Scheduled

前言：在平常项目的开发中，很少去实现定时任务，也就是说很少接触到@Scheduled这个注解，在之前的Spring（MVC）开发中实现定时任务一般使用@Scheduled这个注解或者第三方框架 Quartz ，那么Springboot如何实现呢？

---

因为Springboot源自Spring（MVC），所以在Springboot中也具备以上两种实现定时任务的策略

@Scheduled

首先新创建一个 Spring Boot 项目，注意如果使用Spring Initializr - > Web 创建则系统默认导入依赖并且添加 web 依赖 spring-boot-starter-web，否则记得自己添加，项目创建成功后，添加 @EnableScheduling 注解，开启定时任务：

@EnableScheduling
@SpringBootApplication
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 表示首次任务启动的延迟时间

不仅如此，@Scheduled同样支持cron表达式，如下：

• ? 表示不指定值，即不关心某个字段的取值时使用。需要注意的是，月份中的日期和星期可能会起冲突，因此在配置时这两个得有一个是 ?
• -表示区间，例如在秒上设置 “10-12”,表示 10,11,12秒都会触发
• , 用来分开多个值，例如在周字段上设置 “MON,WED,FRI” 表示周一，周三和周五触发
• / 用于递增触发，如在秒上面设置"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 表达式，每隔3秒触发一次：

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

具体cron表达式详情解释可以看百度百科

---

Quartz

一般在项目中，业务简单情况下可以使用 @Scheduled 注解来解决定时任务，在业务复杂或者其他情况下基本上都是使用 Quartz 来做定时任务。在 Spring Boot 中使用 Quartz ，只需要在创建项目时，添加 Quartz 依赖即可，如下：

添加@EnableScheduling注解

@EnableScheduling
@SpringBootApplication
public class QuartzApplication {

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

}

Quartz在使用过程中有两个关键概念，就是要做什么（WorkDetail），什么时候做（触发器），要定义WorkDetail，先要定义Work，有两种方式：

第一种方式如下：此方式先将Work注入到Spring容器中，但是没有办法传参

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

第二种方式如下：继承 QuartzJobBean 并实现默认的方法

public class MyJob2 extends QuartzJobBean {

    WorkService workService;

    public WorkService getWorkService() {
        return workService;
    }

    public void setWorkService(WorkService workService) {
        this.workService = workService;
    }

    @Override
    protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        workService.workService2();
    }
}

public class WorkService {
    public void workService() {
        System.out.println("workservice >>>"+new Date());
    }
}

和第一种方式相比，这种方式支持传参，任务启动时，executeInternal 方法将会被执行；Work1 创建完成之后，然后创建类，配置 JobDetail 和 Trigger 触发器，如下：

@Configuration
public class QuartzConfig {

    @Bean
    MethodInvokingJobDetailFactoryBean methodInvokingJobDetailFactoryBean() {
        MethodInvokingJobDetailFactoryBean bean = new MethodInvokingJobDetailFactoryBean();
        bean.setTargetBeanName("MyJob1");
        bean.setTargetMethod("workService1");
        return bean;
    }
    @Bean
    JobDetailFactoryBean jobDetailFactoryBean() {
        JobDetailFactoryBean bean = new JobDetailFactoryBean();
        bean.setJobClass(MyJob2.class);
        JobDataMap map = new JobDataMap();
        map.put("workService2",workService2());
        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
    WorkService workService2() {
        return new WorkService();
    }
}

对于以上配置解释如下：

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

结语：以上就是关于 Spring Boot 中整合两种定时任务的方法使用@Scheduled注解和Quartz框架，各其所优，因地制宜