Spring Boot AOP系列之AOP原理介绍

Spring Boot AOP系列之AOP原理介绍


序言:在本文中,jdk动态代理和cglib代理的核心原理,我都会一一讲到,看本文的时候可以结合着上文看,了解创建的过程,创建的生命周期,才能知晓原理

一、JDK动态代理原理

1、前言

其实大家看了上文的demo肯定会有所疑惑,为什么实现了一个InvocationHandler接口就可以实现切面的植入了,就可以在写好的函数方法上面,植入我们的代码呢?是不是很神奇,惊不惊喜,意不意外。OK,废话不多说,下面跟着我的思路,走一遍源代码。

2、介绍

上文中提到了,Spring jdk动态代理最核心的一句话莫过于下面这句话

1
2
3
4
HelloWorld helloWorld=(HelloWorld)Proxy.
newProxyInstance(JDKProxyTest.class.getClassLoader(),
new Class<?>[]{HelloWorld.class},
new MyInvocationHandler(new HelloworldImpl()));

走进newProxyInstance这个方法

1
2
3
4
5
6
7
8
9
10
final Class<?>[] intfs = interfaces.clone();
final SecurityManager sm = System.getSecurityManager();
if (sm != null) {
checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
}
/*
* 从缓存中取出或者生成代理
*/
Class<?> cl = getProxyClass0(loader, intfs);

getProxyClass0核心方法片段如下:

1
2
3
4
5
6
7
8
9
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
// 如果已经创建了就从缓存里面拿,如果没有创建就通过ProxyClassFactory创建一个
return proxyClassCache.get(loader, interfaces);
}

proxyClassCache是这样的

1
2
private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());

ProxyClassFactoryProxy的一个静态内部类,实现了WeakCache的内部接口BiFunctionapply方法,代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
private static final class ProxyClassFactory
implements BiFunction<ClassLoader, Class<?>[], Class<?>> {
// 所有代理类名字的前缀
private static final String proxyClassNamePrefix = "$Proxy";
// 用于生成代理类名字的计数器
private static final AtomicLong nextUniqueNumber = new AtomicLong();
@Override
public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {
// 省略验证代理接口的代码……
String proxyPkg = null; // 生成的代理类的包名
// 对于非公共接口,代理类的包名与接口的相同
for (Class<?> intf : interfaces) {
int flags = intf.getModifiers();
if (!Modifier.isPublic(flags)) {
String name = intf.getName();
int n = name.lastIndexOf('.');
String pkg = ((n == -1) ? "" : name.substring(0, n + 1));
if (proxyPkg == null) {
proxyPkg = pkg;
} else if (!pkg.equals(proxyPkg)) {
throw new IllegalArgumentException(
"non-public interfaces from different packages");
}
}
}
// 对于公共接口的包名,默认为com.sun.proxy
if (proxyPkg == null) {
proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
}
// 获取计数
long num = nextUniqueNumber.getAndIncrement();
// 默认情况下,代理类的完全限定名为:com.sun.proxy.$Proxy0,com.sun.proxy.$Proxy1……依次递增
String proxyName = proxyPkg + proxyClassNamePrefix + num;
// 这里才是真正的生成代理类的字节码的地方
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces);
try {
// 根据二进制字节码返回相应的Class实例
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
} catch (ClassFormatError e) {
throw new IllegalArgumentException(e.toString());
}
}
}

我们注意一下这行代码:

1
2
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);

进去:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
final byte[] var4 = var3.generateClassFile();
//saveGeneratedFiles 这个参数是经我们配置的,默认是false,目的是是否保存在磁盘里面
if (saveGeneratedFiles) {
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
try {
int var1 = var0.lastIndexOf(46);
Path var2;
if (var1 > 0) {
Path var3 = Paths.get(var0.substring(0, var1).replace('.', File.separatorChar));
Files.createDirectories(var3);
var2 = var3.resolve(var0.substring(var1 + 1, var0.length()) + ".class");
} else {
var2 = Paths.get(var0 + ".class");
}
Files.write(var2, var4, new OpenOption[0]);
return null;
} catch (IOException var4x) {
throw new InternalError("I/O exception saving generated file: " + var4x);
}
}
});
}
return var4;
}
1
private static final boolean saveGeneratedFiles = ((Boolean)AccessController.doPrivileged(new GetBooleanAction("sun.misc.ProxyGenerator.saveGeneratedFiles"))).booleanValue();

