在深入理解之前，我们先来看一个简单的例子。
首先，定义了一个接口 Anmial，并让 Cat 类实现了 Anmial 接口。
public interface Animal {
void eat();
}
public class Cat implements Animal {
@Override
public void eat() {
System.out.println("猫吃鱼");
}
}
然后定义一个 InvocationHandler 的实现类。
public class JdkDynamicProxy implements InvocationHandler {
/**
* 目标对象（也被称为被代理对象）
*
* Java 代理模式的一个必要要素就是代理对象要能拿到被代理对象的引用
*/
private Object target;
public JdkDynamicProxy(Object target){
this.target=target;
}
/**
* 回调方法
* @param proxy JDK 生成的代理对象
* @param method 被代理的方法（也就是需要增强的方法）
* @param args 被代理方法的参数
* @return
* @throws Throwable
*/
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
System.out.println("JdkDynamicProxy invoke 方法执行前-------------------------------");
Object object= method.invoke(target,args);
System.out.println("JdkDynamicProxy invoke 方法执行后-------------------------------");
return object;
}
/**
* 获取被代理接口实例对象
*
* 通过 Proxy.newProxyInstance 可以获得一个代理对象，它实现了 target.getClass().getInterfaces() 接口
*
* @param <T>
* @return
*/
public <T> T getProxy() {
return (T) Proxy.newProxyInstance(target.getClass().getClassLoader(),
target.getClass().getInterfaces(),
this);
}
}
通过 Client 组合上述代码。
public class Client {
public static void main(String[] args) {
// 1. 构造目标对象
Cat catTarget = new Cat();
// 2. 根据目标对象生成代理对象
JdkDynamicProxy proxy = new JdkDynamicProxy(catTarget);
// JDK 动态代理是基于接口的，所以只能转换为 Cat 实现的接口 Animal
Animal catProxy = proxy.getProxy();
// 调用代理对象的方法
catProxy.eat();
}
}
测试结果如下所示：
控制台打印内容
源码解析
在源码解读之前，先说明一下本文使用的 JDK 版本为 jdk1.8.0_201。
上文中核心代码是 Proxy.newProxyInstance 方法调用，以此为入口深入探究一下 JDK 动态代理的实现原理。
/** JDK 生成的代理类的构造方法的参数类型列表 */
private static final Class<?>[] constructorParams =
{ InvocationHandler.class };
/**
* loader: 类加载器
* interfaces: 目标对象实现的接口列表
* h: InvocationHandler 接口的实现类
*/
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
// 1. 根据 ClassLoader、interfaces 生成代理类 Class
Class<?> cl = getProxyClass0(loader, intfs);
// 2. 从代理类 Class 中获取参数类型是 InvocationHandler 的构造方法
final Constructor<?> cons = cl.getConstructor(constructorParams);
// 3. 通过构造方法生成代理类对象
return cons.newInstance(new Object[]{h});
}
第 2、3 步非常容易理解，所以接下来我们关注第 1 步的逻辑。
/**
* 代理类 Class 的缓存
*/
private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
//如果代理类已存在与缓存中直接获取，如果不存在通过 ProxyClassFactory 生成并返回
return proxyClassCache.get(loader, interfaces);
}
WeakCache 类中的 get 方法逻辑如下所示：
public WeakCache(BiFunction<K, P, ?> subKeyFactory,
BiFunction<K, P, V> valueFactory) {
this.subKeyFactory = Objects.requireNonNull(subKeyFactory);
// valueFactory = ProxyClassFactory
this.valueFactory = Objects.requireNonNull(valueFactory);
}
private final class Factory implements Supplier<V> {
@Override
public synchronized V get() {
V value = null;
// 调用 valueFactory(ProxyClassFactory) 的 applay 方法
value = Objects.requireNonNull(valueFactory.apply(key, parameter));
return value;
}
}
public V get(K key, P parameter) {
while (true) {
if (supplier != null) {
// 3. 调用 supplier(Factory) 的 get 方法获取代理类 Class
V value = supplier.get();
if (value != null) {
return value;
}
}
// 1. 创建一个 Factory 对象
if (factory == null) {
factory = new Factory(key, parameter, subKey, valuesMap);
}
// 2. factory 赋值给 supplier
if (supplier == null) {
supplier = factory;
}
}
}
我们已经知道如果缓存中没有对应的代理类就调用 ProxyClassFactory 的 apply 方法生成。
// JDK 动态代理类的类名前缀
private static final String proxyClassNamePrefix = "$Proxy";
public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {
Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length);
String proxyPkg = null; // 代理类所在的包名
int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
// 如果代理类实现的接口是否非 public 的，代理类和它实现的接口必须在一个包下
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");
}
}
}
// 如果没有非 public 的代理接口，则使用 "com.sun.proxy" 包
if (proxyPkg == null) {
// ReflectUtil.PROXY_PACKAGE = "com.sun.proxy";
proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
}
/*
* Choose a name for the proxy class to generate.
*/
long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;
/*
* 生成具体的代理类 Class File，这里是重点
*/
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);
// 加载 Class 到 JVM 中
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
}
ProxyGenerator 类的静态方法 generateProxyClass，这里是真正生成代理类 class 字节码的地方。
private static final boolean saveGeneratedFiles = (Boolean)AccessController.doPrivileged(new GetBooleanAction("sun.misc.ProxyGenerator.saveGeneratedFiles"));
public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
// 这里是生成 JDK 动态代理 Class File 的逻辑，暂时可以忽略。
final byte[] var4 = var3.generateClassFile();
// 如果 saveGeneratedFiles 变量为 true，把生成的 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;
}
$Proxy 类剖析
把 sun.misc.ProxyGenerator.saveGeneratedFiles 系统属性设置为 true，即可保存 JDK 生成的代理类到当前项目根目录下。
// 设置此系统属性,让 JVM 生成的 Proxy 类写入文件. 保存路径为项目的根目录
System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
生成的 $Proxy0 类如下所示。
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package com.sun.proxy;
import com.wilimm.proxy.jdk.Animal;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
public final class $Proxy0 extends Proxy implements Animal {
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 eat() 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.wilimm.proxy.jdk.Animal").getMethod("eat");
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());
}
}
}
我们可以看到代理类 $Proxy0 继承了 java.lang.reflect.Proxy 类（Java 只能单继承），所以 JDK 的动态代理只能基于接口。
首先，代理类会通过静态代码块初始化 hashCode、equals、toString 这三个继承 Object 的方法，以及Animal 接口的 eat 方法。
m3 = Class.forName("com.wilimm.proxy.jdk.Animal").getMethod("eat");
然后，构造方法实例化代理类，入参为 InvocationHandler，详见 Proxy.newProxyInstance 方法调用。
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
// 1. 根据 ClassLoader、interfaces 生成代理类 Class
Class<?> cl = getProxyClass0(loader, intfs);
// 2. 从代理类 Class 中获取参数类型是 InvocationHandler 的构造方法
final Constructor<?> cons = cl.getConstructor(constructorParams);
// 3. 通过构造方法生成代理类对象
return cons.newInstance(new Object[]{h});
}
最后，覆盖接口方法，方法中调用 InvocationHandler 的 invoke 方法，通过多态特性从而实现了动态代理。
public final void eat() throws {
try {
super.h.invoke(this, m3, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
至此，我们基本上了解 JDK 动态代理实现的原理。
(正文完)
