1 异步@Async详解
1.1 引言
在java
中异步线程很重要,比如在业务流处理时,需要通知硬件设备,发短信通知用户,或者需要上传一些图片资源到其他服务器这种耗时的操作,在主线程里处理会阻塞整理流程,而且我们也不需要等待处理结果之后再进行下一步操作,这时候就可以使用异步线程进行处理,这样主线程不会因为这些耗时的操作而阻塞,保证主线程的流程可以正常进行。
最近在项目中使用了很多线程的操作,在这做个记录
1.2 异步说明和原理
使用地方说明:
- 在方法上使用该
@Async
注解,申明该方法是一个异步任务; - 在类上面使用该
@Async
注解,申明该类中的所有方法都是异步任务; - 使用此注解的方法的类对象,必须是
spring
管理下的bean
对象; - 要想使用异步任务,需要在主类上开启异步配置,即,配置上
@EnableAsync
注解;
@Async
的原理概括:@Async
的原理是通过 Spring AOP
动态代理 的方式来实现的。Spring
容器启动初始化bean
时,判断类中是否使用了@Async
注解,如果使用了则为其创建切入点和切入点处理器,根据切入点创建代理,在线程调用@Async
注解标注的方法时,会调用代理,执行切入点处理器invoke
方法,将方法的执行提交给线程池中的另外一个线程来处理,从而实现了异步执行。
所以,需要注意的一个错误用法是,如果a方法调用它同类中的标注@Async
的b
方法,是不会异步执行的,因为从a方法进入调用的都是该类对象本身,不会进入代理类。
因此,相同类中的方法调用带@Async
的方法是无法异步的,这种情况仍然是同步。
1.3 @Async使用
在Spring
中启用@Async
:
-
@Async
注解在使用时,如果不指定线程池的名称,则使用Spring
默认的线程池,Spring
默认的线程池为SimpleAsyncTaskExecutor
。 - 方法上一旦标记了这个
@Async
注解,当其它线程调用这个方法时,就会开启一个新的子线程去异步处理该业务逻辑。
1.3.1 启动类中增加@EnableAsync
以Spring boot
为例,启动类中增加@EnableAsync
:
@EnableAsync
@SpringBootApplication
public class ManageApplication {
//...
}
1.3.2 方法上加@Async注解
@Component
public class MyAsyncTask {
@Async
public void asyncCpsItemImportTask(Long platformId, String jsonList){
//...具体业务逻辑
}
}
1.4 @Async异步线程池
1.4.1 默认线程池
上面的配置会启用默认的线程池/执行器,异步执行指定的方法。
Spring
默认的线程池的默认配置:
默认核心线程数:8,
最大线程数:Integet.MAX_VALUE,
队列使用LinkedBlockingQueue,
容量是:Integet.MAX_VALUE,
空闲线程保留时间:60s,
线程池拒绝策略:AbortPolicy
缺点
:从最大线程数的配置上,相信看到问题:并发情况下,会无限创建线程
默认线程池的上述缺陷如何解决:答案是,自定义配置参数就可以了
1.4.3 在配置文件中配置
spring:
task:
execution:
pool:
max-size: 6
core-size: 3
keep-alive: 3s
queue-capacity: 1000
thread-name-prefix: name
1.4.3 自定义线程池
在业务场景中,有时需要使用自己定义的执行器来跑异步的业务逻辑,那该怎么办呢?答案是,自定义线程池。
1.4.3.1 编写配置类
@Configuration
@Data
public class ExecutorConfig{
//核心线程
private int corePoolSize;
//最大线程
private int maxPoolSize;
//队列容量
private int queueCapacity;
//保持时间
private int keepAliveSeconds;
//名称前缀
private String preFix;
@Bean("MyExecutor")
public Executor myExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setCorePoolSize(corePoolSize);
executor.setMaxPoolSize(maxPoolSize);
executor.setQueueCapacity(queueCapacity);
executor.setKeepAliveSeconds(keepAliveSeconds);
executor.setThreadNamePrefix(preFix);
executor.setRejectedExecutionHandler( new ThreadPoolExecutor.AbortPolicy());
executor.initialize();
return executor;
}
}
1.4.3.2 使用自定义线程池
在方法上的@Async
注解处指定线程池名字:
@Component
public class MyAsyncTask {
@Async("MyExecutor") //使用自定义的线程池(执行器)
public void asyncCpsItemImportTask(Long platformId, String jsonList){
//...具体业务逻辑
}
}
1.4.4 Spring中的线程池(执行器)
Spring
用TaskExecutor
和TaskScheduler
接口提供了异步执行
和调度任务
的抽象。
Spring
的TaskExecutor
和java.util.concurrent.Executor
接口时一样的,这个接口只有一个方法execute(Runnable task)
。
Spring
已经内置了许多TaskExecutor
的实现,没有必要自己去实现:
-
SimpleAsyncTaskExecutor
: 这种实现不会重用任何线程,每次调用都会创建一个新的线程。 -
SyncTaskExecutor
: 这种实现不会异步的执行,相反,每次调用都在发起调用的线程中执行。它的主要用处是在不需要多线程的时候,比如简单的测试用例; -
ConcurrentTaskExecutor
:这个实现是对Java 5 java.util.concurrent.Executor
类的包装。有另一个ThreadPoolTaskExecutor
类更为好用,它暴露了Executor
的配置参数作为bean
属性。
点击了解Spring线程池ThreadPoolTaskExecutor讲解 -
SimpleThreadPoolTaskExecutor
: 这个实现实际上是Quartz
的SimpleThreadPool
类的子类,它会监听Spring
的生命周期回调。当有线程池,需要在Quartz
和非Quartz
组件中共用时,这是它的典型用处。 -
ThreadPoolTaskExecutor
:这是最常用、最通用的一种实现。它包含了java.util.concurrent.ThreadPoolExecutor
的属性,并且用TaskExecutor
进行包装。
1.5 异步中的事务和返回
1.5.1 异步事务
在@Async
标注的方法,同时也使用@Transactional
进行标注;在其调用数据库操作之时,将无法产生事务管理的控制,原因就在于其是基于异步处理
的操作。
那该如何给这些操作添加事务管理呢?
可以将需要事务管理操作的方法放置到异步方法内部,在内部被调用的方法上添加@Transactional
示例:
-
方法A
:使用了@Async/@Transactional
来标注,但是无法产生事务控制的目的。 -
方法B
:使用了@Async
来标注,B
中调用了C、D
,C/D
分别使用@Transactional
做了标注,则可实现事务控制的目的
1.5.2 异步返回
异步的业务逻辑处理场景 有两种:一个是不需要返回结果,另一种是需要接收返回结果。不需要返回结果的比较简单,就不多说了。
需要接收返回结果的示例如下:
@Async("MyExecutor")
public Future<Map<Long, List>> queryMap(List ids) {
List<> result = businessService.queryMap(ids);
..............
Map<Long, List> resultMap = Maps.newHashMap();
...
return new AsyncResult<>(resultMap);
}
调用异步方法的示例:
public Map<Long, List> asyncProcess(List<BindDeviceDO> bindDevices,List<BindStaffDO> bindStaffs, String dccId) {
Map<Long, List> finalMap =null;
// 返回值:
Future<Map<Long, List>> asyncResult = MyService.queryMap(ids);
try {
finalMap = asyncResult.get();
} catch (Exception e) {
...
}
return finalMap;
}
1.6 异步不能回调问题
使用了异步但是执行异步的方法,原因是在方法上加了@Async
注解,之所以加这个注解是因为报错:
There was an unexpected error (type=Internal Server Error, status=500).
Async support must be enabled on a servlet and for all filters involved in async request processing. This is done in Java code using the Servlet API or by adding<async-supported>true</async-supported>
to servlet and filter declarations in web.xml
异步测试时一直报这个错误,提示我在web.xml
开启异步支持,但是我是SpringBoot
项目,于是开始网上查找错误
:加@Async
注解,会更加异步,不能获取异步结果正确
:根本原因是容器注册问题,在springboot
启动类的注解@SpringBootApplication
旁边添加了@ServletComponentScan
,才导致上面的报错和不能回调,有三种解决方法:文章来源:https://www.toymoban.com/news/detail-430290.html
- 去掉注解
@ServletComponentScan
- 添加容器注册(springboot项目)
@Bean
public ServletRegistrationBean dispatcherServlet() {
ServletRegistrationBean registration = new ServletRegistrationBean(
new DispatcherServlet(), "/");
registration.setAsyncSupported(true);
return registration;
}
@Bean
DispatcherServlet dispatcherServlet(){
return new DispatcherServlet();
}
在过滤器那里添加asyncSupported = true
的支持文章来源地址https://www.toymoban.com/news/detail-430290.html
@WebFilter(urlPatterns="/*",asyncSupported = true)
- 修改
web.xml
(传统xml项目)
需要在web.xml
文件中的servlet
定义中添加:"<async-supported>true</async-supported>"
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
version="3.0">
<display-name>Archetype Created Web Application</display-name>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mybatis.xml</param-value>
</context-param>
<context-param>
<param-name>spring.profiles.active</param-name>
<param-value>dev</param-value>
</context-param>
<context-param>
<param-name>spring.profiles.default</param-name>
<param-value>dev</param-value>
</context-param>
<filter>
<filter-name>encodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<async-supported>true</async-supported>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
<init-param>
<param-name>forceEncoding</param-name>
<param-value>true</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>encodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<servlet>
<servlet-name>SpringMVC</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
<async-supported>true</async-supported>
</servlet>
<servlet-mapping>
<servlet-name>SpringMVC</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
到了这里,关于Spring之异步任务@Async详解分析的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!