在启动项目的时候,虚拟机设置一下这个参数sun.misc.ProxyGenerator.saveGeneratedFiles为true,就可以打印出代理对象的字节码文件。

PS:其实我们还有很多方法获取字节码文件,后文中介绍

OK,我们看下我们生成的字节码文件长什么样子:

jdk代理class文件

我们可以清楚的看到生成的代理文件,实现了我们的自己需要的代理的接口QueryUserInfoBiz ,实现了SpringProxy接口 ,继承了Proxy类等。再来看看我们普通的一个方法,是如何被代理的。

insertUserInfoV5这个方法被代理之后,被植入了一段代码,super.h.invoke方法 , super表示Proxy这个夫类,h表示Proxy里面的一个属性,是InvocationHandler类型的,回忆一下,我们在手动创建jdk动态代理的时候,是不是需要指定一个InvocationHandler,这里就是起这个作用的,比如说在上个例子中,是我们自己写的MyInvocationHandler类,但是在Spring中,我们没有指定这个handler,那到底调用的是谁呢?

接上回:

在我们最开始用缓存创建那一段的时候,后面还有这样一段代码。这段代码的作用是让handler作为参数调用构造方法来获得代理类的实例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
try {
if (sm != null) {
checkNewProxyPermission(Reflection.getCallerClass(), cl);
}
final Constructor<?> cons = cl.getConstructor(constructorParams);
final InvocationHandler ih = h;
if (!Modifier.isPublic(cl.getModifiers())) {
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
cons.setAccessible(true);
return null;
}
});
}
return cons.newInstance(new Object[]{h});

实际上,调用者是,一般而言,谁去准备创建proxy,谁一般就是这个handler,比如我们这里讲的aop里面,创建者就是JdkDynamicAopProxy这个类,这个类他实现了InvocationHandler接口,所以他被作为参数传进去了,自然而言,当代理类里面的方法被调用的时候,他的invoke方法就会被唤醒。

二、CGLib原理介绍

我们再来看看Cglib代理

先来看看Cglib手动创建的一个简单代码:

1
2
3
4
Enhancer enhancer = new Enhancer();
enhancer.setSuperclass(RealSubject.class);//继承被代理的那个类
enhancer.setCallback(new DynamicSubjectHandler())//设置回调类
RealSubject realSubject = (RealSubject)enhancer.create();//创建代理对象

核心方法自然是create方法,走进去看一下

1
2
3
4
5
public Object create() {
this.classOnly = false;
this.argumentTypes = null;
return this.createHelper();
}

createHelper方法

1
2
3
4
5
6
7
8
9
10
private Object createHelper() {
this.validate();
if (this.superclass != null) {
this.setNamePrefix(this.superclass.getName());
} else if (this.interfaces != null) {
this.setNamePrefix(this.interfaces[ReflectUtils.findPackageProtected(this.interfaces)].getName());
}
return super.create(KEY_FACTORY.newInstance(this.superclass != null ? this.superclass.getName() : null, ReflectUtils.getNames(this.interfaces), this.filter, this.callbackTypes, this.useFactory, this.interceptDuringConstruction, this.serialVersionUID));
}

调用了super.create方法,核心代码如下:

1
2
3
4
5
6
7
8
9
10
11
//如果还没有生成,就走生成逻辑
if (gen == null) {
byte[] b = this.strategy.generate(this);
String className = ClassNameReader.getClassName(new ClassReader(b));
this.getClassNameCache(loader).add(className);
gen = ReflectUtils.defineClass(className, b, loader);
}
//生成的代理类放在缓存里面
if (this.useCache) {
((Map)cache2).put(key, new WeakReference(gen));
}

然后看generate方法

1
2
3
4
5
public byte[] generate(ClassGenerator cg) throws Exception {
DebuggingClassWriter cw = this.getClassVisitor();
this.transform(cg).generateClass(cw);
return this.transform(cw.toByteArray());
}

