SpringBoot | 第二十一章：異步開發之異步調用

時間 2019-11-06

原文原文鏈接

前言

上一章節，咱們知道了如何進行異步請求的處理。除了異步請求，通常上咱們用的比較多的應該是異步調用。一般在開發過程當中，會遇到一個方法是和實際業務無關的，沒有緊密性的。好比記錄日誌信息等業務。這個時候正常就是啓一個新線程去作一些業務處理，讓主線程異步的執行其餘業務。因此，本章節重點說下在SpringBoot中如何進行異步調用及其相關知識和注意點。html

一點知識

何爲異步調用

說異步調用前，咱們說說它對應的同步調用。一般開發過程當中，通常上咱們都是同步調用，即：程序按定義的順序依次執行的過程，每一行代碼執行過程必須等待上一行代碼執行完畢後才執行。而異步調用指：程序在執行時，無需等待執行的返回值可繼續執行後面的代碼。顯而易見，同步有依賴相關性，而異步沒有，因此異步可併發執行，可提升執行效率，在相同的時間作更多的事情。java

**題外話：**處理異步、同步外，還有一個叫回調。其主要是解決異步方法執行結果的處理方法，好比在但願異步調用結束時返回執行結果，這個時候就能夠考慮使用回調機制。git

Async異步調用

在SpringBoot中使用異步調用是很簡單的，只須要使用@Async註解便可實現方法的異步調用。github

注意：須要在啓動類加入@EnableAsync使異步調用@Async註解生效。spring

@SpringBootApplication
@EnableAsync
@Slf4j
public class Chapter21Application {

    public static void main(String[] args) {
        SpringApplication.run(Chapter21Application.class, args);
        log.info("Chapter21啓動!");
    }
}

@Async異步調用

使用@Async很簡單，只須要在須要異步執行的方法上加入此註解便可。這裏建立一個控制層和一個服務層，進行簡單示例下。緩存

SyncService.javaspringboot

@Component
public class SyncService {
    
    @Async
    public void asyncEvent() throws InterruptedException {
        //休眠1s
        Thread.sleep(1000);
        //log.info("異步方法輸出：{}!", System.currentTimeMillis());
    }
    
    public void syncEvent() throws InterruptedException {
        Thread.sleep(1000);
        //log.info("同步方法輸出：{}!", System.currentTimeMillis());
    }

}

控制層：AsyncController.java微信

@RestController
@Slf4j
public class AsyncController {
    
    @Autowired
    SyncService syncService;
    
    @GetMapping("/async")
    public String doAsync() throws InterruptedException {
        long start = System.currentTimeMillis();
        log.info("方法執行開始：{}", start);
        //調用同步方法
        syncService.syncEvent();
        long syncTime = System.currentTimeMillis();
        log.info("同步方法用時：{}", syncTime - start);
        //調用異步方法
        syncService.asyncEvent();
        long asyncTime = System.currentTimeMillis();
        log.info("異步方法用時：{}", asyncTime - syncTime);
        log.info("方法執行完成：{}!",asyncTime);
        return "async!!!";
    }
}

應用啓動後，能夠看見控制檯輸出:併發

2018-08-16 22:21:35.949  INFO 17152 --- [nio-8080-exec-5] c.l.l.s.c.controller.AsyncController     : 方法執行開始：1534429295949
2018-08-16 22:21:36.950  INFO 17152 --- [nio-8080-exec-5] c.l.l.s.c.controller.AsyncController     : 同步方法用時：1001
2018-08-16 22:21:36.950  INFO 17152 --- [nio-8080-exec-5] c.l.l.s.c.controller.AsyncController     : 異步方法用時：0
2018-08-16 22:21:36.950  INFO 17152 --- [nio-8080-exec-5] c.l.l.s.c.controller.AsyncController     : 方法執行完成：1534429296950!
2018-08-16 22:21:37.950  INFO 17152 --- [cTaskExecutor-3] c.l.l.s.chapter21.service.SyncService    : 異步方法內部線程名稱：SimpleAsyncTaskExecutor-3!

能夠看出，調用異步方法時，是當即返回的，基本沒有耗時。app

這裏有幾點須要注意下：

