前言

本文帶你快速了解@Async注解的用法，包括異步方法無(wú)返回值、有返回值，最后總結(jié)了@Async注解失效的幾個(gè)坑。

在 SpringBoot 應(yīng)用中，經(jīng)常會(huì)遇到在一個(gè)接口中，同時(shí)做事情1，事情2，事情3，如果同步執(zhí)行的話(huà)，則本次接口時(shí)間取決于事情1 2 3執(zhí)行時(shí)間之和；如果三件事同時(shí)執(zhí)行，則本次接口時(shí)間取決于事情1 2 3執(zhí)行時(shí)間最長(zhǎng)的那個(gè)，合理使用多線(xiàn)程，可以大大縮短接口時(shí)間。那么在 SpringBoot 應(yīng)用中如何優(yōu)雅的使用多線(xiàn)程呢？

Don't bb, show me code.

快速使用

SpringBoot應(yīng)用中需要添加@EnableAsync注解，來(lái)開(kāi)啟異步調(diào)用，一般還會(huì)配置一個(gè)線(xiàn)程池，異步的方法交給特定的線(xiàn)程池完成，如下：

@Configuration
@EnableAsync
public class AsyncConfiguration {

 @Bean("doSomethingExecutor")
 public Executor doSomethingExecutor() {
  ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
  // 核心線(xiàn)程數(shù)：線(xiàn)程池創(chuàng)建時(shí)候初始化的線(xiàn)程數(shù)
  executor.setCorePoolSize(10);
  // 最大線(xiàn)程數(shù)：線(xiàn)程池最大的線(xiàn)程數(shù)，只有在緩沖隊(duì)列滿(mǎn)了之后才會(huì)申請(qǐng)超過(guò)核心線(xiàn)程數(shù)的線(xiàn)程
  executor.setMaxPoolSize(20);
  // 緩沖隊(duì)列：用來(lái)緩沖執(zhí)行任務(wù)的隊(duì)列
  executor.setQueueCapacity(500);
  // 允許線(xiàn)程的空閑時(shí)間60秒：當(dāng)超過(guò)了核心線(xiàn)程之外的線(xiàn)程在空閑時(shí)間到達(dá)之后會(huì)被銷(xiāo)毀
  executor.setKeepAliveSeconds(60);
  // 線(xiàn)程池名的前綴：設(shè)置好了之后可以方便我們定位處理任務(wù)所在的線(xiàn)程池
  executor.setThreadNamePrefix("do-something-");
  // 緩沖隊(duì)列滿(mǎn)了之后的拒絕策略：由調(diào)用線(xiàn)程處理（一般是主線(xiàn)程）
  executor.setRejectedExecutionHandler(new ThreadPoolExecutor.DiscardPolicy());
  executor.initialize();
  return executor;
 }
}

使用的方式非常簡(jiǎn)單，在需要異步的方法上加@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);
  }
  return "success";
 }
}


@Slf4j
@Service
public class AsyncService {

 // 指定使用beanname為doSomethingExecutor的線(xiàn)程池
 @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;
 }
}

訪(fǎng)問(wèn)：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

由此可見(jiàn)已經(jīng)達(dá)到異步執(zhí)行的效果了，并且使用到了咱們配置的線(xiàn)程池。

獲取異步方法返回值

當(dāng)異步方法有返回值時(shí)，如何獲取異步方法執(zhí)行的返回結(jié)果呢？這時(shí)需要異步調(diào)用的方法帶有返回值CompletableFuture。

CompletableFuture是對(duì)Feature的增強(qiáng)，F(xiàn)eature只能處理簡(jiǎn)單的異步任務(wù)，而CompletableFuture可以將多個(gè)異步任務(wù)進(jìn)行復(fù)雜的組合。如下：

@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");
  
  // 等待所有任務(wù)都執(zhí)行完
  CompletableFuture.allOf(createOrder, reduceAccount, saveLog).join();
  // 獲取每個(gè)任務(wù)的返回結(jié)果
  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);
 }
}

訪(fǎng)問(wèn)接口

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

控制臺(tái)上關(guān)鍵日志如下：

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

注意事項(xiàng)

@Async注解會(huì)在以下幾個(gè)場(chǎng)景失效，也就是說(shuō)明明使用了@Async注解，但就沒(méi)有走多線(xiàn)程。

• 異步方法使用static關(guān)鍵詞修飾；
• 異步類(lèi)不是一個(gè)Spring容器的bean（一般使用注解@Component和@Service，并且能被Spring掃描到）；
• SpringBoot應(yīng)用中沒(méi)有添加@EnableAsync注解；
• 在同一個(gè)類(lèi)中，一個(gè)方法調(diào)用另外一個(gè)有@Async注解的方法，注解不會(huì)生效。原因是@Async注解的方法，是在代理類(lèi)中執(zhí)行的。

需要注意的是：

異步方法使用注解@Async的返回值只能為void或者Future及其子類(lèi)，當(dāng)返回結(jié)果為其他類(lèi)型時(shí)，方法還是會(huì)異步執(zhí)行，但是返回值都是null，部分源碼如下：

AsyncExecutionInterceptor#invoke

通過(guò)上邊幾個(gè)示例，@Async實(shí)際還是通過(guò)Future或CompletableFuture來(lái)異步執(zhí)行的，Spring又封裝了一下，讓我們使用的更方便。

本文示例代碼：gitee.com/songyinyin/… ，搜索AsyncController可得。

總結(jié)

到此這篇關(guān)于Spring Boot如何優(yōu)雅的使用多線(xiàn)程的文章就介紹到這了,更多相關(guān)Spring Boot優(yōu)雅使用多線(xiàn)程內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論