2021-09-14 Springboot中使用@Async实现异步调用

同步调用：程序按照定义顺序依次执行，每一行程序都必须等待上一行程序执行完成之后才能执行；

异步调用：程序在顺序执行时，不等待异步调用的语句返回结果就执行后面的程序。

同步调用

1. 编写任务类，创建三个处理函数分别模拟三个执行任务的操作，操作消耗时间随机取（10秒内）

@Slf4j
@Component
public class AsyncTasks {
    public static Random random = new Random();

    public void doTaskOne() throws Exception {
        log.info("开始做任务一");
        long start = System.currentTimeMillis();
        Thread.sleep(random.nextInt(10000));
        long end = System.currentTimeMillis();
        log.info("完成任务一，耗时：" + (end - start) + "毫秒");
    }

    public void doTaskTwo() throws Exception {
        log.info("开始做任务二");
        long start = System.currentTimeMillis();
        Thread.sleep(random.nextInt(10000));
        long end = System.currentTimeMillis();
        log.info("完成任务二，耗时：" + (end - start) + "毫秒");
    }

    public void doTaskThree() throws Exception {
        log.info("开始做任务三");
        long start = System.currentTimeMillis();
        Thread.sleep(random.nextInt(10000));
        long end = System.currentTimeMillis();
        log.info("完成任务三，耗时：" + (end - start) + "毫秒");
    }
}

2. 在测试类中调用

@Slf4j
@SpringBootTest
public class Test01ApplicationTests {

    @Autowired
    private AsyncTasks asyncTasks;

    @Test
    public void test() throws Exception {
        asyncTasks.doTaskOne();
        asyncTasks.doTaskTwo();
        asyncTasks.doTaskThree();
    }

}

异步调用

同步调用执行时间比较长，若这三个任务本身之间不存在依赖关系，可以并发执行，同步调用执行效率比较差，可以考虑通过异步调用的方式来并发执行。

在Springboot中，可以使用@Async注解就能简单的将原来的同步函数变为异步函数，Task类改在为如下模式：

@Slf4j
@Component
public class AsyncTasks {
    public static Random random = new Random();

    @Async
    public void doTaskOne() throws Exception {
        log.info("开始做任务一");
        long start = System.currentTimeMillis();
        Thread.sleep(random.nextInt(10000));
        long end = System.currentTimeMillis();
        log.info("完成任务一，耗时：" + (end - start) + "毫秒");
    }

    @Async
    public void doTaskTwo() throws Exception {
        log.info("开始做任务二");
        long start = System.currentTimeMillis();
        Thread.sleep(random.nextInt(10000));
        long end = System.currentTimeMillis();
        log.info("完成任务二，耗时：" + (end - start) + "毫秒");
    }

    @Async
    public void doTaskThree() throws Exception {
        log.info("开始做任务三");
        long start = System.currentTimeMillis();
        Thread.sleep(random.nextInt(10000));
        long end = System.currentTimeMillis();
        log.info("完成任务三，耗时：" + (end - start) + "毫秒");
    }
}

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

@EnableAsync
@SpringBootApplication
public class Test01Application {
    public static void main(String[] args) {
        SpringApplication.run(Test01Application.class, args);
    }
}

现在测试，可能会遇到不同结果

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

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

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

异步回调方式1

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

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

@Async
public CompletableFuture<String> doTaskOne() throws Exception {
    log.info("开始做任务一");
    long start = System.currentTimeMillis();
    Thread.sleep(random.nextInt(10000));
    long end = System.currentTimeMillis();
    log.info("完成任务一，耗时：" + (end - start) + "毫秒");
    return CompletableFuture.completedFuture("任务一完成");
}

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

@Test
public void test() throws Exception {
    long start = System.currentTimeMillis();

    CompletableFuture<String> task1 = asyncTasks.doTaskOne();
    CompletableFuture<String> task2 = asyncTasks.doTaskTwo();
    CompletableFuture<String> task3 = asyncTasks.doTaskThree();

    CompletableFuture.allOf(task1, task2, task3).join();

    long end = System.currentTimeMillis();

    log.info("任务全部完成，总耗时：" + (end - start) + "毫秒");
}

看看结果哪些改变：

• 在测试用例一开始记录开始时间
• 在调用三个异步函数的时候，返回CompletableFuture类型的结果对象
• 通过CompletableFuture.allOf(task1, task2, task3).join()手动实现三个异步任务都结束之前的阻塞效果
• 三个任务都完成之后，根据结束时间 - 开始时间，计算出三个任务并发执行的总耗时。

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

异步回调方式2

改造doTaskOne方法，其他方法同理

@Async
public CompletableFuture<Long> doTaskOne() throws Exception {
    log.info("开始做任务一");
    long start = System.currentTimeMillis();
    Thread.sleep(random.nextInt(10000));
    long end = System.currentTimeMillis();
    log.info("完成任务一，耗时：" + (end - start) + "毫秒");
    return CompletableFuture.completedFuture(end - start);
}

修改测试方法

@Test
public void test1() throws Exception {
   long start = System.currentTimeMillis();

   CompletableFuture<Long> task1 = asyncTasks.doTaskOne();
   CompletableFuture<Long> task2 = asyncTasks.doTaskTwo();
   CompletableFuture<Long> task3 = asyncTasks.doTaskThree();
   // CompletableFuture.allOf(task1, task2, task3).join();
   Long i = task1.get()+task2.get()+task3.get();
   long end = System.currentTimeMillis();
   log.info("任务全部完成，总耗时：" + (end - start) + "毫秒");
   log.info("任务累计耗时：" + i + "毫秒");
}

和异步回调方式1比较：

• 没有使用CompletableFuture.allOf(task1, task2, task3).join()主动阻塞，开发中看程序情况决定是否需要使用主动阻塞
• 使用task1.get()，在获取任务返回结果时会自动阻塞，等待异步线程执行完毕后获取结果