Spring Boot 2.x实战之定时任务调度

本文首发于个人网站：Spring Boot 2.x实战之定时任务调度

在后端开发中，有些场景是需要使用定时任务的，例如：定时同步一批数据、定时清理一些数据，在Spring Boot中提供了@Scheduled注解就提供了定时调度的功能，对于简单的、单机的调度方案是足够了的。这篇文章准备用实际案例看下@Scheduled的用法。

1. 新建Spring Boot工程，主pom文件内容如下：

   
   
   	4.0.0
   	
   		org.springframework.boot
   		spring-boot-starter-parent
   		2.2.2.RELEASE
   		 
   	
   	online.javaadu.schedule
   	scheduledemo
   	0.0.1-SNAPSHOT
   	scheduledemo
   	Demo project for Spring Boot
   
   	
   		1.8
   	
   
   	
   		
   			org.springframework.boot
   			spring-boot-starter
   		
   
   		
   			org.projectlombok
   			lombok
   			true
   		
   		
   			org.springframework.boot
   			spring-boot-starter-test
   			test
   			
   				
   					org.junit.vintage
   					junit-vintage-engine
   				
   			
   		
   	
   
   	
   		
   			
   				org.springframework.boot
   				spring-boot-maven-plugin
   			
   		
   	
   
   
   

2. 新建定时任务组件，使用@Scheduled注解修饰要调度的方法，在该方法中会打印当前的时间。

   package online.javaadu.schedule.scheduledemo;
   
   import org.slf4j.Logger;
   import org.slf4j.LoggerFactory;
   import org.springframework.scheduling.annotation.Scheduled;
   import org.springframework.stereotype.Component;
   
   import java.text.SimpleDateFormat;
   import java.util.Date;
   
   @Component
   public class ScheduledTasks {
   
       private static final Logger log = LoggerFactory.getLogger(ScheduledTasks.class);
   
       private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");
   
     	//第一次执行之前延后10秒钟；后续每隔5秒执行1次
       @Scheduled(fixedRate = 5000, initialDelay = 10000)
       public void reportCurrentTime() {
    log.info("The time is now {}", dateFormat.format(new Date()));
       }
   }
   

3. 在ScheduledemoApplication中开启定时调度能力——即开启@Scheduled注解的定时调度功能，并在系统刚起来的时候打印一行日志，用来体现上一步中的initialDelay的作用。

   package online.javaadu.schedule.scheduledemo;
   
   import org.slf4j.Logger;
   import org.slf4j.LoggerFactory;
   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   import org.springframework.scheduling.annotation.EnableScheduling;
   
   import java.text.SimpleDateFormat;
   import java.util.Date;
   
   @SpringBootApplication
   @EnableScheduling
   public class ScheduledemoApplication {
   
   	private static final Logger log = LoggerFactory.getLogger(ScheduledTasks.class);
   	private static final SimpleDateFormat dateFormat = new SimpleDateFormat("HH:mm:ss");
   
   	public static void main(String[] args) {
   		SpringApplication.run(ScheduledemoApplication.class, args);
   		log.info("---The time is now {}", dateFormat.format(new Date()));
   	}
   
   }
   

4. 点击运行后，该demo的运行结果如下，可以看出，23:15:35应用启动，过了10秒钟定时调度任务才开始执行，然后是每隔5秒钟打印一次时间。

@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 "";

}