Springboot实现定时任务的两种方式

简介

  定时任务在我们日常项目开发中会经常使用，如数据库的备份。springboot对于定时任务的实现也作了很便捷的自动化配置，实现的方式共有两种：一种是使用 Spring 自带的定时任务处理器 @Scheduled 注解，另一种就是使用第三方框架 Quartz 。

一、@Scheduled

二、Quartz

一、@Scheduled

（1）@Scheduled的实现相对简单，但是 Quartz更加灵活。首先创建spring项目，引入web依赖即可。
（2）在application启动类上加上@EnableScheduling 注解，开启定时任务

@SpringBootApplication
@EnableScheduling
public class ScheduleApplication {

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

}

（3）创建测试类，开启定时任务

    //fixedRate 表示任务执行之间的时间间隔，具体是指两次任务的开始时间间隔，即第二次任务开始时，第一次任务可能还没结束。
    @Scheduled(fixedRate = 2000)
    public void fixedRate() {
        System.out.println("fixedRate>>>"+new Date());
    }
    //fixedDelay 表示任务执行之间的时间间隔，具体是指本次任务结束到下次任务开始之间的时间间隔。
    @Scheduled(fixedDelay = 2000)
    public void fixedDelay() {
        System.out.println("fixedDelay>>>"+new Date());
    }
    //initialDelay 表示首次任务启动的延迟时间。
    @Scheduled(initialDelay = 2000,fixedDelay = 2000)
    public void initialDelay() {
        System.out.println("initialDelay>>>"+new Date());
    }

打印结果

那么如果我要自定义在每一个小时的某一分钟执行怎么办呢，那就用到了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",则表示在本月的最后一个工作日触发(一般指发工资 )

注意 : 月份中的日期和星期可能会起冲突，因此在配置时这两个得有一个是 ?

测试cron 表达式，含义是在每个小时第36分钟，从0s开始每隔5s进行打印。虽然有点绕，理清就好理解了。

//cron 表达式
    @Scheduled(cron = "0/5 40 * * * ?")
    public void cron() {
        System.out.println("cron>>"+new Date());
    }

打印结果，到第40分钟后就不再打印了

二、Quartz

schedule定时任务涉及的一般是简单的业务，Quartz一般是应对复杂的定时任务。
（1）创建sping项目。引入web和quartz的依赖

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

（2）启动类上添加@EnableScheduling注解
（3）Quartz 在使用过程中，有两个关键概念，一个是JobDetail（要做的事情），另一个是触发器（什么时候做），要定义 JobDetail，需要先定义 Job，Job 的定义有两种方式：

第一种方式，直接定义一个Bean，记住一定要注入，否则jobdetail找不到该bean，而且这种方式无法传参：

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

第二种定义方式，则是继承 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());
    }
}

和第1种方式相比，这种方式支持传参，任务启动时，executeInternal 方法将会被执行。
（4）最后要新建配置类，配置 JobDetail 和 Trigger 触发器。

@Configuration
public class QuartzConfig {
    //JobDetail 的配置有两种方式：MethodInvokingJobDetailFactoryBean 和 JobDetailFactoryBean 。

	 //使用 MethodInvokingJobDetailFactoryBean 可以配置目标 Bean 的名字和目标方法的名字，这种方式不支持传参。
    @Bean
    MethodInvokingJobDetailFactoryBean methodInvokingJobDetailFactoryBean() {
        MethodInvokingJobDetailFactoryBean bean = new MethodInvokingJobDetailFactoryBean();
        bean.setTargetBeanName("myJob1");
        bean.setTargetMethod("sayHello");
        return bean;
    }
   
   //使用 JobDetailFactoryBean 可以配置 JobDetail ，任务类继承自 QuartzJobBean ，这种方式支持传参，将参数封装在 JobDataMap 中进行传递。
    @Bean
    JobDetailFactoryBean jobDetailFactoryBean() {
        JobDetailFactoryBean bean = new JobDetailFactoryBean();
        bean.setJobClass(MyJob2.class);
        //以map的形式传递参数
        JobDataMap map = new JobDataMap();
        map.put("helloService", helloService());
        bean.setJobDataMap(map);
        return bean;
    }
    //配置触发器 下面两种触发器依次是SimpleTrigger 和 CronTrigger 
    @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();
    }
}

运行效果：job1每隔3秒执行一次，一共执行6次（因为设置的重复次数是5次）
job2每隔10s执行一次，一直执行下去