再看generateClass方法,这个就是生成代理文件的最核心逻辑了,先看Enhancer里面的generateClass 方法,

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
ClassEmitter e = new ClassEmitter(v);
e.begin_class(46, 1, this.getClassName(), Type.getType(sc), this.useFactory ? TypeUtils.add(TypeUtils.getTypes(this.interfaces), FACTORY) : TypeUtils.getTypes(this.interfaces), "<generated>");
List constructorInfo = CollectionUtils.transform(constructors, MethodInfoTransformer.getInstance());
e.declare_field(2, "CGLIB$BOUND", Type.BOOLEAN_TYPE, (Object)null);
if (!this.interceptDuringConstruction) {
e.declare_field(2, "CGLIB$CONSTRUCTED", Type.BOOLEAN_TYPE, (Object)null);
}
e.declare_field(26, "CGLIB$THREAD_CALLBACKS", THREAD_LOCAL, (Object)null);
e.declare_field(26, "CGLIB$STATIC_CALLBACKS", CALLBACK_ARRAY, (Object)null);
if (this.serialVersionUID != null) {
e.declare_field(26, "serialVersionUID", Type.LONG_TYPE, this.serialVersionUID);
}
for(int i = 0; i < this.callbackTypes.length; ++i) {
e.declare_field(2, getCallbackField(i), this.callbackTypes[i], (Object)null);
}
this.emitMethods(e, methods, actualMethods);
this.emitConstructors(e, constructorInfo);
this.emitSetThreadCallbacks(e);
this.emitSetStaticCallbacks(e);
this.emitBindCallbacks(e);
if (this.useFactory) {
int[] keys = this.getCallbackKeys();
this.emitNewInstanceCallbacks(e);
this.emitNewInstanceCallback(e);
this.emitNewInstanceMultiarg(e, constructorInfo);
this.emitGetCallback(e, keys);
this.emitSetCallback(e, keys);
this.emitGetCallbacks(e);
this.emitSetCallbacks(e);
}

这段就是生成字节码的核心逻辑,这段里面有很复杂的调用逻辑,我们这里不作详细介绍。

我们也有办法拿到CGLIB生成的代理文件,我这里不赘述,后面开一篇博客讲,这里面也挺麻烦的,当初我也找了很久。

OK,我们来看一下某一份生成好的代理字节码文件

CGlib生成的字节码文件

这个代理类继承了我们被代理的类或者接口,然后实现了SpringProxyAdvised接口等, 首先当我们调用addOneCityV8方法的时候,代理类会先去看CGLIB$CALLBACK_0 这个属性为不为空,这个是一个MethodIntercepter类型的 ,如果为空就调用一个绑定方法,CGLIB$BIND_CALLBACKS ,它负责从一个叫做CGLIB$THREAD_CALLBACKS 的ThreadLocal对象中拿或者叫做CGLIB$STATIC_CALLBACKSCallback数组中拿。拿到了之后就执行intercept方法。

那么这里有个问题,回调类到底是如何选择的呢?

这里的处理逻辑和JDK动态代理类似,回调类基于一种,谁创建,谁负责的逻辑,已AOP创建动态代理为例,CglibAopProxy这个类在创建代理的时候,会调用一个 getCallbacks方法,在CglibAopProxy 中可以搜索到,代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
boolean exposeProxy = this.advised.isExposeProxy();
boolean isFrozen = this.advised.isFrozen();
boolean isStatic = this.advised.getTargetSource().isStatic();
// Choose an "aop" interceptor (used for AOP calls).
Callback aopInterceptor = new DynamicAdvisedInterceptor(this.advised);
// Choose a "straight to target" interceptor. (used for calls that are
// unadvised but can return this). May be required to expose the proxy.
Callback targetInterceptor;
if (exposeProxy) {
targetInterceptor = isStatic ?
new StaticUnadvisedExposedInterceptor(this.advised.getTargetSource().getTarget()) :
new DynamicUnadvisedExposedInterceptor(this.advised.getTargetSource());
}
else {
targetInterceptor = isStatic ?
new StaticUnadvisedInterceptor(this.advised.getTargetSource().getTarget()) :
new DynamicUnadvisedInterceptor(this.advised.getTargetSource());
}
// Choose a "direct to target" dispatcher (used for
// unadvised calls to static targets that cannot return this).
Callback targetDispatcher = isStatic ?
new StaticDispatcher(this.advised.getTargetSource().getTarget()) : new SerializableNoOp();
Callback[] mainCallbacks = new Callback[] {
aopInterceptor, // for normal advice
targetInterceptor, // invoke target without considering advice, if optimized
new SerializableNoOp(), // no override for methods mapped to this
targetDispatcher, this.advisedDispatcher,
new EqualsInterceptor(this.advised),
new HashCodeInterceptor(this.advised)
};

根据摘取的部分片段可以得知,他是跟配置相关的,如果你没有作任何配置,那么系统一般首选DynamicAdvisedInterceptor 这个拦截器。也就是回调类就是DynamicAdvisedInterceptor ,会调用他里面的intercept方法。

完毕。

Compartir