来源:www.cnblogs.com/wlandwl/p/async.html
本文讲述@Async
注解,在Spring体系中的应用,
本文仅说明@Async
注解的应用规则,对于原理,呼叫逻辑,原始码分析,暂不介绍,对于异步方法呼叫,从Spring3开始提供了@Async
注解,该注解可以被标注在方法上,以便异步地呼叫该方法,呼叫者将在呼叫时立即回传,方法的实际执行将提交给Spring TaskExecutor的任务中,由指定的执行绪池中的执行绪执行,
在项目应用中,@Async
呼叫执行绪池,推荐使用自定义执行绪池的模式,
自定义执行绪池常用方案:重新实作界面AsyncConfigurer,
简介
应用场景
同步: 同步就是整个处理程序顺序执行,当各个程序都执行完毕,并回传结果,
异步: 异步呼叫则是只是发送了呼叫的指令,呼叫者无需等待被呼叫的方法完全执行完毕;而是继续执行下面的流程,
例如, 在某个呼叫中,需要顺序呼叫 A, B, C三个程序方法;如他们都是同步呼叫,则需要将他们都顺序执行完毕之后,方算作程序执行完毕;如B为一个异步的呼叫方法,则在执行完A之后,呼叫B,并不等待B完成,而是执行开始呼叫C,待C执行完毕之后,就意味着这个程序执行完毕了,
在Java中,一般在处理类似的场景之时,都是基于创建独立的执行绪去完成相应的异步呼叫逻辑,通过主执行绪和不同的业务子执行绪之间的执行流程,从而在启动独立的执行绪之后,主执行绪继续执行而不会产生停滞等待的情况,
Spring 已经实作的执行绪池
SimpleAsyncTaskExecutor
:不是真的执行绪池,这个类不重用执行绪,默认每次呼叫都会创建一个新的执行绪,SyncTaskExecutor
:这个类没有实作异步呼叫,只是一个同步操作,只适用于不需要多执行绪的地方,ConcurrentTaskExecutor
:Executor的适配类,不推荐使用,如果ThreadPoolTaskExecutor不满足要求时,才用考虑使用这个类,SimpleThreadPoolTaskExecutor
:是Quartz的SimpleThreadPool的类,执行绪池同时被quartz和非quartz使用,才需要使用此类,ThreadPoolTaskExecutor
:最常使用,推荐,其实质是对java.util.concurrent.ThreadPoolExecutor
的包装,
异步的方法有:
- 最简单的异步呼叫,回传值为void
- 带自变量的异步呼叫,异步方法可以传入自变量
- 存在回传值,常呼叫回传Future
Spring中启用@Async
// 基于Java配置的启用方式:
@Configuration
@EnableAsync
public class SpringAsyncConfig { ... }
// Spring boot启用:
@EnableAsync
@EnableTransactionManagement
public class SettlementApplication {
public static void main(String[] args) {
SpringApplication.run(SettlementApplication.class, args);
}
}
@Async应用默认执行绪池
Spring应用默认的执行绪池,指在@Async
注解在使用时,不指定执行绪池的名称,查看原始码,@Async
的默认执行绪池为SimpleAsyncTaskExecutor,
Spring Boot 基础就不介绍了,推荐下这个实战教程:
https://github.com/javastacks/spring-boot-best-practice
无回传值呼叫
基于@Async
无回传值呼叫,直接在使用类,使用方法(建议在使用方法)上,加上注解,若需要抛出例外,需手动new一个例外抛出,
/**
* 带自变量的异步呼叫 异步方法可以传入自变量
* 对于回传值是void,例外会被AsyncUncaughtExceptionHandler处理掉
* @param s
*/
@Async
public void asyncInvokeWithException(String s) {
log.info("asyncInvokeWithParameter, parementer={}", s);
throw new IllegalArgumentException(s);
}
有回传值Future呼叫
/**
* 例外呼叫回传Future
* 对于回传值是Future,不会被AsyncUncaughtExceptionHandler处理,需要我们在方法中捕获例外并处理
* 或者在呼叫方在呼叫Futrue.get时捕获例外进行处理
*
* @param i
* @return
*/
@Async
public Future<String> asyncInvokeReturnFuture(int i) {
log.info("asyncInvokeReturnFuture, parementer={}", i);
Future<String> future;
try {
Thread.sleep(1000 * 1);
future = new AsyncResult<String>("success:" + i);
throw new IllegalArgumentException("a");
} catch (InterruptedException e) {
future = new AsyncResult<String>("error");
} catch(IllegalArgumentException e){
future = new AsyncResult<String>("error-IllegalArgumentException");
}
return future;
}
有回传值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界面
/**
* 资料查询执行绪池
*/
private static final ThreadPoolExecutor SELECT_POOL_EXECUTOR = new ThreadPoolExecutor(10, 20, 5000,
TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>(1024), new ThreadFactoryBuilder().setNameFormat("selectThreadPoolExecutor-%d").build());
// tradeMapper.countTradeLog(tradeSearchBean)方法表示,获取数量,回传值为int
// 获取总条数
CompletableFuture<Integer> countFuture = CompletableFuture
.supplyAsync(() -> tradeMapper.countTradeLog(tradeSearchBean), SELECT_POOL_EXECUTOR);
// 同步阻塞
CompletableFuture.allOf(countFuture).join();
// 获取结果
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
@Configuration
public class AsyncConfiguration implements AsyncConfigurer {
@Bean("kingAsyncExecutor")
public ThreadPoolTaskExecutor executor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
int corePoolSize = 10;
executor.setCorePoolSize(corePoolSize);
int maxPoolSize = 50;
executor.setMaxPoolSize(maxPoolSize);
int queueCapacity = 10;
executor.setQueueCapacity(queueCapacity);
executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
String threadNamePrefix = "kingDeeAsyncExecutor-";
executor.setThreadNamePrefix(threadNamePrefix);
executor.setWaitForTasksToCompleteOnShutdown(true);
// 使用自定义的跨执行绪的请求级别执行绪工厂类19 int awaitTerminationSeconds = 5;
executor.setAwaitTerminationSeconds(awaitTerminationSeconds);
executor.initialize();
return executor;
}
@Override
public Executor getAsyncExecutor() {
return executor();
}
@Override
public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
return (ex, method, params) -> ErrorLogger.getInstance().log(String.format("执行异步任务'%s'", method), ex);
}
}
继承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
TaskExecutor.class:ThreadPoolTaskExecutor->SchedulingTaskExecutor->AsyncTaskExecutor->TaskExecutor
这样的模式,最终底层为TaskExecutor.class
,在替换默认的执行绪池时,可不指定执行绪池名称,
@EnableAsync
@Configuration
public class TaskPoolConfig {
@Bean(name = AsyncExecutionAspectSupport.DEFAULT_TASK_EXECUTOR_BEAN_NAME)
public Executor taskExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
//核心执行绪池大小
executor.setCorePoolSize(10);
//最大执行绪数
executor.setMaxPoolSize(20);
//队列容量
executor.setQueueCapacity(200);
//活跃时间
executor.setKeepAliveSeconds(60);
//执行绪名字前缀
executor.setThreadNamePrefix("taskExecutor-");
executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
return executor;
}
@Bean(name = "new_task")
public Executor taskExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
//核心执行绪池大小
executor.setCorePoolSize(10);
//最大执行绪数
executor.setMaxPoolSize(20);
//队列容量
executor.setQueueCapacity(200);
//活跃时间
executor.setKeepAliveSeconds(60);
//执行绪名字前缀
executor.setThreadNamePrefix("taskExecutor-");
executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
return executor;
}
}
多个执行绪池
@Async
注解,使用系统默认或者自定义的执行绪池(代替默认执行绪池),可在项目中设定多个执行绪池,在异步呼叫时,指明需要呼叫的执行绪池名称,如@Async("new_task")
,
@Async部分重要原始码决议
原始码-获取执行绪池方法
原始码-设定默认执行绪池defaultExecutor,默认是空的,当重新实作界面AsyncConfigurer的getAsyncExecutor()
时,可以设定默认的执行绪池,
原始码-都没有找到项目中设定的默认执行绪池时,采用spring 默认的执行绪池
近期热文推荐:
1.1,000+ 道 Java面试题及答案整理(2021最新版)
2.劲爆!Java 协程要来了,,,
3.玩大了!Log4j 2.x 再爆雷,,,
4.Spring Boot 2.6 正式发布,一大波新特性,,
5.《Java开发手册(嵩山版)》最新发布,速速下载!
觉得不错,别忘了随手点赞+转发哦!
0 评论