一个注解提升SpringBoot项目中的并发能力

一、前言

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

二、同步调用

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

定义一个任务类，创建3个处理函数分别执行3个不同的任务，并分别模拟不同的耗时秒数。

package com.example.springbootdemo.task;

import org.springframework.stereotype.Component;

@Component
public class MyTask {

    public void one() throws InterruptedException {
        System.out.println("执行任务1");
        long start = System.currentTimeMillis();
        Thread.sleep(2000);
        long end = System.currentTimeMillis();
        System.out.println("完成任务1，耗时:" + (end - start) + "毫秒");
    }

    public void two() throws InterruptedException {
        System.out.println("执行任务2");
        long start = System.currentTimeMillis();
        Thread.sleep(3000);
        long end = System.currentTimeMillis();
        System.out.println("完成任务2，耗时:" + (end - start) + "毫秒");
    }

    public void three() throws InterruptedException {
        System.out.println("执行任务3");
        long start = System.currentTimeMillis();
        Thread.sleep(4000);
        long end = System.currentTimeMillis();
        System.out.println("完成任务3，耗时:" + (end - start) + "毫秒");
    }
}

在单元测试用例中，注入MyTask对象，并在测试用例中执行one、two、three三个函数。

package com.example.springbootdemo;

import com.example.springbootdemo.task.MyTask;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class SpringBootDemoApplicationTests {

	@Autowired
	private MyTask myTask;

	@Test
	void contextLoads() throws InterruptedException {
		myTask.one();
		myTask.two();
		myTask.three();
	}

}

执行单元测试，可以看到类似如下输出：

任务一、任务二、任务三顺序的执行完了，换言之one、two、three三个函数顺序的执行完成。

三、异步调用

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

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

package com.example.springbootdemo.task;

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

@Component
public class MyTask {

    @Async
    public void one() throws InterruptedException {
        System.out.println("执行任务1");
        long start = System.currentTimeMillis();
        Thread.sleep(2000);
        long end = System.currentTimeMillis();
        System.out.println("完成任务1，耗时:" + (end - start) + "毫秒");
    }

    @Async
    public void two() throws InterruptedException {
        System.out.println("执行任务2");
        long start = System.currentTimeMillis();
        Thread.sleep(3000);
        long end = System.currentTimeMillis();
        System.out.println("完成任务2，耗时:" + (end - start) + "毫秒");
    }

    @Async
    public void three() throws InterruptedException {
        System.out.println("执行任务3");
        long start = System.currentTimeMillis();
        Thread.sleep(4000);
        long end = System.currentTimeMillis();
        System.out.println("完成任务3，耗时:" + (end - start) + "毫秒");
    }
}

为了让@Async注解能够生效，还需要在Spring Boot的主程序中配置@EnableAsync，如下所示：

package com.example.springbootdemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableAsync;

@SpringBootApplication
@EnableAsync
public class SpringBootDemoApplication {

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

}

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

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

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

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

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

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

package com.example.springbootdemo.task;

import org.springframework.scheduling.annotation.Async;
import org.springframework.scheduling.annotation.AsyncResult;
import org.springframework.stereotype.Component;

import java.util.concurrent.Future;

@Component
public class MyTask {

    @Async
    public Future<String> one() throws InterruptedException {
        System.out.println("执行任务1");
        long start = System.currentTimeMillis();
        Thread.sleep(2000);
        long end = System.currentTimeMillis();
        System.out.println("完成任务1，耗时:" + (end - start) + "毫秒");
        return new AsyncResult<>("任务1完成");
    }

    @Async
    public Future<String> two() throws InterruptedException {
        System.out.println("执行任务2");
        long start = System.currentTimeMillis();
        Thread.sleep(3000);
        long end = System.currentTimeMillis();
        System.out.println("完成任务2，耗时:" + (end - start) + "毫秒");
        return new AsyncResult<>("任务2完成");
    }

    @Async
    public Future<String> three() throws InterruptedException {
        System.out.println("执行任务3");
        long start = System.currentTimeMillis();
        Thread.sleep(4000);
        long end = System.currentTimeMillis();
        System.out.println("完成任务3，耗时:" + (end - start) + "毫秒");
        return new AsyncResult<>("任务3完成");
    }
}

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

package com.example.springbootdemo;

import com.example.springbootdemo.task.MyTask;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.concurrent.Future;

@SpringBootTest
class SpringBootDemoApplicationTests {

	@Autowired
	private MyTask myTask;

	@Test
	void contextLoads() throws InterruptedException {
		long start = System.currentTimeMillis();
		Future<String> task1 = myTask.one();
		Future<String> task2 = myTask.two();
		Future<String> task3 = myTask.three();
		while (true){
			if(task1.isDone()&&task2.isDone()&&task3.isDone()){
				//三个任务都调用完成，退出循环等待
				break;
			}
		}
		long end = System.currentTimeMillis();
		System.out.println("任务全部完成，总耗时:"+(end-start)+"毫秒");
	}

}

看看我们做了哪些改变：

• 在测试用例一开始记录开始时间
  
• 在调用三个异步函数的时候，返回Future类型的结果对象
  
• 在调用完三个异步函数之后，开启一个循环，根据返回的Future对象来判断三个异步函数是否都结束了。若都结束，就结束循环；若没有都结束，就继续循环下去。

跳出循环之后，根据结束时间 - 开始时间，计算出三个任务并发执行的总耗时。

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

可以看到，通过异步调用，让任务一、二、三并发执行，有效的减少了程序的总运行时间。