1 Spring Boot定时任务和异步调用

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

spring boot定时任务spring-boot-jsp项目源码：

码云地址：https://git.oschina.net/wyait/springboot1.5.4.git

github地址：https://github.com/wyait/spring-boot-1.5.4.git

1.1 创建定时任务

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

1，在Spring Boot的主类中加入@EnableScheduling注解，启用定时任务的配置

// 这是一个配置Spring的配置类

@Configuration

// @SpringBootApplication：Spring Boot项目的核心注解，主要目的是开启自动配置。

@SpringBootApplication

@EnableScheduling//开启定时任务

public class DemoApplication {

publicstatic void main(String[] args) {

//启动spring boot应用

SpringApplicationsa = new SpringApplication(DemoApplication.class);

//禁用devTools热部署

System.setProperty("spring.devtools.restart.enabled","false");

//禁用命令行更改application.properties属性

sa.setAddCommandLineProperties(false);

sa.run(args);

}

2，创建定时任务实现类：

@Component

public class ScheduledTasks {

private static final SimpleDateFormatdateFormat = new SimpleDateFormat("HH:mm:ss");

@Scheduled(fixedRate = 5000)

public void reportCurrentTime() {

System.out.println("现在时间：" +dateFormat.format(new Date()));

}

3，运行程序，控制台中可以看到类似如下输出，定时任务开始正常运作了

关于上述的简单入门示例也可以参见官方的Scheduling Tasks：https://spring.io/guides/gs/scheduling-tasks/

1.2 @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表达式定义规则

1.3 异步调用

什么是“异步调用”？

“异步调用”对应的是“同步调用”，同步调用指程序按照定义顺序依次执行，每一行程序都必须等待上一行程序执行完成之后才能执行；异步调用指程序在顺序执行时，不等待异步调用的语句返回结果就执行后面的程序。

1.3.1 同步调用

1，下面通过一个简单示例来直观的理解什么是同步调用：

@Component

public class Task {

public static Random random =new Random();

public void doTaskOne() throws Exception {

System.out.println("开始做任务一");

long start =System.currentTimeMillis();

Thread.sleep(random.nextInt(10000));

long end = System.currentTimeMillis();

System.out.println("完成任务一，耗时：" + (end - start) + "毫秒");

}

public void doTaskTwo() throws Exception {

System.out.println("开始做任务二");

long start =System.currentTimeMillis();

Thread.sleep(random.nextInt(10000));

long end = System.currentTimeMillis();

System.out.println("完成任务二，耗时：" + (end - start) + "毫秒");

}

public void doTaskThree() throws Exception{

System.out.println("开始做任务三");

long start =System.currentTimeMillis();

Thread.sleep(random.nextInt(10000));

long end = System.currentTimeMillis();

System.out.println("完成任务三，耗时：" + (end - start) + "毫秒");

}

2，Controller中新增方法：

@Autowired

privateTask task;

@ApiIgnore

@RequestMapping("/test")

publicvoid getTest() {

try{

task.doTaskOne();

task.doTaskTwo();

task.doTaskThree();

}catch (Exception e) {

//TODO Auto-generated catch block

e.printStackTrace();

}

3，启动，访问：

开始做任务一

完成任务一，耗时：4910毫秒

开始做任务二

完成任务二，耗时：5104毫秒

开始做任务三

完成任务三，耗时：2853毫秒

任务一、任务二、任务三顺序的执行完了，换言之doTaskOne、doTaskTwo、doTaskThree三个函数顺序的执行完成。

1.3.2 异步调用

上述的同步调用虽然顺利的执行完了三个任务，但是可以看到执行时间比较长，若这三个任务本身之间不存在依赖关系，可以并发执行的话，同步调用在执行效率方面就比较差，可以考虑通过异步调用的方式来并发执行。

在Spring Boot中，我们只需要通过使用@Async注解就能简单的将原来的同步函数变为异步函数，Task类改在为如下模式：

@Component

public class Task {

@Async

public void doTaskOne() throws Exception {

// 同上内容，省略

}

@Async

public void doTaskTwo() throws Exception {

// 同上内容，省略

}

@Async

public void doTaskThree() throws Exception{

// 同上内容，省略

}

为了让@Async注解能够生效，还需要在SpringBoot的主程序中配置@EnableAsync（@EnableScheduling直接替换掉），如下所示：

// 这是一个配置Spring的配置类

@Configuration

// @SpringBootApplication：Spring Boot项目的核心注解，主要目的是开启自动配置。

@SpringBootApplication

//@EnableScheduling//开启定时任务

@EnableAsync

public class DemoApplication {

publicstatic void main(String[] args) {

//启动spring boot应用

SpringApplicationsa = new SpringApplication(DemoApplication.class);

//禁用devTools热部署

System.setProperty("spring.devtools.restart.enabled","false");

//禁用命令行更改application.properties属性

sa.setAddCommandLineProperties(false);

sa.run(args);

}

启动，结果：

此时可以反复执行单元测试，您可能会遇到各种不同的结果，比如：

没有任何任务相关的输出
有部分任务相关的输出
乱序的任务相关的输出

原因是目前doTaskOne、doTaskTwo、doTaskThree三个函数的时候已经是异步执行了。主程序在异步调用之后，主程序并不会理会这三个函数是否执行完成了，由于没有其他需要执行的内容，所以程序就自动结束了，导致了不完整或是没有输出任务相关内容的情况。

注： @Async所修饰的函数不要定义为static类型，这样异步调用不会生效

1.3.3 异步回调

为了让doTaskOne、doTaskTwo、doTaskThree能正常结束，假设我们需要统计一下三个任务并发执行共耗时多少，这就需要等到上述三个函数都完成调动之后记录时间，并计算结果。

那么我们如何判断上述三个异步调用是否已经执行完成呢？我们需要使用Future<T>来返回异步调用的结果，就像如下方式改造doTaskOne函数：

@Async

publicFuture<String> doTaskOne() throws Exception {

System.out.println("开始做任务一");

longstart = System.currentTimeMillis();

Thread.sleep(random.nextInt(10000));

longend = System.currentTimeMillis();

System.out.println("完成任务一，耗时：" + (end - start) + "毫秒");

returnnew AsyncResult<>("任务一完成");

}

按照如上方式改造一下其他两个异步函数之后，下面我们改造一下Controller中方法，在等待完成三个异步调用之后来做一些其他事情。

@ApiIgnore

@RequestMapping("/test1")

publicvoid getTest1() {

try{

longstart = System.currentTimeMillis();

Future<String>task1 = task.doTaskOne();

Future<String>task2 = task.doTaskTwo();

Future<String>task3 = task.doTaskThree();

while(true) {

if(task1.isDone() && task2.isDone() && task3.isDone()) {

//三个任务都调用完成，退出循环等待

break;

}

Thread.sleep(1000);

}

longend = System.currentTimeMillis();

System.out.println("任务全部完成，总耗时：" + (end - start) + "毫秒");

}catch (Exception e) {

e.printStackTrace();

}

看看我们做了哪些改变：

在测试用例一开始记录开始时间
在调用三个异步函数的时候，返回Future<String>类型的结果对象
在调用完三个异步函数之后，开启一个循环，根据返回的Future<String>对象来判断三个异步函数是否都结束了。若都结束，就结束循环；若没有都结束，就等1秒后再判断。
跳出循环之后，根据结束时间 - 开始时间，计算出三个任务并发执行的总耗时。

执行一下上述的单元测试，可以看到如下结果：