复盘SpringBoot的@Ascyn注解失效问题

复盘SpringBoot的@Ascyn注解失效问题

在实际使用项目中，我们经常会遇到异步与同步任务的线程问题。在我的实际应用项目中也存在一些异步任务，如定时发布消息通知、定期清理任务、异步下载信息同步等，异步应用场景应用相当广泛，而在Spring框架中就为我们搭建了一个快速构建异步任务的方法，本文中将分享我笔记中的错误分析及解决方案。

一、案例分析

在使用@Ascyn注解制作一个异步消息发送时遇到注解失效问题，明明已经为方法加入了注解，为什么无法异步执行，经过检查该异步任务的确处于主线程中执行。

首先一定需要新建配置类AsyncConfig。并开启@EnableAsync写上@Configuration注解。

@EnableAsync@ConfigurationpublicclassAsyncConfig{// to-do...}

简单重现异步失效的代码：

@ServicepublicclassMyAsyncTask{publicvoidstartAsyncTask(){this.asyncTask();}@AsyncpublicvoidasyncTask(){System.out.println("异步任务开始，线程名："+Thread.currentThread().getName());}publicstaticvoidmain(String[]args){// 直接实例化对象，并且自调用。newMyAsyncTask().startAsyncTask();}}

二、原因分析

经过查阅相关资料后，发现Spring是通过AOP代理的机制来完成异步任务的，如果是从类中的方法调用异步方法，会自动绕过代理机制直接执行该方法，因此注解才会失效。现在我们把代码稍微调整一下：

@ServicepublicclassMyAsyncTask{// 仅外部调用@AsyncpublicvoidasyncTask(){System.out.println("异步任务开始，线程名："+Thread.currentThread().getName());}}

在类的外部进行调用，如单元测试中使用代理注入，直接调用该异步代码：

@AutowiredMyAsyncTaskmyAsyncTask;@TestvoidcontextLoads(){nmyAsyncTask.asyncTask();}

如果我们一定要在同一类中调用方法，可以将该方法使用context上下文包装为一个代理类，然后同过代理类的方式进行方法的调用：

@AutowiredprivateApplicationContextcontext;// 调用此方法是完全OK的publicvoidcaller(){context.getBean(MyAsyncTask.class).asyncMethod();}

三、常见错误情况

1. 未使用代理方式新建实例

如果使用传统的new MyAsyncTask()方式调用是无法使用的，一定要经过代理，使用@Component、@Service或@Bean注解的方式调用，才能正常被代理异步。

// 错误示范@TestvoidcontextLoads(){newMyAsyncTask().asyncTask();}

2. 异步方法有返回值

如果异步方法有返回值，那必须是Future、CompletableFuture等类型进行包装返回。

@AsyncpublicCompletableFuture<String>asyncTask(){returnCompletableFuture.completedFuture("result");}

3.@Async 方法抛异常后未被感知

异步方法抛异常但未返回Future或CompletableFuture时，异常不会传播。

// 正确方式@AsyncpublicCompletableFuture<String>asyncMethod(){try{// ...returnCompletableFuture.completedFuture("OK");}catch(Exceptione){returnCompletableFuture.failedFuture(e);}}

四、总结

使用Spring框架虽然方便，但是我们也要用正确的方式使用工具，否则会为我们的工程带来很多复杂的问题，学会如何正确使用@Ascyn注解，推荐阅读这篇文章：Java 注解篇：@Async，更多的情况案例我这里就不罗列了，可以在日常的代码编写中发现问题并寻求解决方案，最后解决我问题的文章也可以分享给大家，非常感谢这篇文章的解答：@Async 注解为什么不生效？如何排查？