在默認狀況下，未設置TaskExecutor時，默認是使用SimpleAsyncTaskExecutor這個線程池，但此線程不是真正意義上的線程池，由於線程不重用，每次調用都會建立一個新的線程。可經過控制檯日誌輸出能夠看出，每次輸出線程名都是遞增的。
調用的異步方法，不能爲同一個類的方法，簡單來講，由於Spring在啓動掃描時會爲其建立一個代理類，而同類調用時，仍是調用自己的代理類的，因此和日常調用是同樣的。其餘的註解如@Cache等也是同樣的道理，說白了，就是Spring的代理機制形成的。

自定義線程池

前面有提到，在默認狀況下，系統使用的是默認的SimpleAsyncTaskExecutor進行線程建立。因此通常上咱們會自定義線程池來進行線程的複用。

建立一個自定義的ThreadPoolTaskExecutor線程池： Config.java

@Configuration
public class Config {

    /**
     * 配置線程池
     * @return
     */
    @Bean(name = "asyncPoolTaskExecutor")
    public ThreadPoolTaskExecutor getAsyncThreadPoolTaskExecutor() {
        ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
        taskExecutor.setCorePoolSize(20);
        taskExecutor.setMaxPoolSize(200);
        taskExecutor.setQueueCapacity(25);
        taskExecutor.setKeepAliveSeconds(200);
        taskExecutor.setThreadNamePrefix("oKong-");
        // 線程池對拒絕任務（無線程可用）的處理策略，目前只支持AbortPolicy、CallerRunsPolicy；默認爲後者
        taskExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        taskExecutor.initialize();
        return taskExecutor;
    }
}

此時，使用的是就只須要在@Async加入線程池名稱便可：

@Async("asyncPoolTaskExecutor")
    public void asyncEvent() throws InterruptedException {
        //休眠1s
        Thread.sleep(1000);
        log.info("異步方法內部線程名稱：{}!", Thread.currentThread().getName());
    }

再次啓動應用，就能夠看見已是使用自定義的線程了。

2018-08-16 22:32:02.676  INFO 4516 --- [nio-8080-exec-1] c.l.l.s.c.controller.AsyncController     : 方法執行開始：1534429922676
2018-08-16 22:32:03.681  INFO 4516 --- [nio-8080-exec-1] c.l.l.s.c.controller.AsyncController     : 同步方法用時：1005
2018-08-16 22:32:03.693  INFO 4516 --- [nio-8080-exec-1] c.l.l.s.c.controller.AsyncController     : 異步方法用時：12
2018-08-16 22:32:03.693  INFO 4516 --- [nio-8080-exec-1] c.l.l.s.c.controller.AsyncController     : 方法執行完成：1534429923693!
2018-08-16 22:32:04.694  INFO 4516 --- [        oKong-1] c.l.l.s.chapter21.service.SyncService    : 異步方法內部線程名稱：oKong-1!

這裏簡單說明下，關於ThreadPoolTaskExecutor參數說明：

corePoolSize：線程池維護線程的最少數量
keepAliveSeconds：容許的空閒時間,當超過了核心線程出以外的線程在空閒時間到達以後會被銷燬
maxPoolSize：線程池維護線程的最大數量,只有在緩衝隊列滿了以後纔會申請超過核心線程數的線程
queueCapacity：緩存隊列
rejectedExecutionHandler：線程池對拒絕任務（無線程可用）的處理策略。這裏採用了CallerRunsPolicy策略，當線程池沒有處理能力的時候，該策略會直接在 execute 方法的調用線程中運行被拒絕的任務；若是執行程序已關閉，則會丟棄該任務。還有一個是AbortPolicy策略：處理程序遭到拒絕將拋出運行時RejectedExecutionException。

而在一些場景下，若須要在關閉線程池時等待當前調度任務完成後纔開始關閉，能夠經過簡單的配置，進行優雅的停機策略配置。關鍵就是經過setWaitForTasksToCompleteOnShutdown(true)和setAwaitTerminationSeconds方法。

setWaitForTasksToCompleteOnShutdown:代表等待全部線程執行完，默認爲false。
setAwaitTerminationSeconds:等待的時間，由於不能無限的等待下去。

因此，線程池完整配置爲：

