前言
最近有粉丝问了我一个问题:他在项目某个方法使用@async
注解,但是该方法还是同步
执行了,异步
不起作用,到底是什么原因呢?
伪代码如下:
@slf4j @service public class userservice { @async public void async(string value) { log.info("async:" value); } }
这个问题还是比较有意思的,今天这篇文章总结了@async注解失效的9种场景,希望对你会有所帮助。
1 未使用@enableasync注解
在spring中要开启@async注解异步的功能,需要在项目的启动类,或者配置类上,使用@enableasync
注解。
例如:
@enableasync @springbootapplication(exclude = {datasourceautoconfiguration.class}) public class application { public static void main(string[] args) { springapplication.run(application.class, args); } }
@enableasync
注解相当于一个开关
,控制是否开启@async
注解异步的功能,默认是关闭的。
如果在项目的启动类上没使用@enableasync注解,则@async注解异步的功能不生效。
2 内部方法调用
我们在日常开发中,经常需要在一个方法中调用另外一个方法,例如:
@slf4j @service public class userservice { public void test() { async("test"); } @async public void async(string value) { log.info("async:{}", value); } }
这个示例中,在userservice类中的test()方法中调用了async()方法。
如果在controller中@autowired了userservice类的对象,调用了它的test()方法,则async()异步的功能会失效。
我们知道spring通过@async注解实现异步的功能,底层其实是通过spring的aop
实现的,也就是说它需要通过jdk动态代理
或者cglib
,生成代理对象
。
异步的功能,是在代理对象中增加的,我们必须调用代理对象的test()方法才行。
而在类中直接进行方法的内部调用,在test()方法中调用async()方法,调用的是该类原对象的async方法,相当于调用了this.async()方法,而并非userservice代理类的async()方法。
因此,像这种内部方法调用,@async注解的异步功能会失效。
3 方法非public
在java中有4种权限修饰符
public
:所有类都可以访问。private
:只能同一个类访问。protected
:同一个类,同一个包下的其他类,不同包下的子类可以访问。默认修饰符
:同一个类,同一个包下的其他类可以访问。
在实际工作中,我们使用频率最高的可能是public和private了。
如果我在定义service类中的某个方法时,有时把权限修饰符定义错了,例如:
@slf4j @service public class userservice { @async private void async(string value) { log.info("async:{}", value); } }
这个例子中将userservice类的async()方法的权限修饰符定义成了private的,这样@async注解也会失效。
因为private修饰的方法,只能在userservice类的对象中使用。
而@async注解的异步功能,需要使用spring的aop生成userservice类的代理对象,该代理对象没法访问userservice类的private方法,因此会出现@async注解失效的问题。
4 方法返回值错误
我们在写一个新的方法时,经常需要定义方法的返回值。
返回值可以是void、int、string、user等等,但如果返回值定义错误,也可能会导致@async注解的异步功能失效。
例如:
@service public class userservice { @async public string async(string value) { log.info("async:{}", value); return value; } }
userservice类的async方法的返回值是string,这种情况竟然会导致@async注解的异步功能失效。
在asyncexecutioninterceptor类的invoke()方法,会调用它的父类asyncexecutionaspectsupport中的dosubmit方法,该方法时异步功能的核心代码,如下:
从图中看出,@async注解的异步方法的返回值,要么是future,要么是null。
因此,在实际项目中,如果想要使用@async注解的异步功能,相关方法的返回值必须是void
或者future
。
5 方法用static修饰了
有时候,我们的方法会使用static修饰,这样在调用的地方,可以直接使用类名.方法名,访问该方法了。
但如果在@async方法上加了static修饰符,例如:
@slf4j @service public class userservice { @async public static void async(string value) { log.info("async:{}", value); } }
这时@async的异步功能会失效,因为这种情况idea会直接报错:methods annotated with '@async' must be overridable 。
使用@async注解声明的方法,必须是能被重写的,很显然static修饰的方法,是类的静态方法,是不允许被重写的。
因此这种情况下,@async注解的异步功能会失效。
6 方法用final修饰
在java种final关键字,是一个非常特别的存在。
用final修饰的类,没法被继承。
用final修饰的方法,没法被重写。
用final修饰的变量,没法被修改。
如果final使用不当,也会导致@async注解的异步功能失效,例如:
@slf4j @service public class userservice { public void test() { async("test"); } @async public final void async(string value) { log.info("async:{}", value); } }
这种情况下idea也会直接报错:methods annotated with '@async' must be overridable 。
因为使用final关键字修饰的方法,是没法被子类重写的。
因此这种情况下,@async注解的异步功能会失效。
7 业务类没加@service注解
有时候,我们在新加service类时,会忘了加@service
注解,例如:
@slf4j //@service public class userservice { @async public void async(string value) { log.info("async:{}", value); } } @service public class testservice { @autowired private userservice userservice; public void test() { userservice.async("test"); } }
这种情况下,@async注解异步的功能也不会生效。因为userservice类没有使用@service、@component或者@controller等注解声明,该类不会被spring管理,因此也就无法使用spring的异步功能。
8 自己new的对象
在项目中,我们经常需要new一个对象,然后对他赋值,或者调用它的方法。
但如果new了一个service类的对象,可能会出现一些意想不到的问题,例如:
@slf4j @service public class userservice { @async public void async(string value) { log.info("async:{}", value); } } @service public class testservice { public void test() { userservice userservice = new userservice(); userservice.async("test"); } }
在testservice类的test()方法中,new了一个userservice类的对象,然后调用该对象的async()方法。
很显然这种情况下,async()方法只能同步执行,没法异步执行。
因为在项目中,我们自己new的对象,不会被spring管理,因此也就无法使用spring的异步功能。
不过我们可以通过beanpostprocessor
类,将创建的对象手动注入到spring容器中。
9 spring无法扫描异步类
我们在spring项目中可以使用@componentscan
注解指定项目中扫描的包路径,例如:
@componentscan({"com.susan.demo.service1"}) @springbootapplication(exclude = {datasourceautoconfiguration.class}) public class application { public static void main(string[] args) { springapplication.run(application.class, args); } }
项目中com.susan.demo.service1这个路径是不存在的,会导致@async注解异步的功能失效。
同时如果@componentscan注解定义的路径,没有包含你新加的servcie类的路径,@async注解异步的功能也会失效。
以上就是java中@async异步失效的9种场景的详细内容,更多关于java @async异步失效的资料请关注其它相关文章!