本文帶你快速了解@Async注解的用法，包括異步方法無傳回值、有傳回值，最後總結了@Async注解失效的幾個坑。
在 SpringBoot 應用中，經常會遇到在一個接口中，同時做事情1，事情2，事情3，如果同步執行的話，則本次接口時間取決于事情1 2 3執行時間之和；如果三件事同時執行，則本次接口時間取決于事情1 2 3執行時間最長的那個，合理使用多線程，可以大大縮短接口時間。那麼在 SpringBoot 應用中如何優雅的使用多線程呢？
Don't bb, show me code.
快速使用
SpringBoot應用中需要添加
@EnableAsync
注解，來開啟異步調用，一般還會配置一個線程池，異步的方法交給特定的線程池完成，如下：
@Configuration
@EnableAsync
public class AsyncConfiguration {
@Bean("doSomethingExecutor")
public Executor doSomethingExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
// 核心線程數：線程池建立時候初始化的線程數
executor.setCorePoolSize(10);
// 最大線程數：線程池最大的線程數，隻有在緩沖隊列滿了之後才會申請超過核心線程數的線程
executor.setMaxPoolSize(20);
// 緩沖隊列：用來緩沖執行任務的隊列
executor.setQueueCapacity(500);
// 允許線程的空閑時間60秒：當超過了核心線程之外的線程在空閑時間到達之後會被銷毀
executor.setKeepAliveSeconds(60);
// 線程池名的字首：設定好了之後可以友善我們定位處理任務所在的線程池
executor.setThreadNamePrefix("do-something-");
// 緩沖隊列滿了之後的拒絕政策：由調用線程處理（一般是主線程）
executor.setRejectedExecutionHandler(new ThreadPoolExecutor.DiscardPolicy());
executor.initialize();
return executor;
}
}
使用的方式非常簡單，在需要異步的方法上加
@Async
注解
@RestController
public class AsyncController {
@Autowired
private AsyncService asyncService;
@GetMapping("/open/something")
public String something() {
int count = 10;
for (int i = 0; i < count; i++) {
asyncService.doSomething("index = " + i);
}
lon
return "success";
}
}
@Slf4j
@Service
public class AsyncService {
// 指定使用beanname為doSomethingExecutor的線程池
@Async("doSomethingExecutor")
public String doSomething(String message) {
log.info("do something, message={}", message);
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
log.error("do something error: ", e);
}
return message;
}
}
通路：127.0.0.1:8080/open/something，日志如下
2020-04-19 23:42:42.486 INFO 21168 --- [io-8200-exec-17] x.g.b.system.controller.AsyncController : do something end, time 8 milliseconds
2020-04-19 23:42:42.488 INFO 21168 --- [ do-something-1] x.gits.boot.system.service.AsyncService : do something, message=index = 0
2020-04-19 23:42:42.488 INFO 21168 --- [ do-something-5] x.gits.boot.system.service.AsyncService : do something, message=index = 4
2020-04-19 23:42:42.488 INFO 21168 --- [ do-something-4] x.gits.boot.system.service.AsyncService : do something, message=index = 3
2020-04-19 23:42:42.488 INFO 21168 --- [ do-something-6] x.gits.boot.system.service.AsyncService : do something, message=index = 5
2020-04-19 23:42:42.488 INFO 21168 --- [ do-something-9] x.gits.boot.system.service.AsyncService : do something, message=index = 8
2020-04-19 23:42:42.488 INFO 21168 --- [ do-something-8] x.gits.boot.system.service.AsyncService : do something, message=index = 7
2020-04-19 23:42:42.488 INFO 21168 --- [do-something-10] x.gits.boot.system.service.AsyncService : do something, message=index = 9
2020-04-19 23:42:42.488 INFO 21168 --- [ do-something-7] x.gits.boot.system.service.AsyncService : do something, message=index = 6
2020-04-19 23:42:42.488 INFO 21168 --- [ do-something-2] x.gits.boot.system.service.AsyncService : do something, message=index = 1
2020-04-19 23:42:42.488 INFO 21168 --- [ do-something-3] x.gits.boot.system.service.AsyncService : do something, message=index = 2
由此可見已經達到異步執行的效果了，并且使用到了咱們配置的線程池。
擷取異步方法傳回值
當異步方法有傳回值時，如何擷取異步方法執行的傳回結果呢？這時需要異步調用的方法帶有傳回值CompletableFuture。
CompletableFuture是對Feature的增強，Feature隻能處理簡單的異步任務，而CompletableFuture可以将多個異步任務進行複雜的組合。如下：
@RestController
public class AsyncController {
@Autowired
private AsyncService asyncService;
@SneakyThrows
@ApiOperation("異步 有傳回值")
@GetMapping("/open/somethings")
public String somethings() {
CompletableFuture<String> createOrder = asyncService.doSomething1("create order");
CompletableFuture<String> reduceAccount = asyncService.doSomething2("reduce account");
CompletableFuture<String> saveLog = asyncService.doSomething3("save log");
// 等待所有任務都執行完
CompletableFuture.allOf(createOrder, reduceAccount, saveLog).join();
// 擷取每個任務的傳回結果
String result = createOrder.get() + reduceAccount.get() + saveLog.get();
return result;
}
}
@Slf4j
@Service
public class AsyncService {
@Async("doSomethingExecutor")
public CompletableFuture<String> doSomething1(String message) throws InterruptedException {
log.info("do something1: {}", message);
Thread.sleep(1000);
return CompletableFuture.completedFuture("do something1: " + message);
}
@Async("doSomethingExecutor")
public CompletableFuture<String> doSomething2(String message) throws InterruptedException {
log.info("do something2: {}", message);
Thread.sleep(1000);
return CompletableFuture.completedFuture("; do something2: " + message);
}
@Async("doSomethingExecutor")
public CompletableFuture<String> doSomething3(String message) throws InterruptedException {
log.info("do something3: {}", message);
Thread.sleep(1000);
return CompletableFuture.completedFuture("; do something3: " + message);
}
}
通路接口
C:\Users\Administrator>curl -X GET "http://localhost:8200/open/somethings" -H "accept: */*"
do something1: create order; do something2: reduce account; do something3: save log
控制台上關鍵日志如下：
2020-04-20 00:27:42.238 INFO 5672 --- [ do-something-3] x.gits.boot.system.service.AsyncService : do something3: save log
2020-04-20 00:27:42.238 INFO 5672 --- [ do-something-2] x.gits.boot.system.service.AsyncService : do something2: reduce account
2020-04-20 00:27:42.238 INFO 5672 --- [ do-something-1] x.gits.boot.system.service.AsyncService : do something1: create order
注意事項
@Async
注解會在以下幾個場景失效，也就是說明明使用了
@Async
注解，但就沒有走多線程。
- 異步方法使用static關鍵詞修飾；
- 異步類不是一個Spring容器的bean（一般使用注解
@Component
@Service
- SpringBoot應用中沒有添加
@EnableAsync
- 在同一個類中，一個方法調用另外一個有@Async注解的方法，注解不會生效。原因是@Async注解的方法，是在代理類中執行的。
需要注意的是： 異步方法使用注解@Async的傳回值隻能為void或者Future及其子類，當傳回結果為其他類型時，方法還是會異步執行，但是傳回值都是null，部分源碼如下：
AsyncExecutionInterceptor#invoke
通過上邊幾個示例，@Async實際還是通過Future或CompletableFuture來異步執行的，Spring又封裝了一下，讓我們使用的更友善。
本文示例代碼：https://gitee.com/songyinyin/gits，搜尋AsyncController可得。
你在SpringBoot應用中如何使用多線程的呢，不妨留言說說你遇到的坑
![Java小案例——随機數猜測随機數猜測[圖]](data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=)