Spring Boot中使用@Async實作異步調用

什麼是“異步調用”？

“異步調用”對應的是“同步調用”，同步調用指程式按照定義順序依次執行，每一行程式都必須等待上一行程式執行完成之後才能執行；異步調用指程式在順序執行時，不等待異步調用的語句傳回結果就執行後面的程式。

https://blog.didispace.com/springbootasync/#%E5%90%8C%E6%AD%A5%E8%B0%83%E7%94%A8 同步調用

下面通過一個簡單示例來直覺的了解什麼是同步調用：

• 定義Task類，建立三個處理函數分别模拟三個執行任務的操作，操作消耗時間随機取（10秒内）

@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) + "毫秒");
    }

}      

• 在單元測試用例中，注入Task對象，并在測試用例中執行

  doTaskOne

  、

  doTaskTwo

  doTaskThree

  三個函數。

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
public class ApplicationTests {

    @Autowired
    private Task task;

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

}      

執行單元測試，可以看到類似如下輸出

開始做任務一
完成任務一，耗時：4256毫秒
開始做任務二
完成任務二，耗時：4957毫秒
開始做任務三
完成任務三，耗時：7173毫秒      

任務一、任務二、任務三順序的執行完了，換言之

doTaskOne

doTaskTwo

doTaskThree

三個函數順序的執行完成。

https://blog.didispace.com/springbootasync/#%E5%BC%82%E6%AD%A5%E8%B0%83%E7%94%A8 異步調用

上述的同步調用雖然順利的執行完了三個任務，但是可以看到執行時間比較長，若這三個任務本身之間不存在依賴關系，可以并發執行的話，同步調用在執行效率方面就比較差，可以考慮通過異步調用的方式來并發執行。

在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注解能夠生效，還需要在Spring Boot的主程式中配置@EnableAsync，如下所示：

@SpringBootApplication
@EnableAsync
public class Application {

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

}      

此時可以反複執行單元測試，您可能會遇到各種不同的結果，比如：

• 沒有任何任務相關的輸出
• 有部分任務相關的輸出
• 亂序的任務相關的輸出

原因是目前

doTaskOne

doTaskTwo

doTaskThree

三個函數的時候已經是異步執行了。主程式在異步調用之後，主程式并不會理會這三個函數是否執行完成了，由于沒有其他需要執行的内容，是以程式就自動結束了，導緻了不完整或是沒有輸出任務相關内容的情況。

注： @Async所修飾的函數不要定義為static類型，這樣異步調用不會生效

https://blog.didispace.com/springbootasync/#%E5%BC%82%E6%AD%A5%E5%9B%9E%E8%B0%83 異步回調

為了讓

doTaskOne

doTaskTwo

doTaskThree

能正常結束，假設我們需要統計一下三個任務并發執行共耗時多少，這就需要等到上述三個函數都完成調動之後記錄時間，并計算結果。

那麼我們如何判斷上述三個異步調用是否已經執行完成呢？我們需要使用

Future<T>

來傳回異步調用的結果，就像如下方式改造

doTaskOne

函數：

@Async
public Future<String> doTaskOne() throws Exception {
    System.out.println("開始做任務一");
    long start = System.currentTimeMillis();
    Thread.sleep(random.nextInt(10000));
    long end = System.currentTimeMillis();
    System.out.println("完成任務一，耗時：" + (end - start) + "毫秒");
    return new AsyncResult<>("任務一完成");
}      

按照如上方式改造一下其他兩個異步函數之後，下面我們改造一下測試用例，讓測試在等待完成三個異步調用之後來做一些其他事情。

@Test
public void test() throws Exception {

    long start = 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);
    }

    long end = System.currentTimeMillis();

    System.out.println("任務全部完成，總耗時：" + (end - start) + "毫秒");

}      

看看我們做了哪些改變：

• 在測試用例一開始記錄開始時間
• 在調用三個異步函數的時候，傳回

  Future<String>

  類型的結果對象
• 在調用完三個異步函數之後，開啟一個循環，根據傳回的

  Future<String>

  對象來判斷三個異步函數是否都結束了。若都結束，就結束循環；若沒有都結束，就等1秒後再判斷。
• 跳出循環之後，根據結束時間 - 開始時間，計算出三個任務并發執行的總耗時。

執行一下上述的單元測試，可以看到如下結果：

開始做任務一
開始做任務二
開始做任務三
完成任務三，耗時：37毫秒
完成任務二，耗時：3661毫秒
完成任務一，耗時：7149毫秒
任務全部完成，總耗時：8025毫秒      

可以看到，通過異步調用，讓任務一、二、三并發執行，有效的減少了程式的總運作時間。

https://blog.didispace.com/springbootasync/#%E4%BB%A3%E7%A0%81%E7%A4%BA%E4%BE%8B 代碼示例

本文的相關例子可以檢視下面倉庫中的

chapter4-1-2

目錄：

• Github： https://github.com/dyc87112/SpringBoot-Learning
• Gitee： https://gitee.com/didispace/SpringBoot-Learning