看过关于不少关于动态代理的博客,但是大多数的博客都是那种教你怎么使用而已,对于我个人来说,始终是不能够理解其具体实现如何?其方法参数的作用是如何?相信你通过本篇博客一定可以有更加深入的理解,而不是仅仅局限于使用。
在深入理解原理之前,我们需要先了解一下动态代理应该怎么使用。示例代码如下所示:
public interface Subject {
public void doSomething();
}
// RealSubject 为目标类
public class RealSubject implements Subject {
@Override
public void doSomething() {
System.out.println("doSomething ...");
}
}
// DynamicSubject 代理类,我们需要通过代理类增强目标类的方法,如事务、日志
public class DynamicSubject implements InvocationHandler {
// 要代理的真实对象(即目标类)
private Object sub;
public DynamicSubject(Object obj){
this.sub = obj;
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
System.out.println("代理类开始代理");
System.out.println("代理的方法为:" + method);
// 对于真正方法的调用
method.invoke(this.sub,args);
System.out.println("代理类结束代理");
return null;
}
}
public class Client {
public static void main(String[] args) {
// 要代理的真实对象
Subject realSubject = new RealSubject();
InvocationHandler ds = new DynamicSubject(realSubject);
Class<?> cls = realSubject.getClass();
// 生成的代理对象
Subject subject = (Subject) Proxy.newProxyInstance(cls.getClassLoader(),cls.getInterfaces(),ds);
subject.doSomething();
System.out.println(subject.getClass());
}
代理类开始代理
代理的方法为:public abstract void com.wangzhao.jvm.bytecode.proxy.Subject.doSomething()
doSomething ...
代理类结束代理
class com.sun.proxy.$Proxy0
以上便是我们对动态代理进行的示例以及其输出,可以看到subject对象并不是我们创建的类,而且其和目标类和代理类并没有直接关系。首先我们先分析一下我在学习动态代理的过程中的一些疑惑?
- 代理类为什么要实现 InvocationHandler 接口?
- subject对象生成时,为什么要传入那些参数?
- subject对象调用doSomething()方法时,是怎么找到代理类的invoke()方法?
- invoke(Object proxy, Method method, Object[] args)方法的参数是怎么被传入的?
要想解答上述问题,我们只有深入源码,源码面前一切皆透明。
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
// 检查传入的InvocationHandler对象(即ds)是否为null,即代理类对象
Objects.requireNonNull(h);
final Class<?>[] intfs = interfaces.clone();
// 获取安全权限相关的对象实例
final SecurityManager sm = System.getSecurityManager();
if (sm != null) {
// 进行安全权限检查
checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
}
/*
* 查找或生成指定的动态代理类
*/
Class<?> cl = getProxyClass0(loader, intfs);
/*
* 获取生成的动态代理类的构造方法并且调用
*/
try {
if (sm != null) {
// 权限检查
checkNewProxyPermission(Reflection.getCallerClass(), cl);
}
// private static final Class<?>[] constructorParams = { InvocationHandler.class };
// 通过反射获取生成的动态代理类的构造器,注意构造器的参数类型是InvocationHandler对象
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;
}
});
}
// 将代理类对象(即ds)传入并且返回动态代理对象
return cons.newInstance(new Object[]{h});
} catch (IllegalAccessException|InstantiationException e) {
throw new InternalError(e.toString(), e);
} catch (InvocationTargetException e) {
Throwable t = e.getCause();
if (t instanceof RuntimeException) {
throw (RuntimeException) t;
} else {
throw new InternalError(t.toString(), t);
}
} catch (NoSuchMethodException e) {
throw new InternalError(e.toString(), e);
}
}
通过上面的分析可以看到newProxyInstance()方法主要完成这散布操作:
- 调用getProxyClass0()方法创建动态代理类的class文件
- 获取动态代理类参数类型为InvocationHandler的构造器
- 给构造传入代理类对象并返回动态代理实例
接下类来们分析一下虚拟机是如何在运行期间创建动态代理类的class文件?
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
// 如果给定的加载器加载的代理类已经实现了给定的接口,则从缓存中返回动态代理class对象
// 否则使用 ProxyClassFactory 创建代理类
return proxyClassCache.get(loader, interfaces);
}
private static final class ProxyClassFactory
implements BiFunction<ClassLoader, Class<?>[], Class<?>>
{
// 生成代理类类名的前缀为 $Proxy
private static final String proxyClassNamePrefix = "$Proxy";
// 生成唯一代理类名称的下一个数字
private static final AtomicLong nextUniqueNumber = new AtomicLong();
@Override
public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {
Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length);
for (Class<?> intf : interfaces) {
Class<?> interfaceClass = null;
try {
// 使用给定的类加载器加载给定的接口
interfaceClass = Class.forName(intf.getName(), false, loader);
} catch (ClassNotFoundException e) {
}
if (interfaceClass != intf) {
throw new IllegalArgumentException(
intf + " is not visible from class loader");
}
if (!interfaceClass.isInterface()) {
throw new IllegalArgumentException(
interfaceClass.getName() + " is not an interface");
}
if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
throw new IllegalArgumentException(
"repeated interface: " + interfaceClass.getName());
}
}
// 为开始生成class对象做一些准备工作
String proxyPkg = null; // 用于定义代理类的包
int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
for (Class<?> intf : interfaces) {
int flags = intf.getModifiers();
if (!Modifier.isPublic(flags)) {
accessFlags = Modifier.FINAL;
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");
}
}
}
if (proxyPkg == null) {
// if no non-public proxy interfaces, use com.sun.proxy package
proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
}
/*
* 选择要生成的代理类的名称
*/
long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;
/*
* 生成指定的代理类
*/
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);
try {
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
} catch (ClassFormatError e) {
throw new IllegalArgumentException(e.toString());
}
}
}
获取要生成的代理类的class文件的字节流
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(proxyName, interfaces, accessFlags)
根据字节流调用C++或C创建class对象
defineClass0(loader, proxyName, proxyClassFile, 0, proxyClassFile.length);
获取字节流的实现如下所示:
// var0 要生成代理类的全限定类名
// var1 目标类实现的接口
// var2 生成代理类的权限
public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
final byte[] var4 = var3.generateClassFile();
// private static final boolean saveGeneratedFiles = (Boolean)AccessController.doPrivileged(new GetBooleanAction("sun.misc.ProxyGenerator.saveGeneratedFiles"));
// 是否保存生成的class文件
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;
}
private byte[] generateClassFile() {
this.addProxyMethod(hashCodeMethod, Object.class);
this.addProxyMethod(equalsMethod, Object.class);
this.addProxyMethod(toStringMethod, Object.class);
Class[] var1 = this.interfaces;
int var2 = var1.length;
int var3;
Class var4;
for(var3 = 0; var3 < var2; ++var3) {
var4 = var1[var3];
Method[] var5 = var4.getMethods();
int var6 = var5.length;
for(int var7 = 0; var7 < var6; ++var7) {
Method var8 = var5[var7];
this.addProxyMethod(var8, var4);
}
}
Iterator var11 = this.proxyMethods.values().iterator();
List var12;
while(var11.hasNext()) {
var12 = (List)var11.next();
checkReturnTypes(var12);
}
Iterator var15;
try {
this.methods.add(this.generateConstructor());
var11 = this.proxyMethods.values().iterator();
while(var11.hasNext()) {
var12 = (List)var11.next();
var15 = var12.iterator();
while(var15.hasNext()) {
ProxyGenerator.ProxyMethod var16 = (ProxyGenerator.ProxyMethod)var15.next();
this.fields.add(new ProxyGenerator.FieldInfo(var16.methodFieldName, "Ljava/lang/reflect/Method;", 10));
this.methods.add(var16.generateMethod());
}
}
this.methods.add(this.generateStaticInitializer());
} catch (IOException var10) {
throw new InternalError("unexpected I/O Exception", var10);
}
generateClassFile()生成动态代理类的字节流
通过动态代理类的生成过程分析,我们能够回答上面的一些问题。但是对于其他问题,我们依然只有观察生成的class文件才能回答。
在generateProxyClass()方法中,我们通过判断sun.misc.ProxyGenerator.saveGeneratedFiles属性是否为true,可以决定我们是否保留class文件。所以,我们将其改为true,在刚才的main方法下的第一行,添加如下代码:
System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles","true");
这是生成的代理类对象,代码如下:
public final class $Proxy0 extends Proxy implements Subject {
private static Method m1;
private static Method m3;
private static Method m2;
private static Method m0;
public $Proxy0(InvocationHandler var1) throws {
super(var1);
}
public final boolean equals(Object var1) throws {
try {
return (Boolean)super.h.invoke(this, m1, new Object[]{var1});
} catch (RuntimeException | Error var3) {
throw var3;
} catch (Throwable var4) {
throw new UndeclaredThrowableException(var4);
}
}
public final void doSomething() throws {
try {
super.h.invoke(this, m3, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
public final String toString() throws {
try {
return (String)super.h.invoke(this, m2, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
public final int hashCode() throws {
try {
return (Integer)super.h.invoke(this, m0, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
static {
try {
m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
m3 = Class.forName("com.wangzhao.jvm.bytecode.proxy.Subject").getMethod("doSomething");
m2 = Class.forName("java.lang.Object").getMethod("toString");
m0 = Class.forName("java.lang.Object").getMethod("hashCode");
} catch (NoSuchMethodException var2) {
throw new NoSuchMethodError(var2.getMessage());
} catch (ClassNotFoundException var3) {
throw new NoClassDefFoundError(var3.getMessage());
}
}
}
可以看到生成的代理类的class文件中存在参数类型为InvocationHandler的构造方法,以及一个静态代码块,而静态代码块是通过反射获取的method对象,并且当调用生成的代理类的内的方法时,最后都转向了调用其父类成员变量h的invoke()方法,而h便是我们传入的代理类对象ds。所以这便是我们为什么要传入那些参数,调用生成的代理类对象的doSomething()时,是如何找到的代理类的invoke()方法,以及invoke()的参数是如何被传入的答案。
需要注意的是,对于Object的hashCode()、equals()以及toString()方法,最终都会回调代理类的invoke()方法。
这便是JDK动态代理的实现原理,而CGLIB的实现,则是通过继承,重写相关方法实现动态代理。