SpringBoot 定时任务 @Scheduled

SpringBoot 定时任务 @Scheduled

1、概述

定时任务在实际应用中使用的比较多的，就像生活中的闹钟；而在开发实现上每个框架或者系统也都会有相应的支持。而@Scheduled注解就是Spring框架中的支持方案。如果仅仅是使用Spring的话，就需要在配置文件中配置相应的配置；但是SpringBoot就可见简化很多配置程序。

2、实例

先来个简单的案例，先使用IDEA或者其他方式秒创个SpringBoot的项目。

1、先启用定时任务组件@EnableScheduling

@SpringBootApplication
@EnableScheduling 
public class ScheduledApplication {

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

}

2、新建一个类ScheduledTask，使用组件注解@Component，并且在启动类加上扫描注解@ComponentScan扫描这个包；在方法上添加注解@Scheduled。

/**
 * 定时任务
 */
@Component
public class ScheduledTask {

    @Autowired
    private ScheduledService scheduledService;

    @Scheduled(fixedDelay=3*1000)
    public void printSynch() {
        this.scheduledService.scheduled();
    }
}

@SpringBootApplication
@EnableScheduling
@ComponentScan(basePackages ={ "com.xx.scheduled.*"})
public class ScheduledApplication {

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

}

3、任务调用Service

@Service
public class ScheduledServiceImpl implements ScheduledService {

    @Override
    public void scheduled() {
        System.out.println("-----正在执行定时任务-----"+new Date().toString()+"-------");
    }
}

4、启动项目，就可以看到控制台每3秒输出一条信息

3、源码

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(Schedules.class)
public @interface Scheduled {
	String CRON_DISABLED = ScheduledTaskRegistrar.CRON_DISABLED;
	String cron() default "";
	String zone() default "";
	long fixedDelay() default -1;
	String fixedDelayString() default "";
	long fixedRate() default -1;
	String fixedRateString() default "";
	long initialDelay() default -1;
	String initialDelayString() default "";

}

参数

参数	说明	示例
cron	任务执行的cron表达式	0/3 * * * * ?
zone	cron表达时解析使用的时区,默认为服务器的本地时区,使用java.util.TimeZone#getTimeZone(String)方法解析	GMT-8:00
fixedDelay	上一次任务执行结束到下一次执行开始的间隔时间,单位为ms	1000
fixedDelayString	上一次任务执行结束到下一次执行开始的间隔时间,使用java.time.Duration#parse解析	PT15M
fixedRate	以固定间隔执行任务，即上一次任务执行开始到下一次执行开始的间隔时间,单位为ms,若在调度任务执行时,上一次任务还未执行完毕,会加入worker队列,等待上一次执行完成后立即执行下一次任务	2000
fixedRateString	与fixedRate逻辑一致,只是使用java.time.Duration#parse解析	PT15M
initialDelay	首次任务执行的延迟时间	1000
initialDelayString	首次任务执行的延迟时间,使用java.time.Duration#parse解析	PT15M

3.1、示例

1、cron
间隔上一次开始执行时间，若上一次任务没有执行完，则不会调度本次任务，跳过本次执行，等待下一次执行周期。

支持占位符

time:
  cron: */3 * * * * *
  interval: 3

 @Scheduled(cron="${time.cron}")
    void printSynch() {
        this.scheduledService.scheduled();
    }

    @Scheduled(cron="*/${time.interval} * * * * *")
    void printSynch1() {
       this.scheduledService.scheduled();
    }

2、zone
时区,和cron一起使用，指定cron按照指定时区标准执行

 @Scheduled(cron="0/3 * * * * ?",zone="GMT-8:00")
    public void printSynch() {
        this.scheduledService.scheduled();
    }

3、fixedDelay
上一次执行完毕时间点之后多长时间再执行。

@Scheduled(fixedDelay=3*1000)
    public void printSynch() {
        this.scheduledService.scheduled("fixedDelay");
    }

4、fixedDelayString
作用与fixedDelay相同，使用字符串的形式并且支持占位符

 @Scheduled(fixedDelayString="3000")
    public void printSynch() {
      this.scheduledService.scheduled();
    }

5、fixedRate
上一次开始执行时间点之后多长时间再执行，与cron不同的是在上一次任务没有执行完时，不会放弃任务，而是延顺到执行完时就执行新任务。

 @Scheduled(fixedRate=3*1000)
    public void printSynch() {
        this.scheduledService.scheduled();
    }

6、fixedRateString
作用与fixedRate相同，只是使用字符串的形式并且支持占位符。

@Scheduled(fixedRateString="3000")
    public void printSynch() {
        this.scheduledService.scheduled();
    }

7、initialDelay
使第一次延迟多长时间后再执行。

 @Scheduled(cron="0/3 * * * * ?",fixedDelay=3*1000)
    public void printSynch() {
        this.scheduledService.scheduled();
    }

8、initialDelayString
与initialDelay作用相同，使用字符串的形式并且支持占位符。

@Scheduled(cron="0/3 * * * * ?", fixedDelay=3*1000)
    public void printSynch() {
        this.scheduledService.scheduled();
    }

cron和zone组合
cron和initialDelay不可组合