Springboot注解@Async线程池实例详解
这篇⽂章主要介绍了Spring boot注解@Async线程池实例详解,⽂中通过⽰例代码介绍的⾮常详细,对⼤家的学习或者⼯作具有⼀定的参考学习价值,需要的朋友可以参考下
从Spring3开始提供了@Async注解,该注解可以被标注在⽅法上,以便异步地调⽤该⽅法。调⽤者将在调⽤时⽴即返回,⽅法的实际执⾏将提交给Spring TaskExecutor的任务中,由指定的线程池中的线程执⾏。
1. TaskExecutor
Spring异步线程池的接⼝类,其实质是urrent.Executor
Spring 已经实现的异常线程池:
1. SimpleAsyncTaskExecutor:不是真的线程池,这个类不重⽤线程,每次调⽤都会创建⼀个新的线程。
2. SyncTaskExecutor:这个类没有实现异步调⽤,只是⼀个同步操作。只适⽤于不需要多线程的地⽅
3. ConcurrentTaskExecutor:Executor的适配类,不推荐使⽤。如果ThreadPoolTaskExecutor不满⾜要求时,才⽤考虑使⽤这
个类
4. SimpleThreadPoolTaskExecutor:是Quartz的SimpleThreadPool的类。线程池同时被quartz和⾮quartz使⽤,才需要使⽤此类
5. ThreadPoolTaskExecutor :最常使⽤,推荐。 其实质是对urrent.ThreadPoolExecutor的包装
2. @EnableAsync @Async
(1) springboot的启动类,@EnableAsync注解开启异步调⽤
(2) spring对@Async定义异步任务
异步的⽅法有3种
1. 最简单的异步调⽤,返回值为void, 基于@Async⽆返回值调⽤,直接在使⽤类,使⽤⽅法(建议在使⽤⽅法)上,加上注解。若需要抛出异常,需⼿动new⼀个异常抛出。
2. 带参数的异步调⽤ 异步⽅法可以传⼊参数
3. 异常调⽤返回Future,不会被AsyncUncaughtExceptionHandler处理,需要我们在⽅法中捕获异常并处理或者在调⽤⽅在调⽤时捕获异常进⾏处理
3. @Async应⽤默认线程池
spring应⽤默认的线程池,指在@Async注解在使⽤时,不指定线程池的名称。查看源码,@Async的默认线程池为SimpleAsyncTaskExecutor。
默认线程池的弊端
在线程池应⽤中,参考阿⾥巴巴java开发规范:线程池不允许使⽤Executors去创建,不允许使⽤系统默认的线程池,推荐通过ThreadPoolExecutor的⽅式,这样的处理⽅式让开发的⼯程师更加明确线程池的运⾏规则,规避资源耗尽的风险。Executors各个⽅法的弊端:
newFixedThreadPool和newSingleThreadExecutor:主要问题是堆积的请求处理队列可能会耗费⾮常⼤的内存,甚⾄OOM。
newCachedThreadPool和newScheduledThreadPool:要问题是线程数最⼤数是Integer.MAX_VALUE,可能会创建数量⾮常多的线程,甚⾄OOM。
@Async默认异步配置使⽤的是SimpleAsyncTaskExecutor,该线程池默认来⼀个任务创建⼀个线程,若系统中不断的创建线程,最终会导致系统占⽤内存过⾼,引发OutOfMemoryError错误。针对线程创建问题,SimpleAsyncTaskExecutor提供了限流机制,通过concurrencyLimit属性来控制开关,当concurrencyLimit>=0时开启限流机制,默认关闭限流机制即concurrencyLimit=-1,当关闭情况下,会不断创建新的线程来处理任务。基于默认配置,SimpleAsyncTaskExecutor并不是严格意义的线程池,达不到线程复⽤的功能。
4. @Async应⽤⾃定义线程池
⾃定义线程池,可对系统中线程池更加细粒度的控制,⽅便调整线程池⼤⼩配置,线程执⾏异常控制和处理。在设置系统⾃定义线程池代替默认线程池时,虽可通过多种模式设置,但替换默认线程池最终产⽣的线程池有且只能设置⼀个(不能设置多个类继承AsyncConfigurer)。⾃定义线程池有如下模式:
重新实现接⼝AsyncConfigurer
继承AsyncConfigurerSupport
配置由⾃定义的TaskExecutor替代内置的任务执⾏器
通过查看Spring源码关于@Async的默认调⽤规则,会优先查询源码中实现AsyncConfigurer这个接⼝的类,实现这个接⼝的类为AsyncConfigurerSupport。但默认配置的线程池和异步处理⽅法均为空,所以,⽆论是继承或者重新实现接⼝,都需指定⼀个线程池。且重新实现 public Executor getAsyncExecutor()⽅法。
(1)实现接⼝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);
// 使⽤⾃定义的跨线程的请求级别线程⼯⼚类
RequestContextThreadFactory threadFactory = Default();
executor.setThreadFactory(threadFactory);
int awaitTerminationSeconds = 5;
executor.setAwaitTerminationSeconds(awaitTerminationSeconds);
executor.initialize();
return executor;
}
@Override
public Executor getAsyncExecutor() {
return executor();
}
@Override
public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
return (ex, method, params) -> Instance().log(String.format("执⾏异步任务'%s'", method), ex);
}
}
(2)继承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) -> Instance().log(String.format("执⾏异步任务'%s'", method), ex);
}
}
(3)配置⾃定义的TaskExecutor
由于AsyncConfigurer的默认线程池在源码中为空,Spring通过Bean(TaskExecutor.class)先查看是否有线程池,未配置时,通过Bean(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,在替换默认的线程池时,可不指定线程池名称。)
figs;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.aop.interceptor.AsyncUncaughtExceptionHandler;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.scheduling.annotation.AsyncConfigurer;
import org.urrent.ThreadPoolTaskExecutor;
import org.springframework.stereotype.Component;
import urrent.Executor;
import urrent.ThreadPoolExecutor;
/**
* @author liuyu
* @className TaskConfiguration
* @date 2019/12/17 11:40
* @description
*/
@Component
public class TaskConfiguration implements AsyncConfigurer {
private static Logger logger = Logger(TaskConfiguration.class);
@Value("${PoolSize:10}")
private int corePoolSize;
@Value("${thread.pool.maxPoolSize:20}")
private int maxPoolSize;
@Value("${thread.pool.keepAliveSeconds:4}")
private int keepAliveSeconds;
@Value("${thread.pool.queueCapacity:512}")
private int queueCapacity;
@Value("${thread.pool.waitForTasksToCompleteOnShutdown:true}")
private boolean waitForTasksToCompleteOnShutdown;
@Value("${thread.pool.awaitTerminationSeconds:60}")
private int awaitTerminationSeconds;
@Override
public Executor getAsyncExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
//核⼼线程数
executor.setCorePoolSize(corePoolSize);
//线程池最⼤的线程数,只有在缓冲队列满了之后,才会申请超过核⼼线程数的线程
executor.setMaxPoolSize(maxPoolSize);
//允许线程的空闲时间,当超过了核⼼线程之外的线程,在空闲时间到达之后会被销毁
executor.setKeepAliveSeconds(keepAliveSeconds);
/
/⽤来缓冲执⾏任务的队列
executor.setQueueCapacity(queueCapacity);
//线程池名的前缀,可以⽤于定位处理任务所在的线程池
executor.setThreadNamePrefix("taskExecutor-");
//线程池对拒绝任务的处理策略
//此处局决策罗尚未研究透彻建议使⽤ new ThreadPoolExecutor.CallerRunsPolicy()
executor.setRejectedExecutionHandler((Runnable r, ThreadPoolExecutor exe) -> {
logger.warn("当前任务线程池队列已满.");
});
//该⽅法⽤来设置线程池关闭的时候等待所有任务都完成后,再继续销毁其他的Bean,这样这些异步任务的销毁就会先于数据库连接池对象的销毁。
executor.setWaitForTasksToCompleteOnShutdown(waitForTasksToCompleteOnShutdown);
//该⽅法⽤来设置线程池中,任务的等待时间,如果超过这个时间还没有销毁就强制销毁,以确保应⽤最后能够被关闭,⽽不是阻塞住。
executor.setAwaitTerminationSeconds(awaitTerminationSeconds);
executor.initialize();
return executor;
}
@Override
public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
return (ex, method, params) -> ("线程池执⾏任务发⽣未知异常.", ex);
}
}
多个线程池
@Async注解,使⽤系统默认或者⾃定义的线程池(代替默认线程池)。可在项⽬中设置多个线程池,在异步调⽤时,指明需要调⽤的线程池名称,如@Async("new_task")。
5. @Async注解失效原因
没有过去到代理类,本类调⽤时,直接⾃⼰内部调⽤,没有⾛代理类
1.没有在@SpringBootApplication启动类当中添加注解@EnableAsync注解。
2.异步⽅法使⽤注解@Async的返回值只能为void或者Future。
springboot aop3.没有⾛Spring的代理类。因为@Transactional和@Async注解的实现都是基于Spring的AOP,⽽AOP的实现是基于动态代理模式实现的。那么注解失效的原因就很明显了,有可能因为调⽤⽅法的是对象本⾝⽽不是代理对象,因为没有经过Spring容器。
解决⽅法:
这⾥具体说⼀下第三种情况的解决⽅法。
1.注解的⽅法必须是public⽅法。
2.⽅法⼀定要从另⼀个类中调⽤,也就是从类的外部调⽤,类的内部调⽤是⽆效的。
3.如果需要从类的内部调⽤,需要先获取其代理类,下⾯上代码
@Service
public class AsyncService{
public void methodA(){
...
AsyncService asyncServiceProxy = Bean(AsyncService.class);
asyncServiceProxy .methodB();
...
}
@Async
public void methodB() {
...
}
}
本类中可以定义实现本类中调⽤的本类的异步多线程⽅法;
必须实现的两种:
public⽅法
⼿动获取spring bean
SpringUtils的⼯具类,⼿动获取bean⽅法:

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。