本篇文章為大家展示了Spring中如何使用@Async異步注解,內(nèi)容簡(jiǎn)明扼要并且容易理解,絕對(duì)能使你眼前一亮,通過這篇文章的詳細(xì)介紹希望你能有所收獲。
成都創(chuàng)新互聯(lián)公司-專業(yè)網(wǎng)站定制、快速模板網(wǎng)站建設(shè)、高性價(jià)比寧江網(wǎng)站開發(fā)、企業(yè)建站全套包干低至880元,成熟完善的模板庫,直接使用。一站式寧江網(wǎng)站制作公司更省心,省錢,快速模板網(wǎng)站建設(shè)找我們,業(yè)務(wù)覆蓋寧江地區(qū)。費(fèi)用合理售后完善,十年實(shí)體公司更值得信賴。
本著講一個(gè)知識(shí)點(diǎn)就要講明白、講透徹的原則,我決定單獨(dú)寫一篇這樣的文章對(duì)@Async
這個(gè)注解做一下詳細(xì)的介紹,這個(gè)注解帶來的問題遠(yuǎn)遠(yuǎn)不止循環(huán)依賴這么簡(jiǎn)單,如果對(duì)它不夠熟悉的話建議慎用。
?這個(gè)注解的作用在于可以讓被標(biāo)注的方法異步執(zhí)行,但是有兩個(gè)前提條件
1. 配置類上添加 @EnableAsync
注解2. 需要異步執(zhí)行的方法的所在類由Spring管理 3. 需要異步執(zhí)行的方法上添加了 ”@Async
注解
我們通過一個(gè)Demo體會(huì)下這個(gè)注解的作用吧
第一步,配置類上開啟異步:
@EnableAsync
@Configuration
@ComponentScan("com.dmz.spring.async")
public class Config {
}
第二步,
@Component // 這個(gè)類本身要被Spring管理
public class DmzAsyncService {
@Async // 添加注解表示這個(gè)方法要異步執(zhí)行
public void testAsync(){
try {
TimeUnit.SECONDS.sleep(1);
} catch (InterruptedException e) {
e.printStackTrace();
}
System.out.println("testAsync invoked");
}
}
第三步,測(cè)試異步執(zhí)行
public class Main {
public static void main(String[] args) {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(Config.class);
DmzAsyncService bean = ac.getBean(DmzAsyncService.class);
bean.testAsync();
System.out.println("main函數(shù)執(zhí)行完成");
}
}
// 程序執(zhí)行結(jié)果如下:
// main函數(shù)執(zhí)行完成
// testAsync invoked
通過上面的例子我們可以發(fā)現(xiàn),DmzAsyncService
中的testAsync
方法是異步執(zhí)行的,那么這背后的原理是什么呢?我們接著分析
我們?cè)诜治瞿骋粋€(gè)技術(shù)的時(shí)候,最重要的事情是,一定一定要找到代碼的入口,像Spring這種都很明顯,入口必定是在@EnableAsync
這個(gè)注解上面,我們來看看這個(gè)注解干了啥事(本文基于5.2.x
版本)
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
// 這里是重點(diǎn),導(dǎo)入了一個(gè)ImportSelector
@Import(AsyncConfigurationSelector.class)
public @interface EnableAsync {
// 這個(gè)配置可以讓程序員配置需要被檢查的注解,默認(rèn)情況下檢查的就是@Async注解
Class extends Annotation> annotation() default Annotation.class;
// 默認(rèn)使用jdk代理
boolean proxyTargetClass() default false;
// 默認(rèn)使用Spring AOP
AdviceMode mode() default AdviceMode.PROXY;
// 在后續(xù)分析我們會(huì)發(fā)現(xiàn),這個(gè)注解實(shí)際往容器中添加了一個(gè)
// AsyncAnnotationBeanPostProcessor,這個(gè)后置處理器實(shí)現(xiàn)了Ordered接口
// 這個(gè)配置主要代表了AsyncAnnotationBeanPostProcessor執(zhí)行的順序
int order() default Ordered.LOWEST_PRECEDENCE;
}
上面這個(gè)注解做的最重要的事情就是導(dǎo)入了一個(gè)AsyncConfigurationSelector
,這個(gè)類的源碼如下:
public class AsyncConfigurationSelector extends AdviceModeImportSelector {
private static final String ASYNC_EXECUTION_ASPECT_CONFIGURATION_CLASS_NAME =
"org.springframework.scheduling.aspectj.AspectJAsyncConfiguration";
@Override
@Nullable
public String[] selectImports(AdviceMode adviceMode) {
switch (adviceMode) {
// 默認(rèn)會(huì)使用SpringAOP進(jìn)行代理
case PROXY:
return new String[] {ProxyAsyncConfiguration.class.getName()};
case ASPECTJ:
return new String[] {ASYNC_EXECUTION_ASPECT_CONFIGURATION_CLASS_NAME};
default:
return null;
}
}
}
這個(gè)類的作用是像容器中注冊(cè)了一個(gè)ProxyAsyncConfiguration
,這個(gè)類的繼承關(guān)系如下:
我們先看下它的父類AbstractAsyncConfiguration
,其源碼如下:
@Configuration
public abstract class AbstractAsyncConfiguration implements ImportAware {
@Nullable
protected AnnotationAttributes enableAsync;
@Nullable
protected Supplier executor;
@Nullable
protected Supplier exceptionHandler;
// 這里主要就是檢查將其導(dǎo)入的類上是否有EnableAsync注解
// 如果沒有的話就報(bào)錯(cuò)
@Override
public void setImportMetadata(AnnotationMetadata importMetadata) {
this.enableAsync = AnnotationAttributes.fromMap(
importMetadata.getAnnotationAttributes(EnableAsync.class.getName(), false));
if (this.enableAsync == null) {
throw new IllegalArgumentException(
"@EnableAsync is not present on importing class " + importMetadata.getClassName());
}
}
// 將容器中配置的AsyncConfigurer注入
// 異步執(zhí)行嘛,所以我們可以配置使用的線程池
// 另外也可以配置異常處理器
@Autowired(required = false)
void setConfigurers(Collection configurers) {
if (CollectionUtils.isEmpty(configurers)) {
return;
}
if (configurers.size() > 1) {
throw new IllegalStateException("Only one AsyncConfigurer may exist");
}
AsyncConfigurer configurer = configurers.iterator().next();
this.executor = configurer::getAsyncExecutor;
this.exceptionHandler = configurer::getAsyncUncaughtExceptionHandler;
}
}
再來看看ProxyAsyncConfiguration
這個(gè)類的源碼
@Configuration
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
public class ProxyAsyncConfiguration extends AbstractAsyncConfiguration {
@Bean(name = TaskManagementConfigUtils.ASYNC_ANNOTATION_PROCESSOR_BEAN_NAME)
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
public AsyncAnnotationBeanPostProcessor asyncAdvisor() {
AsyncAnnotationBeanPostProcessor bpp = new AsyncAnnotationBeanPostProcessor();
// 將通過AsyncConfigurer配置好的線程池跟異常處理器設(shè)置到這個(gè)后置處理器中
bpp.configure(this.executor, this.exceptionHandler);
Class extends Annotation> customAsyncAnnotation = this.enableAsync.getClass("annotation");
if (customAsyncAnnotation != AnnotationUtils.getDefaultValue(EnableAsync.class, "annotation")) {
bpp.setAsyncAnnotationType(customAsyncAnnotation);
}
bpp.setProxyTargetClass(this.enableAsync.getBoolean("proxyTargetClass"));
bpp.setOrder(this.enableAsync.getNumber("order"));
return bpp;
}
}
這個(gè)類本身是一個(gè)配置類,它的作用是向容器中添加一個(gè)AsyncAnnotationBeanPostProcessor
。到這一步我們基本上就可以明白了,@Async
注解的就是通過AsyncAnnotationBeanPostProcessor
這個(gè)后置處理器生成一個(gè)代理對(duì)象來實(shí)現(xiàn)異步的,接下來我們就具體看看AsyncAnnotationBeanPostProcessor
是如何生成代理對(duì)象的,我們主要關(guān)注一下幾點(diǎn)即可:
基于上面幾個(gè)問題,我們進(jìn)行逐一分析
我們抓住重點(diǎn),AsyncAnnotationBeanPostProcessor
是一個(gè)后置處理器器,按照我們對(duì)Spring的了解,大概率是在這個(gè)后置處理器的postProcessAfterInitialization
方法中完成了代理,直接定位到這個(gè)方法,這個(gè)方法位于父類AbstractAdvisingBeanPostProcessor
中,具體代碼如下:
public Object postProcessAfterInitialization(Object bean, String beanName) {
// 沒有通知,或者是AOP的基礎(chǔ)設(shè)施類,那么不進(jìn)行代理
if (this.advisor == null || bean instanceof AopInfrastructureBean) {
return bean;
}
// 對(duì)已經(jīng)被代理的類,不再生成代理,只是將通知添加到代理類的邏輯中
// 這里通過beforeExistingAdvisors決定是將通知添加到所有通知之前還是添加到所有通知之后
// 在使用@Async注解的時(shí)候,beforeExistingAdvisors被設(shè)置成了true
// 意味著整個(gè)方法及其攔截邏輯都會(huì)異步執(zhí)行
if (bean instanceof Advised) {
Advised advised = (Advised) bean;
if (!advised.isFrozen() && isEligible(AopUtils.getTargetClass(bean))) {
if (this.beforeExistingAdvisors) {
advised.addAdvisor(0, this.advisor);
}
else {
advised.addAdvisor(this.advisor);
}
return bean;
}
}
// 判斷需要對(duì)哪些Bean進(jìn)行來代理
if (isEligible(bean, beanName)) {
ProxyFactory proxyFactory = prepareProxyFactory(bean, beanName);
if (!proxyFactory.isProxyTargetClass()) {
evaluateProxyInterfaces(bean.getClass(), proxyFactory);
}
proxyFactory.addAdvisor(this.advisor);
customizeProxyFactory(proxyFactory);
return proxyFactory.getProxy(getProxyClassLoader());
}
return bean;
}
果不其然,確實(shí)是在這個(gè)方法中完成的代理。接著我們就要思考,切點(diǎn)的過濾規(guī)則是什么呢?
其實(shí)也不難猜到肯定就是類上添加了@Async
注解或者類中含有被@Async
注解修飾的方法?;诖?,我們看看這個(gè)isEligible
這個(gè)方法的實(shí)現(xiàn)邏輯,這個(gè)方位位于AbstractBeanFactoryAwareAdvisingPostProcessor
中,也是AsyncAnnotationBeanPostProcessor
的父類,對(duì)應(yīng)代碼如下:
// AbstractBeanFactoryAwareAdvisingPostProcessor的isEligible方法
// 調(diào)用了父類
protected boolean isEligible(Object bean, String beanName) {
return (!AutoProxyUtils.isOriginalInstance(beanName, bean.getClass()) &&
super.isEligible(bean, beanName));
}
protected boolean isEligible(Object bean, String beanName) {
return isEligible(bean.getClass());
}
protected boolean isEligible(Class> targetClass) {
Boolean eligible = this.eligibleBeans.get(targetClass);
if (eligible != null) {
return eligible;
}
if (this.advisor == null) {
return false;
}
// 這里完成的判斷
eligible = AopUtils.canApply(this.advisor, targetClass);
this.eligibleBeans.put(targetClass, eligible);
return eligible;
}
實(shí)際上最后就是根據(jù)advisor來確定是否要進(jìn)行代理,在Spring中AOP相關(guān)的API及源碼解析,原來AOP是這樣子的這篇文章中我們提到過,advisor實(shí)際就是一個(gè)綁定了切點(diǎn)的通知,那么AsyncAnnotationBeanPostProcessor
這個(gè)advisor是什么時(shí)候被初始化的呢?我們直接定位到AsyncAnnotationBeanPostProcessor
的setBeanFactory
方法,其源碼如下:
public void setBeanFactory(BeanFactory beanFactory) {
super.setBeanFactory(beanFactory);
// 在這里new了一個(gè)AsyncAnnotationAdvisor
AsyncAnnotationAdvisor advisor = new AsyncAnnotationAdvisor(this.executor, this.exceptionHandler);
if (this.asyncAnnotationType != null) {
advisor.setAsyncAnnotationType(this.asyncAnnotationType);
}
advisor.setBeanFactory(beanFactory);
// 完成了初始化
this.advisor = advisor;
}
我們來看看AsyncAnnotationAdvisor
中的切點(diǎn)匹配規(guī)程是怎么樣的,直接定位到這個(gè)類的buildPointcut
方法中,其源碼如下:
protected Pointcut buildPointcut(Set> asyncAnnotationTypes) {
ComposablePointcut result = null;
for (Class extends Annotation> asyncAnnotationType : asyncAnnotationTypes) {
// 就是根據(jù)這兩個(gè)匹配器進(jìn)行匹配的
Pointcut cpc = new AnnotationMatchingPointcut(asyncAnnotationType, true);
Pointcut mpc = new AnnotationMatchingPointcut(null, asyncAnnotationType, true);
if (result == null) {
result = new ComposablePointcut(cpc);
}
else {
result.union(cpc);
}
result = result.union(mpc);
}
return (result != null ? result : Pointcut.TRUE);
}
代碼很簡(jiǎn)單,就是根據(jù)cpc跟mpc兩個(gè)匹配器來進(jìn)行匹配的,第一個(gè)是檢查類上是否有@Async注解,第二個(gè)是檢查方法是是否有@Async注解。
那么,到現(xiàn)在為止,我們已經(jīng)知道了它在何時(shí)創(chuàng)建代理,會(huì)為什么對(duì)象創(chuàng)建代理,最后我們還需要解決一個(gè)問題,代理的邏輯是怎么樣的,異步到底是如何實(shí)現(xiàn)的?
前面也提到了advisor是一個(gè)綁定了切點(diǎn)的通知,前面分析了它的切點(diǎn),那么現(xiàn)在我們就來看看它的通知邏輯,直接定位到AsyncAnnotationAdvisor
中的buildAdvice
方法,源碼如下:
protected Advice buildAdvice(
@Nullable Supplier executor, @Nullable Supplier exceptionHandler) {
AnnotationAsyncExecutionInterceptor interceptor = new AnnotationAsyncExecutionInterceptor(null);
interceptor.configure(executor, exceptionHandler);
return interceptor;
}
簡(jiǎn)單吧,加了一個(gè)攔截器而已,對(duì)于interceptor類型的對(duì)象,我們關(guān)注它的核心方法invoke
就行了,代碼如下:
public Object invoke(final MethodInvocation invocation) throws Throwable {
Class> targetClass = (invocation.getThis() != null ? AopUtils.getTargetClass(invocation.getThis()) : null);
Method specificMethod = ClassUtils.getMostSpecificMethod(invocation.getMethod(), targetClass);
final Method userDeclaredMethod = BridgeMethodResolver.findBridgedMethod(specificMethod);
// 異步執(zhí)行嘛,先獲取到一個(gè)線程池
AsyncTaskExecutor executor = determineAsyncExecutor(userDeclaredMethod);
if (executor == null) {
throw new IllegalStateException(
"No executor specified and no default executor set on AsyncExecutionInterceptor either");
}
// 然后將這個(gè)方法封裝成一個(gè) Callable對(duì)象傳入到線程池中執(zhí)行
Callable
就像在這張圖里這個(gè)讀者問的問題,
分為兩點(diǎn)回答:
第一:循環(huán)依賴為什么不能被解決?
這個(gè)問題其實(shí)很簡(jiǎn)單,在《面試必殺技,講一講Spring中的循環(huán)依賴》這篇文章中我從兩個(gè)方面分析了循環(huán)依賴的處理流程
按照這種思路,@Async
注解導(dǎo)致的循環(huán)依賴應(yīng)該屬于AOP對(duì)象間的循環(huán)依賴
,也應(yīng)該能被處理。但是,重點(diǎn)來了,解決AOP對(duì)象間循環(huán)依賴的核心方法是三級(jí)緩存,如下:
在三級(jí)緩存緩存了一個(gè)工廠對(duì)象,這個(gè)工廠對(duì)象會(huì)調(diào)用getEarlyBeanReference
方法來獲取一個(gè)早期的代理對(duì)象的引用,其源碼如下:
protected Object getEarlyBeanReference(String beanName, RootBeanDefinition mbd, Object bean) {
Object exposedObject = bean;
if (!mbd.isSynthetic() && hasInstantiationAwareBeanPostProcessors()) {
for (BeanPostProcessor bp : getBeanPostProcessors()) {
// 看到這個(gè)判斷了嗎,通過@EnableAsync導(dǎo)入的后置處理器
// AsyncAnnotationBeanPostProcessor根本就不是一個(gè)SmartInstantiationAwareBeanPostProcessor
// 這就意味著即使我們通過AsyncAnnotationBeanPostProcessor創(chuàng)建了一個(gè)代理對(duì)象
// 但是早期暴露出去的用于給別的Bean進(jìn)行注入的那個(gè)對(duì)象還是原始對(duì)象
if (bp instanceof SmartInstantiationAwareBeanPostProcessor) {
SmartInstantiationAwareBeanPostProcessor ibp = (SmartInstantiationAwareBeanPostProcessor) bp;
exposedObject = ibp.getEarlyBeanReference(exposedObject, beanName);
}
}
}
return exposedObject;
}
看完上面的代碼循環(huán)依賴的問題就很明顯了,因?yàn)樵缙诒┞兜膶?duì)象跟最終放入容器中的對(duì)象不是同一個(gè),所以報(bào)錯(cuò)了。報(bào)錯(cuò)的具體位置我在你知道Spring是怎么將AOP應(yīng)用到Bean的生命周期中的嗎? 文章末尾已經(jīng)分析過了,本文不再贅述
就以上面讀者給出的Demo為例,只需要在為B注入A時(shí)添加一個(gè)@Lazy
注解即可
@Component
public class B implements BService {
@Autowired
@Lazy
private A a;
public void doSomething() {
}
}
這個(gè)注解的作用在于,當(dāng)為B注入A時(shí),會(huì)為A生成一個(gè)代理對(duì)象注入到B中,當(dāng)真正調(diào)用代理對(duì)象的方法時(shí),底層會(huì)調(diào)用getBean(a)
去創(chuàng)建A對(duì)象,然后調(diào)用方法,這個(gè)注解的處理時(shí)機(jī)是在org.springframework.beans.factory.support.DefaultListableBeanFactory#resolveDependency
方法中,處理這個(gè)注解的代碼位于org.springframework.context.annotation.ContextAnnotationAutowireCandidateResolver#buildLazyResolutionProxy
,這些代碼其實(shí)都在我之前的文章中分析過了
《Spring雜談 | Spring中的AutowireCandidateResolver》
《談?wù)凷pring中的對(duì)象跟Bean,你知道Spring怎么創(chuàng)建對(duì)象的嗎?》
所以本文不再做詳細(xì)分析
我覺得這是這個(gè)注解最坑的地方,沒有之一!我們來看看它默認(rèn)使用的線程池是哪個(gè),在前文的源碼分析中,我們可以看到?jīng)Q定要使用線程池的方法是org.springframework.aop.interceptor.AsyncExecutionAspectSupport#determineAsyncExecutor
。其源碼如下:
protected AsyncTaskExecutor determineAsyncExecutor(Method method) {
AsyncTaskExecutor executor = this.executors.get(method);
if (executor == null) {
Executor targetExecutor;
// 可以在@Async注解中配置線程池的名字
String qualifier = getExecutorQualifier(method);
if (StringUtils.hasLength(qualifier)) {
targetExecutor = findQualifiedExecutor(this.beanFactory, qualifier);
}
else {
// 獲取默認(rèn)的線程池
targetExecutor = this.defaultExecutor.get();
}
if (targetExecutor == null) {
return null;
}
executor = (targetExecutor instanceof AsyncListenableTaskExecutor ?
(AsyncListenableTaskExecutor) targetExecutor : new TaskExecutorAdapter(targetExecutor));
this.executors.put(method, executor);
}
return executor;
}
最終會(huì)調(diào)用到org.springframework.aop.interceptor.AsyncExecutionInterceptor#getDefaultExecutor
這個(gè)方法中
protected Executor getDefaultExecutor(@Nullable BeanFactory beanFactory) {
Executor defaultExecutor = super.getDefaultExecutor(beanFactory);
return (defaultExecutor != null ? defaultExecutor : new SimpleAsyncTaskExecutor());
}
可以看到,它默認(rèn)使用的線程池是SimpleAsyncTaskExecutor
。我們不看這個(gè)類的源碼,只看它上面的文檔注釋,如下:
主要說了三點(diǎn)
就這三點(diǎn),你還敢用嗎?只要你的任務(wù)耗時(shí)長(zhǎng)一點(diǎn),說不定服務(wù)器就給你來個(gè)OOM
。
最好的辦法就是使用自定義的線程池,主要有這么幾種配置方法
AsyncConfigurer
來配置使用的線程池如下:
public class DmzAsyncConfigurer implements AsyncConfigurer {
@Override
public Executor getAsyncExecutor() {
// 創(chuàng)建自定義的線程池
}
}
如下:
public class A implements AService {
private B b;
@Autowired
public void setB(B b) {
System.out.println(b);
this.b = b;
}
@Async("dmzExecutor")
public void doSomething() {
}
}
@EnableAsync
@Configuration
@ComponentScan("com.dmz.spring.async")
@Aspect
public class Config {
@Bean("dmzExecutor")
public Executor executor(){
// 創(chuàng)建自定義的線程池
return executor;
}
}
上述內(nèi)容就是Spring中如何使用@Async異步注解,你們學(xué)到知識(shí)或技能了嗎?如果還想學(xué)到更多技能或者豐富自己的知識(shí)儲(chǔ)備,歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。