文档建议反馈控制台
首页
学习
活动
专区
工具
TVP
最新优惠活动
文章/答案/技术大牛
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

2行代码，让接口性能提升10倍

文章来源：51cto程序员狗哥
举报

 1、本文内容

详解 @EnableAsync & @Async，主要分下面几个点进行介绍。

  1. 作用
  2. 用法
  3. 获取异步执行结果
  4. 自定义异步执行的线程池
  5. 自定义异常处理
  6. 线程隔离
  7. 源码 & 原理

2、作用

spring容器中实现bean方法的异步调用。

比如有个logService的bean，logservice中有个log方法用来记录日志，当调用logService.log(msg)的时候，希望异步执行，那么可以通过@EnableAsync & @Async来实现。

3、用法

2步

  1. 需要异步执行的方法上面使用@Async注解标注，若bean中所有的方法都需要异步执行，可以直接将@Async加载类上。
  2. 将@EnableAsync添加在spring配置类上，此时@Async注解才会起效。

常见2种用法

  1. 无返回值的
  2. 可以获取返回值的

4、无返回值的

用法

方法返回值不是Future类型的，被执行时，会立即返回，并且无法获取方法返回值，如：

代码语言：javascript
复制
@Async public void log(String msg) throws InterruptedException {     System.out.println("开始记录日志," + System.currentTimeMillis());     //模拟耗时2秒     TimeUnit.SECONDS.sleep(2);     System.out.println("日志记录完毕," + System.currentTimeMillis()); } 

案例

实现日志异步记录的功能。

LogService.log方法用来异步记录日志，需要使用@Async标注

代码语言：javascript
复制
package com.javacode2018.async.demo1;  import org.springframework.scheduling.annotation.Async; import org.springframework.stereotype.Component;  import java.util.concurrent.TimeUnit;  @Component public class LogService {     @Async     public void log(String msg) throws InterruptedException {         System.out.println(Thread.currentThread() + "开始记录日志," + System.currentTimeMillis());         //模拟耗时2秒         TimeUnit.SECONDS.sleep(2);         System.out.println(Thread.currentThread() + "日志记录完毕," + System.currentTimeMillis());     } } 

来个spring配置类，需要加上@EnableAsync开启bean方法的异步调用.

代码语言：javascript
复制
package com.javacode2018.async.demo1;  import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.EnableAspectJAutoProxy; import org.springframework.scheduling.annotation.EnableAsync;  @ComponentScan @EnableAsync public class MainConfig1 { } 

测试代码

代码语言：javascript
复制
package com.javacode2018.async;  import com.javacode2018.async.demo1.LogService; import com.javacode2018.async.demo1.MainConfig1; import org.junit.Test; import org.springframework.context.annotation.AnnotationConfigApplicationContext;  import java.util.concurrent.TimeUnit;  public class AsyncTest {      @Test     public void test1() throws InterruptedException {         AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();         context.register(MainConfig1.class);         context.refresh();         LogService logService = context.getBean(LogService.class);         System.out.println(Thread.currentThread() + " logService.log start," + System.currentTimeMillis());         logService.log("异步执行方法!");         System.out.println(Thread.currentThread() + " logService.log end," + System.currentTimeMillis());          //休眠一下，防止@Test退出         TimeUnit.SECONDS.sleep(3);     }  } 

运行输出

代码语言：javascript
复制
Thread[main,5,main] logService.log start,1595223990417 Thread[main,5,main] logService.log end,1595223990432 Thread[SimpleAsyncTaskExecutor-1,5,main]开始记录日志,1595223990443 Thread[SimpleAsyncTaskExecutor-1,5,main]日志记录完毕,1595223992443 

前2行输出，可以看出logService.log立即就返回了，后面2行来自于log方法，相差2秒左右。

前面2行在主线程中执行，后面2行在异步线程中执行。

5、获取异步返回值

用法

若需取异步执行结果，方法返回值必须为Future类型，使用spring提供的静态方法org.springframework.scheduling.annotation.AsyncResult#forValue创建返回值，如：

代码语言：javascript
复制
public Future<String> getGoodsInfo(long goodsId) throws InterruptedException {     return AsyncResult.forValue(String.format("商品%s基本信息!", goodsId)); } 

案例

场景：电商中商品详情页通常会有很多信息：商品基本信息、商品描述信息、商品评论信息，通过3个方法来或者这几个信息。

这3个方法之间无关联，所以可以采用异步的方式并行获取，提升效率。

下面是商品服务，内部3个方法都需要异步，所以直接在类上使用@Async标注了，每个方法内部休眠500毫秒，模拟一下耗时操作。

代码语言：javascript
复制
package com.javacode2018.async.demo2;  import org.springframework.scheduling.annotation.Async; import org.springframework.scheduling.annotation.AsyncResult; import org.springframework.stereotype.Component;  import java.util.Arrays; import java.util.List; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit;  @Async @Component public class GoodsService {     //模拟获取商品基本信息，内部耗时500毫秒     public Future<String> getGoodsInfo(long goodsId) throws InterruptedException {         TimeUnit.MILLISECONDS.sleep(500);         return AsyncResult.forValue(String.format("商品%s基本信息!", goodsId));     }      //模拟获取商品描述信息，内部耗时500毫秒     public Future<String> getGoodsDesc(long goodsId) throws InterruptedException {         TimeUnit.MILLISECONDS.sleep(500);         return AsyncResult.forValue(String.format("商品%s描述信息!", goodsId));     }      //模拟获取商品评论信息列表，内部耗时500毫秒     public Future<List<String>> getGoodsComments(long goodsId) throws InterruptedException {         TimeUnit.MILLISECONDS.sleep(500);         List<String> comments = Arrays.asList("评论1", "评论2");         return AsyncResult.forValue(comments);     } } 

来个spring配置类，需要加上@EnableAsync开启bean方法的异步调用.

代码语言：javascript
复制
package com.javacode2018.async.demo2;  import org.springframework.context.annotation.ComponentScan; import org.springframework.scheduling.annotation.EnableAsync;  @ComponentScan @EnableAsync public class MainConfig2 { } 

测试代码

代码语言：javascript
复制
@Test public void test2() throws InterruptedException, ExecutionException {     AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();     context.register(MainConfig2.class);     context.refresh();     GoodsService goodsService = context.getBean(GoodsService.class);      long starTime = System.currentTimeMillis();     System.out.println("开始获取商品的各种信息");      long goodsId = 1L;     Future<String> goodsInfoFuture = goodsService.getGoodsInfo(goodsId);     Future<String> goodsDescFuture = goodsService.getGoodsDesc(goodsId);     Future<List<String>> goodsCommentsFuture = goodsService.getGoodsComments(goodsId);      System.out.println(goodsInfoFuture.get());     System.out.println(goodsDescFuture.get());     System.out.println(goodsCommentsFuture.get());      System.out.println("商品信息获取完毕,总耗时(ms)：" + (System.currentTimeMillis() - starTime));      //休眠一下，防止@Test退出     TimeUnit.SECONDS.sleep(3); } 

运行输出

代码语言：javascript
复制
开始获取商品的各种信息 商品1基本信息! 商品1描述信息! [评论1, 评论2] 商品信息获取完毕,总耗时(ms)：525 

3个方法总计耗时500毫秒左右。

如果不采用异步的方式，3个方法会同步执行，耗时差不多1.5秒，来试试，将GoodsService上的@Async去掉，然后再次执行测试案例，输出

代码语言：javascript
复制
开始获取商品的各种信息 商品1基本信息! 商品1描述信息! [评论1, 评论2] 商品信息获取完毕,总耗时(ms)：1503 

这个案例大家可以借鉴一下，按照这个思路可以去优化一下你们的代码，方法之间无关联的可以采用异步的方式，并行去获取，最终耗时为最长的那个方法，整体相对于同步的方式性能提升不少。

6、自定义异步执行的线程池

默认情况下，@EnableAsync使用内置的线程池来异步调用方法，不过我们也可以自定义异步执行任务的线程池。

有2种方式来自定义异步处理的线程池

方式1

在spring容器中定义一个线程池类型的bean，bean名称必须是taskExecutor

代码语言：javascript
复制
@Bean public Executor taskExecutor() {     ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();     executor.setCorePoolSize(10);     executor.setMaxPoolSize(100);     executor.setThreadNamePrefix("my-thread-");     return executor; } 

方式2

定义一个bean，实现AsyncConfigurer接口中的getAsyncExecutor方法，这个方法需要返回自定义的线程池，案例代码：

代码语言：javascript
复制
package com.javacode2018.async.demo3;  import com.javacode2018.async.demo1.LogService; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.context.annotation.Bean; import org.springframework.lang.Nullable; import org.springframework.scheduling.annotation.AsyncConfigurer; import org.springframework.scheduling.annotation.EnableAsync; import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;  import java.util.concurrent.Executor;  @EnableAsync public class MainConfig3 {      @Bean     public LogService logService() {         return new LogService();     }      /**      * 定义一个AsyncConfigurer类型的bean，实现getAsyncExecutor方法，返回自定义的线程池      *      * @param executor      * @return      */     @Bean     public AsyncConfigurer asyncConfigurer(@Qualifier("logExecutors") Executor executor) {         return new AsyncConfigurer() {             @Nullable             @Override             public Executor getAsyncExecutor() {                 return executor;             }         };     }      /**      * 定义一个线程池，用来异步处理日志方法调用      *      * @return      */     @Bean     public Executor logExecutors() {         ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();         executor.setCorePoolSize(10);         executor.setMaxPoolSize(100);         //线程名称前缀         executor.setThreadNamePrefix("log-thread-"); //@1         return executor;     }  } 

@1自定义的线程池中线程名称前缀为log-thread-，运行下面测试代码

代码语言：javascript
复制
@Test public void test3() throws InterruptedException {     AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();     context.register(MainConfig3.class);     context.refresh();     LogService logService = context.getBean(LogService.class);     System.out.println(Thread.currentThread() + " logService.log start," + System.currentTimeMillis());     logService.log("异步执行方法!");     System.out.println(Thread.currentThread() + " logService.log end," + System.currentTimeMillis());      //休眠一下，防止@Test退出     TimeUnit.SECONDS.sleep(3); } 

输出

代码语言：javascript
复制
Thread[main,5,main] logService.log start,1595228732914 Thread[main,5,main] logService.log end,1595228732921 Thread[log-thread-1,5,main]开始记录日志,1595228732930 Thread[log-thread-1,5,main]日志记录完毕,1595228734931 

最后2行日志中线程名称是log-thread-，正是我们自定义线程池中的线程。

7、自定义异常处理

异步方法若发生了异常，我们如何获取异常信息呢？此时可以通过自定义异常处理来解决。

异常处理分2种情况

  1. 当返回值是Future的时候，方法内部有异常的时候，异常会向外抛出，可以对Future.get采用try..catch来捕获异常
  2. 当返回值不是Future的时候，可以自定义一个bean，实现AsyncConfigurer接口中的getAsyncUncaughtExceptionHandler方法，返回自定义的异常处理器

情况1：返回值为Future类型

用法

通过try..catch来捕获异常，如下

代码语言：javascript
复制
try {     Future<String> future = logService.mockException();     System.out.println(future.get()); } catch (ExecutionException e) {     System.out.println("捕获 ExecutionException 异常");     //通过e.getCause获取实际的异常信息     e.getCause().printStackTrace(); } catch (InterruptedException e) {     e.printStackTrace(); } 

案例

LogService中添加一个方法，返回值为Future，内部抛出一个异常，如下：

代码语言：javascript
复制
@Async public Future<String> mockException() {     //模拟抛出一个异常     throw new IllegalArgumentException("参数有误!"); } 

测试代码如下

代码语言：javascript
复制
@Test public void test5() throws InterruptedException {     AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();     context.register(MainConfig1.class);     context.refresh();     LogService logService = context.getBean(LogService.class);     try {         Future<String> future = logService.mockException();         System.out.println(future.get());     } catch (ExecutionException e) {         System.out.println("捕获 ExecutionException 异常");         //通过e.getCause获取实际的异常信息         e.getCause().printStackTrace();     } catch (InterruptedException e) {         e.printStackTrace();     }     //休眠一下，防止@Test退出     TimeUnit.SECONDS.sleep(3); } 

运行输出

代码语言：javascript
复制
java.lang.IllegalArgumentException: 参数有误! 捕获 ExecutionException 异常  at com.javacode2018.async.demo1.LogService.mockException(LogService.java:23)  at com.javacode2018.async.demo1.LogService$$FastClassBySpringCGLIB$$32a28430.invoke(<generated>)  at org.springframework.cglib.proxy.MethodProxy.invoke(MethodProxy.java:218) 

情况2：无返回值异常处理

用法

当返回值不是Future的时候，可以自定义一个bean，实现AsyncConfigurer接口中的getAsyncUncaughtExceptionHandler方法，返回自定义的异常处理器，当目标方法执行过程中抛出异常的时候，此时会自动回调AsyncUncaughtExceptionHandler#handleUncaughtException这个方法，可以在这个方法中处理异常，如下：

代码语言：javascript
复制
@Bean public AsyncConfigurer asyncConfigurer() {     return new AsyncConfigurer() {         @Nullable         @Override         public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {             return new AsyncUncaughtExceptionHandler() {                 @Override                 public void handleUncaughtException(Throwable ex, Method method, Object... params) {                     //当目标方法执行过程中抛出异常的时候，此时会自动回调这个方法，可以在这个方法中处理异常                 }             };         }     }; } 

案例

LogService中添加一个方法，内部抛出一个异常，如下：

代码语言：javascript
复制
@Async public void mockNoReturnException() {     //模拟抛出一个异常     throw new IllegalArgumentException("无返回值的异常!"); } 

来个spring配置类，通过AsyncConfigurer来自定义异常处理器AsyncUncaughtExceptionHandler

代码语言：javascript
复制
package com.javacode2018.async.demo4;  import com.javacode2018.async.demo1.LogService; import org.springframework.aop.interceptor.AsyncUncaughtExceptionHandler; import org.springframework.context.annotation.Bean; import org.springframework.lang.Nullable; import org.springframework.scheduling.annotation.AsyncConfigurer; import org.springframework.scheduling.annotation.EnableAsync;  import java.lang.reflect.Method; import java.util.Arrays;  @EnableAsync public class MainConfig4 {      @Bean     public LogService logService() {         return new LogService();     }      @Bean     public AsyncConfigurer asyncConfigurer() {         return new AsyncConfigurer() {             @Nullable             @Override             public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {                 return new AsyncUncaughtExceptionHandler() {                     @Override                     public void handleUncaughtException(Throwable ex, Method method, Object... params) {                         String msg = String.format("方法[%s],参数[%s],发送异常了，异常详细信息:", method, Arrays.asList(params));                         System.out.println(msg);                         ex.printStackTrace();                     }                 };             }         };     }  } 

运行输出

代码语言：javascript
复制
方法[public void com.javacode2018.async.demo1.LogService.mockNoReturnException()],参数[[]],发送异常了，异常详细信息: java.lang.IllegalArgumentException: 无返回值的异常!  at com.javacode2018.async.demo1.LogService.mockNoReturnException(LogService.java:29)  at com.javacode2018.async.demo1.LogService$$FastClassBySpringCGLIB$$32a28430.invoke(<generated>)  at org.springframework.cglib.proxy.MethodProxy.invoke(MethodProxy.java:218) 

8、线程池隔离

什么是线程池隔离？

一个系统中可能有很多业务，比如充值服务、提现服务或者其他服务，这些服务中都有一些方法需要异步执行，默认情况下他们会使用同一个线程池去执行，如果有一个业务量比较大，占用了线程池中的大量线程，此时会导致其他业务的方法无法执行，那么我们可以采用线程隔离的方式，对不同的业务使用不同的线程池，相互隔离，互不影响。

@Async注解有个value参数，用来指定线程池的bean名称，方法运行的时候，就会采用指定的线程池来执行目标方法。

使用步骤

  1. 在spring容器中，自定义线程池相关的bean
  2. @Async("线程池bean名称")

案例

模拟2个业务：异步充值、异步提现；2个业务都采用独立的线程池来异步执行，互不影响。

异步充值服务
代码语言：javascript
复制
package com.javacode2018.async.demo5;  import org.springframework.scheduling.annotation.Async; import org.springframework.stereotype.Component;  @Component public class RechargeService {     //模拟异步充值     @Async(MainConfig5.RECHARGE_EXECUTORS_BEAN_NAME)     public void recharge() {         System.out.println(Thread.currentThread() + "模拟异步充值");     } } 
异步提现服务
代码语言：javascript
复制
package com.javacode2018.async.demo5;  import org.springframework.scheduling.annotation.Async; import org.springframework.stereotype.Component;  @Component public class CashOutService {     //模拟异步提现     @Async(MainConfig5.CASHOUT_EXECUTORS_BEAN_NAME)     public void cashOut() {         System.out.println(Thread.currentThread() + "模拟异步提现");     } } 
spring配置类

注意@0、@1、@2、@3、@4这几个地方的代码，采用线程池隔离的方式，注册了2个线程池，分别用来处理上面的2个异步业务。

代码语言：javascript
复制
package com.javacode2018.async.demo5;  import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.scheduling.annotation.EnableAsync; import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;  import java.util.concurrent.Executor;  @EnableAsync //@0：启用方法异步调用 @ComponentScan public class MainConfig5 {      //@1：值业务线程池bean名称     public static final String RECHARGE_EXECUTORS_BEAN_NAME = "rechargeExecutors";     //@2：提现业务线程池bean名称     public static final String CASHOUT_EXECUTORS_BEAN_NAME = "cashOutExecutors";      /**      * @3：充值的线程池，线程名称以recharge-thread-开头      * @return      */     @Bean(RECHARGE_EXECUTORS_BEAN_NAME)     public Executor rechargeExecutors() {         ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();         executor.setCorePoolSize(10);         executor.setMaxPoolSize(100);         //线程名称前缀         executor.setThreadNamePrefix("recharge-thread-");         return executor;     }      /**      * @4: 充值的线程池，线程名称以cashOut-thread-开头      *      * @return      */     @Bean(CASHOUT_EXECUTORS_BEAN_NAME)     public Executor cashOutExecutors() {         ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();         executor.setCorePoolSize(10);         executor.setMaxPoolSize(100);         //线程名称前缀         executor.setThreadNamePrefix("cashOut-thread-");         return executor;     } } 
测试代码
代码语言：javascript
复制
@Test public void test7() throws InterruptedException {     AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();     context.register(MainConfig5.class);     context.refresh();      RechargeService rechargeService = context.getBean(RechargeService.class);     rechargeService.recharge();     CashOutService cashOutService = context.getBean(CashOutService.class);     cashOutService.cashOut();      //休眠一下，防止@Test退出     TimeUnit.SECONDS.sleep(3); } 
运行输出
代码语言：javascript
复制
Thread[recharge-thread-1,5,main]模拟异步充值 Thread[cashOut-thread-1,5,main]模拟异步提现 

输出中可以看出2个业务使用的是不同的线程池执行的。

9、源码 & 原理

内部使用aop实现的，@EnableAsync会引入一个bean后置处理器：AsyncAnnotationBeanPostProcessor，将其注册到spring容器，这个bean后置处理器在所有bean创建过程中，判断bean的类上是否有@Async注解或者类中是否有@Async标注的方法，如果有，会通过aop给这个bean生成代理对象，会在代理对象中添加一个切面：org.springframework.scheduling.annotation.AsyncAnnotationAdvisor，这个切面中会引入一个拦截器：AnnotationAsyncExecutionInterceptor，方法异步调用的关键代码就是在这个拦截器的invoke方法中实现的，可以去看一下。

  • 发表于:
  • 原文链接：http://news.51cto.com/art/202007/621652.htm
  • 如有侵权，请联系 cloudcommunity@tencent.com 删除。

相关快讯

扫码

添加站长 进交流群

领取专属 10元无门槛券

私享最新 技术干货

扫码加入开发者社群

腾讯云开发者

扫码关注腾讯云开发者

扫码关注腾讯云开发者

领取腾讯云代金券

热门产品

热门推荐

更多推荐

Copyright © 2013 - 2024 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有

深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 深公网安备号 44030502008569

腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号 | 京公网安备号11010802020287

领券