Spring5 AOP 默认使用 Cglib 了?我第一次听到这个说法是在一个微信群里:
![群聊天](https://i-blog.csdnimg.cn/blog_migrate/99d4122cc08b56184a884b5db2fd48bf.png)
真的假的?查阅文档
刚看到这个说法的时候,我是保持怀疑态度的。
大家都知道 Spring5 之前的版本 AOP 在默认情况下是使用 JDK 动态代理的,那是不是 Spring5 版本真的做了修改呢?于是我打开 Spring Framework 5.x 文档,再次确认了一下:
文档地址:https://docs.spring.io/spring/docs/5.2.0.RELEASE/spring-framework-reference/core.html#aop
![Spring Framework 5.x 文档](https://i-blog.csdnimg.cn/blog_migrate/97969a11ee705899a6ab543ad0990f4e.png)
简单翻译一下。Spring AOP 默认使用 JDK 动态代理,如果对象没有实现接口,则使用 CGLIB 代理。当然,也可以强制使用 CGLIB 代理。
什么?文档写错了?!
当我把官方文档发到群里之后,又收到了这位同学的回复:
![文档写错了?!](https://i-blog.csdnimg.cn/blog_migrate/776b9d9b62cd281560907014eb2666ee.png)
SpringBoot 2.x 代码示例
为了证明文档写错了,这位同学还写了一个 DEMO。下面,就由我来重现一下这个 DEMO 程序:
运行环境:SpringBoot 2.2.0.RELEASE 版本,内置 Spring Framework 版本为 5.2.0.RELEASE 版本。同时添加 spring-boot-starter-aop 依赖,自动装配 Spring AOP。
public interface UserService {
void work();
}
@Service
public class UserServiceImpl implements UserService {
<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">work</span><span class="hljs-params">()</span> </span>{
System.out.println(<span class="hljs-string">"开始干活...coding..."</span>);
}
}
@Component
@Aspect
public class UserServiceAspect {
@Before("execution(* com.me.aop.UserService.work(..))")
public void logBefore(JoinPoint joinPoint) {
System.out.println("UserServiceAspect.....()");
}
}
![默认使用Cglib代理了?](https://i-blog.csdnimg.cn/blog_migrate/25a230819d2460226270b4ed18bb7009.png)
UserServiceImpl
实现了UserService
接口,同时使用UserServiceAspect
对UserService#work
方法进行前置增强拦截。
从运行结果来看,这里的确使用了 CGLIB 代理而不是 JDK 动态代理。
难道真的是文档写错了?!
@EnableAspectJAutoProxy 源码注释
在 Spring Framework 中,是使用@EnableAspectJAutoProxy
注解来开启 Spring AOP 相关功能的。
Spring Framework 5.2.0.RELEASE 版本@EnableAspectJAutoProxy
注解源码如下:
![@EnableAspectJAutoProxy源码](https://i-blog.csdnimg.cn/blog_migrate/813c71599d0da7ae05547599eb442931.png)
通过源码注释我们可以了解到:在 Spring Framework 5.2.0.RELEASE 版本中,proxyTargetClass
的默认取值依旧是false
,默认还是使用 JDK 动态代理。
难道文档和源码注释都写错了?!
@EnableAspectJAutoProxy 的 proxyTargetClass 无效了?
接下来,我尝试使用@EnableAspectJAutoProxy
来强制使用 JDK 动态代理。
运行环境:SpringBoot 2.2.0.RELEASE 版本,内置 Spring Framework 版本为 5.2.0.RELEASE 版本。
![proxyTargetClass设置无效了?](https://i-blog.csdnimg.cn/blog_migrate/8ad05a81b33ca19d16885fc64bc19787.png)
通过运行发现,还是使用了 CGLIB 代理。难道@EnableAspectJAutoProxy
的 proxyTargetClass
设置无效了?
Spring Framework 5.x
整理一下思路
- 有人说 Spring5 开始 AOP 默认使用 CGLIB 了
- Spring Framework 5.x 文档和
@EnableAspectJAutoProxy
源码注释都说了默认是使用 JDK 动态代理 - 程序运行结果说明,即使继承了接口,设置
proxyTargetClass
为false
,程序依旧使用 CGLIB 代理
等一下,我们是不是遗漏了什么?
示例程序是使用 SpringBoot 来运行的,那如果不用 SpringBoot,只用 Spring Framework 会怎么样呢?
运行环境:Spring Framework 5.2.0.RELEASE 版本。
UserServiceImpl 和 UserServiceAspect 类和上文一样,这里不在赘述。
![Spring Framework 5.x](https://i-blog.csdnimg.cn/blog_migrate/b91029d24d5f75c222f7b8cfa2f9ebfe.png)
![Spring Framework 5.x使用CGLIB](https://i-blog.csdnimg.cn/blog_migrate/be94a6a8e1743081cdcfbd4b8c072755.png)
运行结果表明: 在 Spring Framework 5.x 版本中,如果类实现了接口,AOP 默认还是使用 JDK 动态代理。
再整理思路
- Spring5 AOP 默认依旧使用 JDK 动态代理,官方文档和源码注释没有错。
- SpringBoot 2.x 版本中,AOP 默认使用 cglib,且无法通过
proxyTargetClass
进行修改。 - 那是不是 SpringBoot 2.x 版本做了一些改动呢?
再探 SpringBoot 2.x
结果上面的分析,很有可能是 SpringBoot2.x 版本中,修改了 Spring AOP 的相关配置。那就来一波源码分析,看一下内部到底做了什么。
源码分析
源码分析,找对入口很重要。那这次的入口在哪里呢?
@SpringBootApplication
是一个组合注解,该注解中使用@EnableAutoConfiguration
实现了大量的自动装配。
EnableAutoConfiguration
也是一个组合注解,在该注解上被标志了@Import
。关于@Import
注解的详细用法,可以参看笔者之前的文章:https://mp.weixin.qq.com/s/7arh4sVH1mlHE0GVVbZ84Q
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
AutoConfigurationImportSelector
实现了DeferredImportSelector
接口。
在 Spring Framework 4.x 版本中,这是一个空接口,它仅仅是继承了ImportSelector
接口而已。而在 5.x 版本中拓展了DeferredImportSelector
接口,增加了一个getImportGroup
方法:
![AutoConfigurationImportSelector#getImportGroup](https://i-blog.csdnimg.cn/blog_migrate/4f253e62ab0d12df6df2a11a920c6055.png)
在这个方法中返回了AutoConfigurationGroup
类。这是AutoConfigurationImportSelector
中的一个内部类,他实现了DeferredImportSelector.Group
接口。
在 SpringBoot 2.x 版本中,就是通过AutoConfigurationImportSelector.AutoConfigurationGroup#process
方法来导入自动配置类的。
![导入配置类](https://i-blog.csdnimg.cn/blog_migrate/abcdd780f25325336a763cc151c91de6.png)
通过断点调试可以看到,和 AOP 相关的自动配置是通过org.springframework.boot.autoconfigure.aop.AopAutoConfiguration
来进行配置的。
![AopAutoConfiguration源码](https://i-blog.csdnimg.cn/blog_migrate/ad69ab322e49cdb9b9a2d9934ced6516.png)
真相大白
看到这里,可以说是真相大白了。在 SpringBoot2.x 版本中,通过AopAutoConfiguration
来自动装配 AOP。
默认情况下,是肯定没有spring.aop.proxy-target-class
这个配置项的。而此时,在 SpringBoot 2.x 版本中会默认使用 Cglib 来实现。
SpringBoot 2.x 中如何修改 AOP 实现
通过源码我们也就可以知道,在 SpringBoot 2.x 中如果需要修改 AOP 的实现,需要通过spring.aop.proxy-target-class
这个配置项来修改。
#在application.properties文件中通过spring.aop.proxy-target-class来配置
spring.aop.proxy-target-class=false
![spring-configuration-metadata.json](https://i-blog.csdnimg.cn/blog_migrate/1bdea7bd2eb31282e535be417e193183.png)
这里也提一下spring-configuration-metadata.json
文件的作用:在使用application.properties
或application.yml
文件时,IDEA 就是通过读取这些文件信息来提供代码提示的,SpringBoot 框架自己是不会来读取这个配置文件的。
SringBoot 1.5.x 又是怎么样的
![SringBoot 1.5.x](https://i-blog.csdnimg.cn/blog_migrate/fa514859feb3a474c5340e78fb2d5c14.png)
可以看到,在 SpringBoot 1.5.x 版本中,默认还是使用 JDK 动态代理的。
SpringBoot 2.x 为何默认使用 Cglib
SpringBoot 2.x 版本为什么要默认使用 Cglib 来实现 AOP 呢?这么做的好处又是什么呢?笔者从网上找到了一些资料,先来看一个 issue。
Spring Boot issue #5423
Use @EnableTransactionManagement(proxyTargetClass = true) #5423
https://github.com/spring-projects/spring-boot/issues/5423
在这个 issue 中,抛出了这样一个问题:
![issue](https://i-blog.csdnimg.cn/blog_migrate/21e8ca725a74116f24e98d07bb732b14.png)
翻译一下:我们应该使用@EnableTransactionManagement(proxyTargetClass = true)来防止人们不使用接口时出现讨厌的代理问题。
这个"不使用接口时出现讨厌的代理问题"是什么呢?思考一分钟。
讨厌的代理问题
假设,我们有一个UserServiceImpl
和UserService
类,此时需要在UserContoller
中使用UserService
。在 Spring 中通常都习惯这样写代码:
@Autowired
UserService userService;
在这种情况下,无论是使用 JDK 动态代理,还是 CGLIB 都不会出现问题。
但是,如果你的代码是这样的呢:
@Autowired
UserServiceImpl userService;
这个时候,如果我们是使用 JDK 动态代理,那在启动时就会报错:
![启动报错](https://i-blog.csdnimg.cn/blog_migrate/14130c61faf8dd37ee82428b726dc752.png)
因为 JDK 动态代理是基于接口的,代理生成的对象只能赋值给接口变量。
而 CGLIB 就不存在这个问题。因为 CGLIB 是通过生成子类来实现的,代理对象无论是赋值给接口还是实现类这两者都是代理对象的父类。
SpringBoot 正是出于这种考虑,于是在 2.x 版本中,将 AOP 默认实现改为了 CGLIB。
更多的细节信息,读者可以自己查阅上述 issue。
总结
- Spring 5.x 中 AOP 默认依旧使用 JDK 动态代理。
- SpringBoot 2.x 开始,为了解决使用 JDK 动态代理可能导致的类型转化异常而默认使用 CGLIB。
- 在 SpringBoot 2.x 中,如果需要默认使用 JDK 动态代理可以通过配置项
spring.aop.proxy-target-class=false
来进行修改,proxyTargetClass
配置已无效。
延伸阅读
issue:Default CGLib proxy setting default cannot be overridden by using core framework annotations (@EnableTransactionManagement, @EnableAspectJAutoProxy) #12194
https://github.com/spring-projects/spring-boot/issues/12194
这个 issue 也聊到了关于proxyTargetClass
设置失效的问题,讨论内容包括:@EnableAspectJAutoProxy
、@EnableCaching
和 @EnableTransactionManagement
。感兴趣的读者可以自行查阅该 issue内容。
欢迎关注个人公众号,一起学习成长:
![Coder小黑](https://i-blog.csdnimg.cn/blog_migrate/84a1dc78adf04fce64631c25ed73aad9.png)