我们在编写Spring Boot应用中经常会遇到这样的场景，比如：我需要定时地发送一些短信、邮件之类的操作，也可能会定时地检查和监控一些标志、参数等。

一、创建定时任务

在Spring Boot中编写定时任务是非常简单的事，下面通过实例介绍如何在Spring Boot中创建定时任务，实现每过5秒输出一下当前时间。

  • 在Spring Boot的主类中加入 @EnableScheduling 注解，启用定时任务的配置 ```java package com.wells.demo.async;

import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.scheduling.annotation.EnableScheduling; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication @Configuration @EnableSwagger2 @EnableScheduling public class AsyncApplication {

  1. public static void main(String[] args) {
  2.     SpringApplication.run(AsyncApplication.class, args);
  3. }
  5. @Bean
  6. public Docket createRestApi() {
  7.     return new Docket(DocumentationType.SWAGGER_2)
  8.             .apiInfo(apiInfo())
  9.             .select()
  10.             .apis(RequestHandlerSelectors.basePackage("com.wells.demo.quartz"))
  11.             .paths(PathSelectors.any())
  12.             .build();
  13. }
  15. private ApiInfo apiInfo() {
  16.     return new ApiInfoBuilder()
  17.             .title("Spring Boot Quartz")
  18.             .description("更多Spring Boot相关文章请关注：https://www.yuque.com/wells/micro.service")
  19.             .contact(new Contact("wells", "", ""))
  20.             .version("2.0")
  21.             .build();
  23. }

}


- 创建定时任务实现类
```java
package com.wells.demo.async.schedule;

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

/**
 * Created by Wells on 2019年01月14日
 * 定时任务
 */

@Component
public class ScheduleJob {
    private DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofPattern("yyyy-MM-HH HH:mm:ss");

    @Scheduled(fixedRate = 5000)
    public void reportCurrentTime() {
        System.out.println("current time: " + dateTimeFormatter.format(LocalDateTime.now()));
    }
}
  • 运行程序，控制台中可以看到类似如下输出，定时任务开始正常运作了。

image.png

二、@Scheduled定时

在上面的入门例子中，使用了@Scheduled(fixedRate = 5000) 注解来定义每过5秒执行的任务，对于@Scheduled的使用可以总结如下几种方式：

  • @Scheduled(fixedRate = 5000) ：上一次开始执行时间点之后5秒再执行
  • @Scheduled(fixedDelay = 5000) ：上一次执行完毕时间点之后5秒再执行
  • @Scheduled(initialDelay=1000, fixedRate=5000) ：第一次延迟1秒后执行，之后按fixedRate的规则每5秒执行一次
  • @Scheduled(cron=”/5 “) ：通过cron表达式定义规则

三、代码示例

SpringBoot Schedule

参考

https://spring.io/guides/gs/scheduling-tasks/