Spring Boot定时任务

1.Scheduled定时任务器
2.整合Quartz定时任务框架
3.cron表达式

1.Scheduled定时任务器

  1. 配置pom
    需要添加scheduled坐标
        
        
            org.springframework
            spring-context-support
        
  1. 编写定时任务类
    2.1 将该类添加注解@Component
    2.2 定时任务触发方式:在定时任务方法上添加注解@Scheduled(cron=""), 通过cron表达式定时触发时间
@Component
public class ScheduledDemo {
    /**
     * 定时任务方法
     */
    @Scheduled(cron = "0/2 * * * * ?")
    public void scheduledMethod(){
        System.out.println("定时器被触发" + new Date());
    }
}
  1. 在启动类中开启定时任务的使用
    3.1 启动类默认关闭定时任务,通过注解@EnableScheduling开启
@SpringBootApplication
@EnableScheduling
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

2.整合Quartz定时任务框架

  1. Quartz 的使用思路
    1)job - 任务- 你要做什么事?
    2)Trigger - 触发器- 你什么时候去做?
    3)Scheduler - 任务调度- 你什么时候需要去做什么事?

2. 使用方式(没有整合SpringBoot)

  1. 配置pom文件,添加Quartz的坐标

    org.quartz-scheduler
    quartz
    2.2.1

  1. 创建job类
    定时任务被触发时要执行什么内容
public class QuartzDemo implements Job {
    /**
     * 任务被触发时所执行的方法
     * @param jobExecutionContext
     * @throws JobExecutionException
     */
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        System.out.println("Execute..." + new Date());
    }
}
  1. 编写测试代码
    1)job - 任务- 你要做什么事?
    2)Trigger - 触发器- 你什么时候去做?
    3)Scheduler - 任务调度- 你什么时候需要去做什么事?

Trigger对象的两个设置方式
1.简单的trigger触发时间: 通过Quartz提供一个方法来完成简单的重复调用cron
2.按照cron的表达式来给定触发的时间

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

3. 使用方式(SpringBoot整合Quartz)

  1. 配置pom文件
 
        
            org.quartz-scheduler
            quartz
            2.2.1
            
                
                    slf4j-api
                    org.slf4j
                
            
        

        
        
            org.springframework
            spring-context-support
        

        
        
            org.springframework
            spring-tx
        
  1. 编写Quartz启动类
    2.1 给该类添加@Configration注解
    2.2 创建Job对象-创建Trigger对象-创建Scheduler对象
    要给三个创建对象的方法添加@Bean注解
    2.3 创建Trigger对象的两种方式
@Configuration
public class QuartzConfig {
    // 1. 创建job对象
    // 2. 创建trigger对象
    // 3. 创建Scheduler对象
    @Bean
    public JobDetailFactoryBean jobDetailFactoryBean() {
        JobDetailFactoryBean factoryBean = new JobDetailFactoryBean();
        // 关联我们自己的Job类
        factoryBean.setJobClass(QuartzDemo.class);
        return factoryBean;
    }

    // 创建trigger对象方式一:
//    @Bean
//    public SimpleTriggerFactoryBean simpleTriggerFactoryBean(JobDetailFactoryBean jobDetailFactoryBean) {
//        SimpleTriggerFactoryBean factoryBean = new SimpleTriggerFactoryBean();
//        // 关联JobDetail对象
//        factoryBean.setJobDetail(jobDetailFactoryBean.getObject());
//        // 该参数表示一个执行的毫秒数
//        factoryBean.setRepeatInterval(2000);
//        // 重复次数
//        factoryBean.setRepeatCount(5);
//        return factoryBean;
//    }
    // 创建trigger对象方式二:
    @Bean
    public CronTriggerFactoryBean cronTriggerFactoryBean(JobDetailFactoryBean jobDetailFactoryBean){
        CronTriggerFactoryBean factoryBean = new CronTriggerFactoryBean();
        // 关联JobDetail对象
        factoryBean.setJobDetail(jobDetailFactoryBean.getObject());
        // 设置触发时间
        factoryBean.setCronExpression("0/2 * * * * ?");
        return factoryBean;
    }


