Spring使用@Async注解

时间 2020-05-30

原文原文链接

本文讲述@Async注解，在Spring体系中的应用。本文仅说明@Async注解的应用规则，对于原理，调用逻辑，源码分析，暂不介绍。对于异步方法调用，从Spring3开始提供了@Async注解，该注解能够被标注在方法上，以便异步地调用该方法。调用者将在调用时当即返回，方法的实际执行将提交给Spring TaskExecutor的任务中，由指定的线程池中的线程执行。html

在项目应用中，@Async调用线程池，推荐使用自定义线程池的模式。自定义线程池经常使用方案：从新实现接口AsyncConfigurer。java

简介

应用场景

同步：同步就是整个处理过程顺序执行，当各个过程都执行完毕，并返回结果。spring

异步：异步调用则是只是发送了调用的指令，调用者无需等待被调用的方法彻底执行完毕；而是继续执行下面的流程。例如，在某个调用中，须要顺序调用 A, B, C三个过程方法；如他们都是同步调用，则须要将他们都顺序执行完毕以后，方算做过程执行完毕；如B为一个异步的调用方法，则在执行完A以后，调用B，并不等待B完成，而是执行开始调用C，待C执行完毕以后，就意味着这个过程执行完毕了。在Java中，通常在处理相似的场景之时，都是基于建立独立的线程去完成相应的异步调用逻辑，经过主线程和不一样的业务子线程之间的执行流程，从而在启动独立的线程以后，主线程继续执行而不会产生停滞等待的状况。编程

Spring 已经实现的异常线程池

1. SimpleAsyncTaskExecutor：不是真的线程池，这个类不重用线程，默认每次调用都会建立一个新的线程。
2. SyncTaskExecutor：这个类没有实现异步调用，只是一个同步操做。只适用于不须要多线程的地方。
3. ConcurrentTaskExecutor：Executor的适配类，不推荐使用。若是ThreadPoolTaskExecutor不知足要求时，才用考虑使用这个类。
4. SimpleThreadPoolTaskExecutor：是Quartz的SimpleThreadPool的类。线程池同时被quartz和非quartz使用，才须要使用此类。
5. ThreadPoolTaskExecutor ：最常使用，推荐。其实质是对java.util.concurrent.ThreadPoolExecutor的包装。多线程

异步的方法有：
app

1. 最简单的异步调用，返回值为void
2. 带参数的异步调用，异步方法能够传入参数
3. 存在返回值，常调用返回Future异步

Spring中启用@Async

 1 // 基于Java配置的启用方式：
 2 @Configuration  3 @EnableAsync  4 public class SpringAsyncConfig { ... }  5 
 6 // Spring boot启用：
 7 @EnableAsync  8 @EnableTransactionManagement  9 public class SettlementApplication { 10     public static void main(String[] args) { 11         SpringApplication.run(SettlementApplication.class, args); 12  } 13 }

@Async应用默认线程池

Spring应用默认的线程池，指在@Async注解在使用时，不指定线程池的名称。查看源码，@Async的默认线程池为SimpleAsyncTaskExecutor。async

无返回值调用

基于@Async无返回值调用，直接在使用类，使用方法（建议在使用方法）上，加上注解。若须要抛出异常，需手动new一个异常抛出。ide

 1  /**
 2  * 带参数的异步调用 异步方法能够传入参数  3  * 对于返回值是void，异常会被AsyncUncaughtExceptionHandler处理掉  4  * @param s  5      */
 6  @Async  7     public void asyncInvokeWithException(String s) {  8         log.info("asyncInvokeWithParameter, parementer={}", s);  9         throw new IllegalArgumentException(s); 10     }

有返回值Future调用

 1  /**
 2  * 异常调用返回Future  3  * 对于返回值是Future，不会被AsyncUncaughtExceptionHandler处理，须要咱们在方法中捕获异常并处理  4  * 或者在调用方在调用Futrue.get时捕获异常进行处理  5  *  6  * @param i  7  * @return
 8      */
 9  @Async 10     public Future<String> asyncInvokeReturnFuture(int i) { 11         log.info("asyncInvokeReturnFuture, parementer={}", i); 12         Future<String> future; 13         try { 14             Thread.sleep(1000 * 1); 15             future = new AsyncResult<String>("success:" + i); 16             throw new IllegalArgumentException("a"); 17         } catch (InterruptedException e) { 18             future = new AsyncResult<String>("error"); 19         } catch(IllegalArgumentException e){ 20             future = new AsyncResult<String>("error-IllegalArgumentException"); 21  } 22         return future; 23     }

