代理模式 代理模式一般包含三個角色： Subject：主題對象，一般是一個介面，定義一些業務相關的基本方法。 RealSubject：具體的主題對象實現類，它會實現Subject介面中的方法。 Proxy：代理對象，裡面包含一個RealSubject的引用，外部會通過這個代理對象，來實現RealSu ...
代理模式
代理模式一般包含三個角色：
- Subject：主題對象，一般是一個介面，定義一些業務相關的基本方法。
- RealSubject：具體的主題對象實現類，它會實現Subject介面中的方法。
- Proxy：代理對象，裡面包含一個RealSubject的引用，外部會通過這個代理對象，來實現RealSubject中方法的調用。
JAVA中提供了動態代理的實現，需要依賴InvocationHandler。
舉個例子
Subject
首先創建一個主題對象，裡面定義一個execute方法：
public interface Subject {
void execute();
}
RealSubject
接著創建具體的主題對象實現類，它會實現Subject的方法
public class RealSubject implements Subject {
@Override
public void execute() {
System.out.println("realsubject方法執行");
}
}
創建InvocationHandler
JDK動態代理需要依賴InvocationHandler，所以這裡創建一個ProxyInvocationHandler實現它的invoke方法，並提供了getProxy方法來獲取創建的代理對象，ProxyInvocationHandler類中引用了需要代理的目標對象，也就是RealSubject，在invoke方法中通過反射執行了RealSubject中的方法：
public class ProxyInvocationHandler implements InvocationHandler {
/**
* 代理的目標對象，也就是RealSubject
*/
private Object target;
/**
* 構造函數
*/
public ProxyInvocationHandler(Object target){
this.target = target;
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
System.out.println("開始執行方法：" + method.getName());
// 通過反射執行RealSubject中的方法
Object result = method.invoke(target, args);
System.out.println("結束執行方法：" + method.getName());
return null;
}
public Object getProxy() {
// 創建代理對象，傳入了類載入器、要代理對象的介面、InvocationHandler（this當前對象）
return Proxy.newProxyInstance(Thread.currentThread()
.getContextClassLoader(), target.getClass().getInterfaces(), this);
}
}
測試：
public class ProxyTest {
public static void main(String[] args) {
System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
// 創建實際的對象
Subject subject = new RealSubject();
// 創建InvocationHandler，這裡傳入的真是對象
ProxyInvocationHandler invocationHandler = new ProxyInvocationHandler(subject);
// 獲取代理對象
Subject proxy = (Subject) invocationHandler.getProxy();
// 執行方法
proxy.execute();
}
}
運行結果：
開始執行方法：execute
realsubject方法執行
結束執行方法：execute
根據輸出結果，可以看出JDK動態代理，主要是通過InvocationHandler生成一個代理對象，通過這個代理對象可以執行目標方法，執行之時，首先會進入到InvocationHandler中的invoke方法，在創建InvocationHandler時
傳入了實際的對象RealSubject，所以InvocationHandler中可以拿到真實對象，只需要在InvocationHandler中的invoke方法中通過反射執行RealSubject中對應的方法即可。
動態代理實現原理
在ProxyInvocationHandler中可以看到通過Proxy創建了一個代理對象，那麼接下來就進入到Proxy中，看一下是如何創建代理對象的：
// 創建代理對象，傳入了類載入器、要代理對象的介面、InvocationHandler（this當前對象）
return Proxy.newProxyInstance(Thread.currentThread()
.getContextClassLoader(), target.getClass().getInterfaces(), this);
Proxy
在Proxy中newProxyInstance方法創建代理對象的時候，傳入了類載入器、需要代理的對象以及InvocationHandler：
- 根據類載入器和需要代理的對象介面信息生成代理對象的class；
- 根據生成的代理類的class信息，獲取類的構造器；
- 通過構造器創建代理對象，並將InvocationHandler傳入；
public class Proxy implements java.io.Serializable {
// 創建代理對象
@CallerSensitive
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h) throws IllegalArgumentException {
Objects.requireNonNull(h);
final Class<?>[] intfs = interfaces.clone();
final SecurityManager sm = System.getSecurityManager();
if (sm != null) {
checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
}
// 1. 根據類載入器和需要代理的對象介面信息生成代理對象的class
Class<?> cl = getProxyClass0(loader, intfs);
try {
if (sm != null) {
checkNewProxyPermission(Reflection.getCallerClass(), cl);
}
// 2. 獲取類構造器
final Constructor<?> cons = cl.getConstructor(constructorParams);
// InvocationHandler
final InvocationHandler ih = h;
if (!Modifier.isPublic(cl.getModifiers())) {
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
cons.setAccessible(true);
return null;
}
});
}
// 3. 通過構造器創建代理對象，並將InvocationHandler傳入
return cons.newInstance(new Object[]{h});
} catch (IllegalAccessException|InstantiationException e) {
//...
}
}
}
生成代理類的class
getProxyClass0中首先會進行邊界檢查，然後根據類載入器和需要代理的對象介面信息從緩存中獲取生成的代理類的calss，具體的實現在WeakCache的get方法中：
/**
* 代理類的緩存
*/
private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());
/**
* 生成代理類的class
*/
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
// 邊界檢查
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
// 從緩存proxyClassCache中獲取class
return proxyClassCache.get(loader, interfaces);
}
WeakCache
WeakCache的get方法中如果根據緩存key獲取對象為空，會創建一個Factory對象賦值給Supplier，Factory是WeakCache的一個內部類，它實現了Supplier介面，然後調用Supplier的get方法來生成代理類的class，接下來進入到Factory的get方法中：
final class WeakCache<K, P, V> {
// 獲取class
public V get(K key, P parameter) {
Objects.requireNonNull(parameter);
expungeStaleEntries();
// 獲取緩存key
Object cacheKey = CacheKey.valueOf(key, refQueue);
// 根據key獲取對象
ConcurrentMap<Object, Supplier<V>> valuesMap = map.get(cacheKey);
// 如果為空
if (valuesMap == null) {
// 創建一個ConcurrentMap
ConcurrentMap<Object, Supplier<V>> oldValuesMap
= map.putIfAbsent(cacheKey,
valuesMap = new ConcurrentHashMap<>());
if (oldValuesMap != null) {
valuesMap = oldValuesMap;
}
}
// 創建subKey
Object subKey = Objects.requireNonNull(subKeyFactory.apply(key, parameter));
Supplier<V> supplier = valuesMap.get(subKey);
Factory factory = null;
while (true) {
if (supplier != null) {
// 調用get方法獲取class
V value = supplier.get();
if (value != null) {
return value;
}
}
// 如果為空，創建Factory
if (factory == null) {
factory = new Factory(key, parameter, subKey, valuesMap);
}
// 如果supplier為null
if (supplier == null) {
supplier = valuesMap.putIfAbsent(subKey, factory);
if (supplier == null) {
// 將factory賦值給supplier
supplier = factory;
}
} else {
if (valuesMap.replace(subKey, supplier, factory)) {
supplier = factory;
} else {
// retry with current supplier
supplier = valuesMap.get(subKey);
}
}
}
}
}
Factory
Factory是WeakCache的一個內部類，它實現了Supplier介面，在get方法中，又調用了valueFactory的apply方法創建class，valueFactory是WeakCache的一個成員變數，在WeakCache的構造函數中可以看到傳入了valueFactory對象進行初始化，那麼接下來就需要回到Proxy類中，看一下如何實例化WeakCache的：
final class WeakCache<K, P, V> {
private final BiFunction<K, P, V> valueFactory;
public WeakCache(BiFunction<K, P, ?> subKeyFactory,
BiFunction<K, P, V> valueFactory) {
this.subKeyFactory = Objects.requireNonNull(subKeyFactory);
// 初始化
this.valueFactory = Objects.requireNonNull(valueFactory);
}
// Factory
private final class Factory implements Supplier<V> {
private final K key;
private final P parameter;
private final Object subKey;
private final ConcurrentMap<Object, Supplier<V>> valuesMap;
Factory(K key, P parameter, Object subKey,
ConcurrentMap<Object, Supplier<V>> valuesMap) {
this.key = key;
this.parameter = parameter;
this.subKey = subKey;
this.valuesMap = valuesMap;
}
@Override
public synchronized V get() {
//
Supplier<V> supplier = valuesMap.get(subKey);
if (supplier != this) {
return null;
}
V value = null;
try {
// 調用valueFactory的apply方法創建class
value = Objects.requireNonNull(valueFactory.apply(key, parameter));
} finally {
if (value == null) { // remove us on failure
valuesMap.remove(subKey, this);
}
}
......
return value;
}
}
}
ProxyClassFactory
Proxy中WeakCache初始化的時候使用的是ProxyClassFactory類型的factory：
public class Proxy implements java.io.Serializable {
/**
* WeakCache初始化
*/
private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());
}
所以調用valueFactory的apply方法的時候會進入到ProxyClassFactory的apply方法，在apply方法中會通過ProxyGenerator動態生成代理類並載入類，然後將實例化的代理類返回：
private static final class ProxyClassFactory
implements BiFunction<ClassLoader, Class<?>[], Class<?>>
{
// 首碼
private static final String proxyClassNamePrefix = "$Proxy";
// next number to use for generation of unique proxy class names
private static final AtomicLong nextUniqueNumber = new AtomicLong();
@Override
public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {
Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length);
......
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());
}
}
}
ProxyGenerator
ProxyGenerator是Proxy的一個內部類，用於動態生成class：
private static final class ProxyClassFactory implements BiFunction<ClassLoader, Class<?>[], Class<?>> {
public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
// 生成class
final byte[] var4 = var3.generateClassFile();
// 是否保存到文件,如果開啟了之後，運行程式之後會在包下麵生成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), new String[0]);
Files.createDirectories(var3, new FileAttribute[0]);
var2 = var3.resolve(var0.substring(var1 + 1, var0.length()) + ".class");
} else {
var2 = Paths.get(var0 + ".class", new String[0]);
}
Files.write(var2, var4, new OpenOption[0]);
return null;
} catch (IOException var4x) {
throw new InternalError("I/O exception saving generated file: " + var4x);
}
}
});
}
return var4;
}
}
代理類的生成
由於設置了sun.misc.ProxyGenerator.saveGeneratedFiles為true，所以可以在包下麵看到生成的代理類$Proxy0：
- 它繼承了Proxy並實現了Subject，並且在構造函數中需要傳入InvocationHandler對象；
- 當執行$Proxy0中的execute方法時，實際上調用的是InvocationHandler的invoke方法；
package com.sun.proxy;
import com.example.demo.bean.Subject;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
// 動態生成了一個$Proxy0類，它繼承了Proxy並實現了Subject
public final class $Proxy0 extends Proxy implements Subject {
private static Method m1;
private static Method m2;
private static Method m3;
private static Method m0;
// 傳入InvocationHandler對象
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})).booleanValue();
} catch (RuntimeException | Error var3) {
throw var3;
} catch (Throwable var4) {
throw new UndeclaredThrowableException(var4);
}
}
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);
}
}
// Subject的execute方法
public final void execute() throws {
try {
// 調用了InvocationHandler的invoke方法
super.h.invoke(this, m3, (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)).intValue();
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
static {
try {
m1 = Class.forName("java.lang.Object").getMethod("equals", new Class[]{Class.forName("java.lang.Object")});
m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);
m3 = Class.forName("com.example.demo.bean.Subject").getMethod("execute", new Class[0]);
m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);
} catch (NoSuchMethodException var2) {
throw new NoSuchMethodError(var2.getMessage());
} catch (ClassNotFoundException var3) {
throw new NoClassDefFoundError(var3.getMessage());
}
}
}
總結
JDK的動態代理實現原理是在運行中動態生成代理類，這個代理類實現了Subject介面，在對代理類進行實例化的時候，需要傳入InvocationHandler，當調用代理類的方法時，會執行InvocationHandler的invoke方法，在invoke方法中再執行真正的目標方法，從而完成代理功能。
參考