@Bean(name = "asyncPoolTaskExecutor")
    public ThreadPoolTaskExecutor getAsyncThreadPoolTaskExecutor() {
        ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
        taskExecutor.setCorePoolSize(20);
        taskExecutor.setMaxPoolSize(200);
        taskExecutor.setQueueCapacity(25);
        taskExecutor.setKeepAliveSeconds(200);
        taskExecutor.setThreadNamePrefix("oKong-");
        // 線程池對拒絕任務（無線程可用）的處理策略，目前只支持AbortPolicy、CallerRunsPolicy；默認爲後者
        taskExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        //調度器shutdown被調用時等待當前被調度的任務完成
        taskExecutor.setWaitForTasksToCompleteOnShutdown(true);
        //等待時長
        taskExecutor.setAwaitTerminationSeconds(60);
        taskExecutor.initialize();
        return taskExecutor;
    }

異步回調及超時處理

對於一些業務場景下，須要異步回調的返回值時，就須要使用異步回調來完成了。主要就是經過Future進行異步回調。

異步回調

修改下異步方法的返回類型，加入Future。

@Async("asyncPoolTaskExecutor")
    public Future<String> asyncEvent() throws InterruptedException {
        //休眠1s
        Thread.sleep(1000);
        log.info("異步方法內部線程名稱：{}!", Thread.currentThread().getName());
        return new AsyncResult<>("異步方法返回值");
    }

其中AsyncResult是Spring提供的一個Future接口的子類。

而後經過isDone方法，判斷是否已經執行完畢。

@GetMapping("/async")
    public String doAsync() throws InterruptedException {
        long start = System.currentTimeMillis();
        log.info("方法執行開始：{}", start);
        //調用同步方法
        syncService.syncEvent();
        long syncTime = System.currentTimeMillis();
        log.info("同步方法用時：{}", syncTime - start);
        //調用異步方法
        Future<String> doFutrue = syncService.asyncEvent();
        while(true) {
            //判斷異步任務是否完成
            if(doFutrue.isDone()) {
                break;
            }
            Thread.sleep(100);
        }
        long asyncTime = System.currentTimeMillis();
        log.info("異步方法用時：{}", asyncTime - syncTime);
        log.info("方法執行完成：{}!",asyncTime);
        return "async!!!";
    }

此時，控制檯輸出：

2018-08-16 23:10:57.021  INFO 9072 --- [nio-8080-exec-1] c.l.l.s.c.controller.AsyncController     : 方法執行開始：1534431237020
2018-08-16 23:10:58.025  INFO 9072 --- [nio-8080-exec-1] c.l.l.s.c.controller.AsyncController     : 同步方法用時：1005
2018-08-16 23:10:59.037  INFO 9072 --- [        oKong-1] c.l.l.s.chapter21.service.SyncService    : 異步方法內部線程名稱：oKong-1!
2018-08-16 23:10:59.040  INFO 9072 --- [nio-8080-exec-1] c.l.l.s.c.controller.AsyncController     : 異步方法用時：1015
2018-08-16 23:10:59.040  INFO 9072 --- [nio-8080-exec-1] c.l.l.s.c.controller.AsyncController     : 方法執行完成：1534431239040!

因此，當某個業務功能能夠同時拆開一塊兒執行時，可利用異步回調機制，可有效的減小程序執行時間，提升效率。

超時處理

對於一些須要異步回調的函數，不能無期限的等待下去，因此通常上須要設置超時時間，超時後可將線程釋放，而不至於一直堵塞而佔用資源。

對於Future配置超時，很簡單，經過get方法便可，具體以下：

//get方法會一直堵塞，直到等待執行完成才返回
//get(long timeout, TimeUnit unit) 在設置時間類未返回結果，會直接排除異常TimeoutException，messages爲null
String result = doFutrue.get(60, TimeUnit.SECONDS);//60s

超時後，會拋出異常TimeoutException類，此時可進行統一異常捕獲便可。

參考資料

總結

本章節主要是講解了異步請求的使用及相關配置，如超時，異常等處理。在剝離一些和業務無關的操做時，就能夠考慮使用異步調用進行其餘無關業務操做，以此提供業務的處理效率。或者一些業務場景下可拆分出多個方法進行同步執行又互不影響時，也能夠考慮使用異步調用方式提供執行效率。既然已經講解了異步相關知識，下一章節就來介紹下定時任務的使用。