有返回值CompletableFuture调用

CompletableFuture 并不使用@Async注解，可达到调用系统线程池处理业务的功能。函数式编程

JDK5新增了Future接口，用于描述一个异步计算的结果。虽然 Future 以及相关使用方法提供了异步执行任务的能力，可是对于结果的获取倒是很不方便，只能经过阻塞或者轮询的方式获得任务的结果。阻塞的方式显然和咱们的异步编程的初衷相违背，轮询的方式又会耗费无谓的 CPU 资源，并且也不能及时地获得计算结果。

CompletionStage表明异步计算过程当中的某一个阶段，一个阶段完成之后可能会触发另一个阶段
一个阶段的计算执行能够是一个Function，Consumer或者Runnable。好比：stage.thenApply(x -> square(x)).thenAccept(x -> System.out.print(x)).thenRun(() -> System.out.println())
一个阶段的执行多是被单个阶段的完成触发，也多是由多个阶段一块儿触发

在Java8中，CompletableFuture提供了很是强大的Future的扩展功能，能够帮助咱们简化异步编程的复杂性，而且提供了函数式编程的能力，能够经过回调的方式处理计算结果，也提供了转换和组合 CompletableFuture 的方法。

它可能表明一个明确完成的Future，也有可能表明一个完成阶段（ CompletionStage ），它支持在计算完成之后触发一些函数或执行某些动做。
它实现了Future和CompletionStage接口

 1  /**
 2  * 数据查询线程池  3      */
 4     private static final ThreadPoolExecutor SELECT_POOL_EXECUTOR = new ThreadPoolExecutor(10, 20, 5000,  5             TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>(1024), new ThreadFactoryBuilder().setNameFormat("selectThreadPoolExecutor-%d").build());  6 
 7 // tradeMapper.countTradeLog(tradeSearchBean)方法表示，获取数量，返回值为int  8  // 获取总条数
 9         CompletableFuture<Integer> countFuture = CompletableFuture 10                 .supplyAsync(() -> tradeMapper.countTradeLog(tradeSearchBean), SELECT_POOL_EXECUTOR); 11 // 同步阻塞
12  CompletableFuture.allOf(countFuture).join(); 13 // 获取结果
14  int count = countFuture.get();

默认线程池的弊端

在线程池应用中，参考阿里巴巴java开发规范：线程池不容许使用Executors去建立，不容许使用系统默认的线程池，推荐经过ThreadPoolExecutor的方式，这样的处理方式让开发的工程师更加明确线程池的运行规则，规避资源耗尽的风险。Executors各个方法的弊端：

newFixedThreadPool和newSingleThreadExecutor：主要问题是堆积的请求处理队列可能会耗费很是大的内存，甚至OOM。
newCachedThreadPool和newScheduledThreadPool：要问题是线程数最大数是Integer.MAX_VALUE，可能会建立数量很是多的线程，甚至OOM。

@Async默认异步配置使用的是SimpleAsyncTaskExecutor，该线程池默认来一个任务建立一个线程，若系统中不断的建立线程，最终会致使系统占用内存太高，引起OutOfMemoryError错误。针对线程建立问题，SimpleAsyncTaskExecutor提供了限流机制，经过concurrencyLimit属性来控制开关，当concurrencyLimit>=0时开启限流机制，默认关闭限流机制即concurrencyLimit=-1，当关闭状况下，会不断建立新的线程来处理任务。基于默认配置，SimpleAsyncTaskExecutor并非严格意义的线程池，达不到线程复用的功能。

@Async应用自定义线程池

自定义线程池，可对系统中线程池更加细粒度的控制，方便调整线程池大小配置，线程执行异常控制和处理。在设置系统自定义线程池代替默认线程池时，虽可经过多种模式设置，但替换默认线程池最终产生的线程池有且只能设置一个（不能设置多个类继承AsyncConfigurer）。自定义线程池有以下模式：

从新实现接口AsyncConfigurer
继承AsyncConfigurerSupport
配置由自定义的TaskExecutor替代内置的任务执行器

经过查看Spring源码关于@Async的默认调用规则，会优先查询源码中实现AsyncConfigurer这个接口的类，实现这个接口的类为AsyncConfigurerSupport。但默认配置的线程池和异步处理方法均为空，因此，不管是继承或者从新实现接口，都需指定一个线程池。且从新实现 public Executor getAsyncExecutor()方法。

