在深入理解之前，我們先來看一個簡單的例子。
首先，定義了一個接口 Anmial，并讓 Cat 類實現(xiàn)了 Anmial 接口。
public interface Animal {
void eat();
}
public class Cat implements Animal {
@Override
public void eat() {
System.out.println("貓吃魚");
}
}
然后定義一個 InvocationHandler 的實現(xiàn)類。
public class JdkDynamicProxy implements InvocationHandler {
/**
* 目標(biāo)對象（也被稱為被代理對象）
*
* Java 代理模式的一個必要要素就是代理對象要能拿到被代理對象的引用
*/
private Object target;
public JdkDynamicProxy(Object target){
this.target=target;
}
/**
* 回調(diào)方法
* @param proxy JDK 生成的代理對象
* @param method 被代理的方法（也就是需要增強的方法）
* @param args 被代理方法的參數(shù)
* @return
* @throws Throwable
*/
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
System.out.println("JdkDynamicProxy invoke 方法執(zhí)行前-------------------------------");
Object object= method.invoke(target,args);
System.out.println("JdkDynamicProxy invoke 方法執(zhí)行后-------------------------------");
return object;
}
/**
* 獲取被代理接口實例對象
*
* 通過 Proxy.newProxyInstance 可以獲得一個代理對象，它實現(xiàn)了 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. 構(gòu)造目標(biāo)對象
Cat catTarget = new Cat();
// 2. 根據(jù)目標(biāo)對象生成代理對象
JdkDynamicProxy proxy = new JdkDynamicProxy(catTarget);
// JDK 動態(tài)代理是基于接口的，所以只能轉(zhuǎn)換為 Cat 實現(xiàn)的接口 Animal
Animal catProxy = proxy.getProxy();
// 調(diào)用代理對象的方法
catProxy.eat();
}
}
測試結(jié)果如下所示：
控制臺打印內(nèi)容
源碼解析
在源碼解讀之前，先說明一下本文使用的 JDK 版本為 jdk1.8.0_201。
上文中核心代碼是 Proxy.newProxyInstance 方法調(diào)用，以此為入口深入探究一下 JDK 動態(tài)代理的實現(xiàn)原理。
/** JDK 生成的代理類的構(gòu)造方法的參數(shù)類型列表 */
private static final Class<?>[] constructorParams =
{ InvocationHandler.class };
/**
* loader: 類加載器
* interfaces: 目標(biāo)對象實現(xiàn)的接口列表
* h: InvocationHandler 接口的實現(xiàn)類
*/
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
// 1. 根據(jù) ClassLoader、interfaces 生成代理類 Class
Class<?> cl = getProxyClass0(loader, intfs);
// 2. 從代理類 Class 中獲取參數(shù)類型是 InvocationHandler 的構(gòu)造方法
final Constructor<?> cons = cl.getConstructor(constructorParams);
// 3. 通過構(gòu)造方法生成代理類對象
return cons.newInstance(new Object[]{h});
}
第 2、3 步非常容易理解，所以接下來我們關(guān)注第 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;
// 調(diào)用 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. 調(diào)用 supplier(Factory) 的 get 方法獲取代理類 Class
V value = supplier.get();
if (value != null) {
return value;
}
}
// 1. 創(chuàng)建一個 Factory 對象
if (factory == null) {
factory = new Factory(key, parameter, subKey, valuesMap);
}
// 2. factory 賦值給 supplier
if (supplier == null) {
supplier = factory;
}
}
}
我們已經(jīng)知道如果緩存中沒有對應(yīng)的代理類就調(diào)用 ProxyClassFactory 的 apply 方法生成。
// JDK 動態(tài)代理類的類名前綴
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;
// 如果代理類實現(xiàn)的接口是否非 public 的，代理類和它實現(xiàn)的接口必須在一個包下
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 類的靜態(tài)方法 generateProxyClass，這里是真正生成代理類 class 字節(jié)碼的地方。
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 動態(tài)代理 Class File 的邏輯，暫時可以忽略。
final byte[] var4 = var3.generateClassFile();
// 如果 saveGeneratedFiles 變量為 true，把生成的 Class 文件寫入到當(dāng)前項目根目錄下
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 系統(tǒng)屬性設(shè)置為 true，即可保存 JDK 生成的代理類到當(dāng)前項目根目錄下。
// 設(shè)置此系統(tǒng)屬性,讓 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 的動態(tài)代理只能基于接口。
首先，代理類會通過靜態(tài)代碼塊初始化 hashCode、equals、toString 這三個繼承 Object 的方法，以及Animal 接口的 eat 方法。
m3 = Class.forName("com.wilimm.proxy.jdk.Animal").getMethod("eat");
然后，構(gòu)造方法實例化代理類，入?yún)?InvocationHandler，詳見 Proxy.newProxyInstance 方法調(diào)用。
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
// 1. 根據(jù) ClassLoader、interfaces 生成代理類 Class
Class<?> cl = getProxyClass0(loader, intfs);
// 2. 從代理類 Class 中獲取參數(shù)類型是 InvocationHandler 的構(gòu)造方法
final Constructor<?> cons = cl.getConstructor(constructorParams);
// 3. 通過構(gòu)造方法生成代理類對象
return cons.newInstance(new Object[]{h});
}
最后，覆蓋接口方法，方法中調(diào)用 InvocationHandler 的 invoke 方法，通過多態(tài)特性從而實現(xiàn)了動態(tài)代理。
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 動態(tài)代理實現(xiàn)的原理。
(正文完)