    @Bean
    public SchedulerFactoryBean schedulerFactoryBean(CronTriggerFactoryBean cronTriggerFactoryBean) {
        SchedulerFactoryBean factoryBean = new SchedulerFactoryBean();
        // 关联trigger
        factoryBean.setTriggers(cronTriggerFactoryBean.getObject());
        return factoryBean;
    }
}
  1. 编写启动类
    通过@EnableScheduling注解让SpringBoot打开定时任务
@SpringBootApplication
@EnableScheduling
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

4.给Job类中注入对象

public class QuartzDemo implements Job {

    @Autowired
    private UsersService usersService;

    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        System.out.println("Execute... " + new Date());
        this.usersService.addUsers();
    }
}

此时会报错:


Spring Boot定时任务_第1张图片
error

原因:
由于业务层userService不能注入
在JobDetailFactoryBean方法中
JobDetailFactoryBean factoryBean = new JobDetailFactoryBean(); factoryBean.setJobClass(QuartzDemo.class);
实例化任务类QuartzDemo时使用的是AdaptableJobFactory中的cerateJobInstance方法,是使用反射的方式来实例化的,完全没有经过spring处理,那么spring的IoC容器中也就没有该对象。
没有该对象,那么在QuartzDemo类中也就无法自动注入usersService

解决办法:
将实例化的任务对象手动添加到Spring IoC容器中,并且完成对象的注入

解决步骤
1.编写一个MyAdaptableJobFactory 解决该问题
手动编写一个方法继承AdaptableJobFactory方法,重写createJobInstance方法,将对象添加到Spring IOC容器中,并完成注入
2.修改QuartzConfig 类

//编写一个MyAdaptableJobFactory
@Component("myAdaptableJobFactory")
public class MyAdaptableJobFactory extends AdaptableJobFactory {
    @Autowired
    private AutowireCapableBeanFactory autowireCapableBeanFactory;
    @Override
    protected Object createJobInstance(TriggerFiredBundle bundle) throws Exception {
        Object obj = super.createJobInstance(bundle);
        // 将obj对象添加到Spring IOC容器中,并完成注入
        this.autowireCapableBeanFactory.autowireBean(obj);
        return obj;
    }
}

// 修改QuartzConfig 类
    @Bean
    public SchedulerFactoryBean schedulerFactoryBean(CronTriggerFactoryBean cronTriggerFactoryBean, MyAdaptableJobFactory myAdaptableJobFactory) {
        SchedulerFactoryBean factoryBean = new SchedulerFactoryBean();
        // 关联trigger
        factoryBean.setTriggers(cronTriggerFactoryBean.getObject());
        //
        factoryBean.setJobFactory(myAdaptableJobFactory);
        return factoryBean;
    }

3.cron表达式

Cron 表达式是一个字符串,分为6 或7 个域,每一个域代表一个含义
Cron 有如下两种语法格式:
(1) Seconds Minutes Hours Day Month Week Year
(2)Seconds Minutes Hours Day Month Week
一般使用6个域的

各个字段的含义

位置 时间域名 允许值 允许的特殊字符
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 , - * /
  • 星号():可用在所有字段中,表示对应时间域的每一个时刻,例如,在分钟字段时,表示“每分钟”;
  • 问号(?):该字符只在日期和星期字段中使用,它通常指定为“无意义的值”,相当于占位符;
  • 减号(-):表达一个范围,如在小时字段中使用“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 在星期字段中相当于星期日后的第一天。

  • 例子:
    @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 1 1,4,7,10 ?") //每个季度的第一个月的一号的1:00:00 执行一次
    @Scheduled(cron = "0 0 1 1 * ?")//每月一号1:00:00 执行一次
    @Scheduled(cron="0 0 1 * * *") //每天凌晨1 点执行一次

你可能感兴趣的