实现接口AsyncConfigurer

 1 @Configuration  2 public class AsyncConfiguration implements AsyncConfigurer {  3     @Bean("kingAsyncExecutor")  4     public ThreadPoolTaskExecutor executor() {  5         ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();  6         int corePoolSize = 10;  7  executor.setCorePoolSize(corePoolSize);  8         int maxPoolSize = 50;  9  executor.setMaxPoolSize(maxPoolSize); 10         int queueCapacity = 10; 11  executor.setQueueCapacity(queueCapacity); 12         executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy()); 13         String threadNamePrefix = "kingDeeAsyncExecutor-"; 14  executor.setThreadNamePrefix(threadNamePrefix); 15         executor.setWaitForTasksToCompleteOnShutdown(true); 16         // 使用自定义的跨线程的请求级别线程工厂类
17         RequestContextThreadFactory threadFactory = RequestContextThreadFactory.getDefault(); 18  executor.setThreadFactory(threadFactory); 19         int awaitTerminationSeconds = 5; 20  executor.setAwaitTerminationSeconds(awaitTerminationSeconds); 21  executor.initialize(); 22         return executor; 23  } 24 
25  @Override 26     public Executor getAsyncExecutor() { 27         return executor(); 28  } 29 
30  @Override 31     public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() { 32         return (ex, method, params) -> ErrorLogger.getInstance().log(String.format("执行异步任务'%s'", method), ex); 33  } 34 }

继承AsyncConfigurerSupport

@Configuration @EnableAsync class SpringAsyncConfigurer extends AsyncConfigurerSupport { @Bean public ThreadPoolTaskExecutor asyncExecutor() { ThreadPoolTaskExecutor threadPool = new ThreadPoolTaskExecutor(); threadPool.setCorePoolSize(3); threadPool.setMaxPoolSize(3); threadPool.setWaitForTasksToCompleteOnShutdown(true); threadPool.setAwaitTerminationSeconds(60 * 15); return threadPool; } @Override public Executor getAsyncExecutor() { return asyncExecutor; } @Override public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() { return (ex, method, params) -> ErrorLogger.getInstance().log(String.format("执行异步任务'%s'", method), ex); } }

配置自定义的TaskExecutor

因为AsyncConfigurer的默认线程池在源码中为空，Spring经过beanFactory.getBean(TaskExecutor.class)先查看是否有线程池，未配置时，经过beanFactory.getBean(DEFAULT_TASK_EXECUTOR_BEAN_NAME, Executor.class)，又查询是否存在默认名称为TaskExecutor的线程池。因此可在项目中，定义名称为TaskExecutor的bean生成一个默认线程池。也可不指定线程池的名称，申明一个线程池，自己底层是基于TaskExecutor.class即可。

好比：

 Executor.class:ThreadPoolExecutorAdapter->ThreadPoolExecutor->AbstractExecutorService->ExecutorService->Executor（这样的模式，最终底层为Executor.class，在替换默认的线程池时，需设置默认的线程池名称为TaskExecutor）

 Executor.class:ThreadPoolTaskExecutor->SchedulingTaskExecutor->AsyncTaskExecutor->TaskExecutor（这样的模式，最终底层为TaskExecutor.class，在替换默认的线程池时，可不指定线程池名称。）

 1 @EnableAsync  2 @Configuration  3 public class TaskPoolConfig {  4     @Bean(name = AsyncExecutionAspectSupport.DEFAULT_TASK_EXECUTOR_BEAN_NAME)  5     public Executor taskExecutor() {  6         ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();  7          //核心线程池大小
 8         executor.setCorePoolSize(10);  9         //最大线程数
10         executor.setMaxPoolSize(20); 11         //队列容量
12         executor.setQueueCapacity(200); 13         //活跃时间
14         executor.setKeepAliveSeconds(60); 15         //线程名字前缀
16         executor.setThreadNamePrefix("taskExecutor-"); 17         executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy()); 18         return executor; 19  }

@Bean(name = "new_task") 5 public Executor taskExecutor() { 6 ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); 7 //核心线程池大小 8 executor.setCorePoolSize(10); 9 //最大线程数 10 executor.setMaxPoolSize(20); 11 //队列容量 12 executor.setQueueCapacity(200); 13 //活跃时间 14 executor.setKeepAliveSeconds(60); 15 //线程名字前缀 16 executor.setThreadNamePrefix("taskExecutor-"); 17 executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy()); 18 return executor; 19  }