SpringBoot使用记录之定时任务（@Scheduled和Quartz）

一个Java小白的学习之路 个人博客 youngljx.top

定时任务

@Scheduled

1.启动类上添加 @EnableScheduling注解，开启定时任务

2.配置定时任务

/**
*  @Scheduled 注解开启一个定时任务。
*  fixedRate 表示任务执行之间的时间间隔，具体是指两次任务的开始时间间隔,
*                          即第二次任务开始时，  第一次任务可能还没结束。
*  fixedDelay 表示任务执行之间的时间间隔，具体是指本次任务结束到下次任务开始之间的时间间隔。
*  initialDelay 表示首次任务启动的延迟时间。
*  所有时间的单位都是毫秒
*/
@Component
public class MySchedule {
    @Scheduled(fixedDelay = 1000)
    public void fixedDelay() {
        System.out.println("fixedDelay:"+new Date());
    }
    @Scheduled(fixedRate = 2000)
    public void fixedRate() {
        System.out.println("fixedRate:"+new Date());
    }
    @Scheduled(initialDelay = 1000,fixedRate = 2000)
    public void initialDelay() {
        System.out.println("initialDelay:"+new Date());
    }
    @Scheduled(cron = "0 * * * * ?")
    public void cron() {
        System.out.println("cron:"+new Date());
    }
}

@Scheduled 注解也支持 cron 表达式，使用 cron 表达式，可以非常丰富的描述定时任务的时间

参考链接：http://www.javaboy.org/2019/1205/springboot-schedule.html

在线生成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”,则表示在本月的最后一个工作日触发(一般指发工资 )

Quartz

1.添加依赖

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

2.同理启动类上添加 @EnableScheduling注解，开启定时任务

3.定义Job的两种方式，简单示例

/**
 * @description:  注册为SpringBoot组件，缺点是无法传递参数
 */
@Component
public class MyFirstJob {
    public void  hello(){
        System.out.println("MyFirstJob:hello:"+new Date());
    }
}

/**
 * @description: 继承 QuartzJobBean并实现executeInternal的方法,可以传递参数
 */
public class MySecondJob extends QuartzJobBean {

    private String name;

    public void setName(String name) {
        this.name = name;
    }

    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        System.out.println("hello:"+name+":"+new Date());
    }
}

4.配置JobDetail(要执行的任务)和Trigger触发器(什么时候做)

/**
 * @description:  
 *   JobDetail 的配置有两种方式：MethodInvokingJobDetailFactoryBean 和 JobDetailFactoryBean 
 */
@Configuration
public class QuartzConfig {
    
    /**
    *  使用 MethodInvokingJobDetailFactoryBean 
    *  可以配置目标 Bean 的名字和目标方法的名字，这种方式不支持传参     
    */
    @Bean
    MethodInvokingJobDetailFactoryBean methodInvokingJobDetailFactoryBean(){
        MethodInvokingJobDetailFactoryBean bean = new MethodInvokingJobDetailFactoryBean();
        bean.setTargetBeanName("myFirstJob");
        bean.setTargetMethod("hello");
        return bean;
    }
    
    /**
    *  使用JobDetailFactoryBean 可以配置 JobDetail ，任务类继承自 QuartzJobBean, 
    *   这种方式支持传参，将参数封装在 JobDataMap 中进行传递,
    *   job中只需要提供属性名和相应的set方法即可
    */
    @Bean
    JobDetailFactoryBean jobDetailFactoryBean(){
        JobDetailFactoryBean bean = new JobDetailFactoryBean();
        JobDataMap map = new JobDataMap();
        map.put("name","ljx");
        bean.setJobDataMap(map);
        bean.setJobClass(MySecondJob.class);
        return bean;
    }

    /**
    *  SimpleTrigger 类似于前面说的 @Scheduled 的基本用法
    *   首先设置JobDetail, setStartTime设置开始时间，
    *   setRepeatInterval任务的时间间隔，setRepeatCount任务的循环次数
    */
    @Bean
    SimpleTriggerFactoryBean simpleTriggerFactoryBean(){
        SimpleTriggerFactoryBean bean = new SimpleTriggerFactoryBean();
        bean.setJobDetail(methodInvokingJobDetailFactoryBean().getObject());
        bean.setStartTime(new Date());
        bean.setRepeatInterval(2000);
        bean.setRepeatCount(3);
        return bean;
    }
   
    /**
    *  CronTrigger 类似于 @Scheduled 中 cron 表达式的用法
    *   主要配置JobDetail和Cron表达式
    */
    @Bean
    CronTriggerFactoryBean cronTriggerFactoryBean(){
        CronTriggerFactoryBean bean = new CronTriggerFactoryBean();
        bean.setJobDetail(jobDetailFactoryBean().getObject());
        bean.setCronExpression("* * * * * ?");
        return bean;
    }

    /**
    *  创建schedulerFactory，配置相应的Trigger
    */
    @Bean
    SchedulerFactoryBean schedulerFactoryBean(){
        SchedulerFactoryBean bean = new SchedulerFactoryBean();
        bean.setTriggers(simpleTriggerFactoryBean().getObject()
                         ,cronTriggerFactoryBean().getObject());
        return bean;
    }
}

SpringBoot简单使用定时任务，仅此记录