Spring boot注解@Async线程池实例详解

Spring boot注解@Async线程池实例详解

这篇文章主要介绍了Spring boot注解@Async线程池实例详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

从Spring3开始提供了@Async注解，该注解可以被标注在方法上，以便异步地调用该方法。调用者将在调用时立即返回，方法的实际执行将提交给Spring TaskExecutor的任务中，由指定的线程池中的线程执行。

1. TaskExecutor

Spring异步线程池的接口类，其实质是java.util.concurrent.Executor

Spring 已经实现的异常线程池：

1. SimpleAsyncTaskExecutor：不是真的线程池，这个类不重用线程，每次调用都会创建一个新的线程。

2. SyncTaskExecutor：这个类没有实现异步调用，只是一个同步操作。只适用于不需要多线程的地方

3. ConcurrentTaskExecutor：Executor的适配类，不推荐使用。如果ThreadPoolTaskExecutor不满足要求时，才用考虑使用这

个类

4. SimpleThreadPoolTaskExecutor：是Quartz的SimpleThreadPool的类。线程池同时被quartz和非quartz使用，才需要使用此类

5. ThreadPoolTaskExecutor ：最常使用，推荐。 其实质是对java.util.concurrent.ThreadPoolExecutor的包装

2. @EnableAsync @Async

(1) springboot的启动类,@EnableAsync注解开启异步调用

(2) spring对@Async定义异步任务

异步的方法有3种

1. 最简单的异步调用，返回值为void， 基于@Async无返回值调用，直接在使用类，使用方法（建议在使用方法）上，加上注解。若需要抛出异常，需手动new一个异常抛出。

2. 带参数的异步调用 异步方法可以传入参数

3. 异常调用返回Future，不会被AsyncUncaughtExceptionHandler处理，需要我们在方法中捕获异常并处理或者在调用方在调用Futrue.get时捕获异常进行处理

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 = RequestContextThreadFactory.getDefault();

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) -> ErrorLogger.getInstance().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) -> ErrorLogger.getInstance().log(String.format("执行异步任务'%s'", method), ex);

}

}

(3)配置自定义的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，在替换默认的线程池时，可不指定线程池名称。）

package intellif.configs;

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.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

import org.springframework.stereotype.Component;

import java.util.concurrent.Executor;

import java.util.concurrent.ThreadPoolExecutor;

/**

* @author liuyu

* @className TaskConfiguration

* @date 2019/12/17 11:40

* @description

*/

@Component

public class TaskConfiguration implements AsyncConfigurer {

private static Logger logger = LogManager.getLogger(TaskConfiguration.class);

@Value("${thread.pool.corePoolSize: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-");

//线程池对拒绝任务的处理策略

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) -> logger.error("线程池执行任务发生未知异常.", ex);

}

}

多个线程池

@Async注解，使用系统默认或者自定义的线程池（代替默认线程池）。可在项目中设置多个线程池，在异步调用时，指明需要调用的线程池名称，如@Async("new_task")。

5. @Async注解失效原因

没有过去到代理类,本类调用时,直接自己内部调用,没有走代理类

1.没有在@SpringBootApplication启动类当中添加注解@EnableAsync注解。

2.异步方法使用注解@Async的返回值只能为void或者Future。

3.没有走Spring的代理类。因为@Transactional和@Async注解的实现都是基于Spring的AOP，而AOP的实现是基于动态代理模式实现的。那么注解失效的原因就很明显了，有可能因为调用方法的是对象本身而不是代理对象，因为没有经过Spring容器。

解决方法:

这里具体说一下第三种情况的解决方法。

1.注解的方法必须是public方法。

2.方法一定要从另一个类中调用，也就是从类的外部调用，类的内部调用是无效的。

3.如果需要从类的内部调用，需要先获取其代理类，下面上代码

@Service

public class AsyncService{

public void methodA(){

...

AsyncService asyncServiceProxy = SpringUtil.getBean(AsyncService.class);

asyncServiceProxy .methodB();

...

}

@Async

public void methodB() {

...

}

}

本类中可以定义实现本类中调用的本类的异步多线程方法；

必须实现的两种：

public方法

手动获取spring bean

SpringUtils的工具类，手动获取bean方法：

package intellif.util;

import org.springframework.beans.BeansException;

import org.springframework.context.ApplicationContext;

import org.springframework.context.ApplicationContextAware;

import org.springframework.stereotype.Component;

/**

* @author liuyu

* @className SpringUtils

* @date 2019/12/16 20:55

* @description

*/

@Component("springContextUtil")

public class SpringUtils implements ApplicationContextAware {

private static ApplicationContext applicationContext = null;

public static ApplicationContext getApplicationContext() {

return applicationContext;

}

@SuppressWarnings("unchecked")

public static T getBean(String beanId) {

return (T) applicationContext.getBean(beanId);

}

public static T getBean(Class requiredType) {

return (T) applicationContext.getBean(requiredType);

}

/**

* Spring容器启动后，会把 applicationContext 给自动注入进来，然后我们把 applicationContext

* 赋值到静态变量中，方便后续拿到容器对象

*http:// @see org.springframework.context.ApplicationContextAware#setApplicationContext(org.springframework.context.ApplicationContext)

*/

@Override

public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {

SpringUtils.applicationContext = applicationContext;

}

}

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。