本文是基于jdk1.8來對動態(tài)代理的底層機制進行探究的
Java中代理的實現(xiàn)一般分為三種:JDK靜態(tài)代理、JDK動態(tài)代理以及CGLIB動態(tài)代理。在Spring的AOP實現(xiàn)中层扶,主要應用了JDK動態(tài)代理以及CGLIB動態(tài)代理。但是本文著重介紹JDK動態(tài)代理機制,CGLIB動態(tài)代理后面會接著探究园爷。
代理一般實現(xiàn)的模式為JDK靜態(tài)代理:創(chuàng)建一個接口,然后創(chuàng)建被代理的類實現(xiàn)該接口并且實現(xiàn)該接口中的抽象方法式撼。之后再創(chuàng)建一個代理類童社,同時使其也實現(xiàn)這個接口。在代理類中持有一個被代理對象的引用著隆,而后在代理類方法中調(diào)用該對象的方法扰楼。
其實就是代理類為被代理類預處理消息呀癣、過濾消息并在此之后將消息轉(zhuǎn)發(fā)給被代理類,之后還能進行消息的后置處理弦赖。代理類和被代理類通常會存在關聯(lián)關系(即上面提到的持有的被帶離對象的引用)项栏,代理類本身不實現(xiàn)服務,而是通過調(diào)用被代理類中的方法來提供服務蹬竖。
我們可以看出沼沈,使用JDK靜態(tài)代理很容易就完成了對一個類的代理操作。但是JDK靜態(tài)代理的缺點也暴露了出來:由于代理只能為一個類服務币厕,如果需要代理的類很多列另,那么就需要編寫大量的代理類,比較繁瑣旦装。
下面我們使用JDK動態(tài)代理來做同樣的事情
JDK動態(tài)代理其實也是基本接口實現(xiàn)的页衙。因為通過接口指向?qū)崿F(xiàn)類實例的多態(tài)方式,可以有效地將具體實現(xiàn)與調(diào)用解耦阴绢,便于后期的修改和維護店乐。
通過上面的介紹,我們可以發(fā)現(xiàn)JDK靜態(tài)代理與JDK動態(tài)代理之間有些許相似呻袭,比如說都要創(chuàng)建代理類眨八,以及代理類都要實現(xiàn)接口等。但是不同之處也非常明顯----在靜態(tài)代理中我們需要對哪個接口和哪個被代理類創(chuàng)建代理類棒妨,所以我們在編譯前就需要代理類實現(xiàn)與被代理類相同的接口踪古,并且直接在實現(xiàn)的方法中調(diào)用被代理類相應的方法;但是動態(tài)代理則不同券腔,我們不知道要針對哪個接口伏穆、哪個被代理類創(chuàng)建代理類,因為它是在運行時被創(chuàng)建的纷纫。
讓我們用一句話來總結(jié)一下JDK靜態(tài)代理和JDK動態(tài)代理的區(qū)別枕扫,然后開始探究JDK動態(tài)代理的底層實現(xiàn)機制:
JDK靜態(tài)代理是通過直接編碼創(chuàng)建的,而JDK動態(tài)代理是利用反射機制在運行時創(chuàng)建代理類的辱魁。
其實在動態(tài)代理中烟瞧,核心是InvocationHandler。每一個代理的實例都會有一個關聯(lián)的調(diào)用處理程序(InvocationHandler)染簇。對待代理實例進行調(diào)用時参滴,將對方法的調(diào)用進行編碼并指派到它的調(diào)用處理器(InvocationHandler)的invoke方法。所以對代理對象實例方法的調(diào)用都是通過InvocationHandler中的invoke方法來完成的锻弓,而invoke方法會根據(jù)傳入的代理對象砾赔、方法名稱以及參數(shù)決定調(diào)用代理的哪個方法。
我們從JDK動態(tài)代理的測試類中可以發(fā)現(xiàn)代理類生成是通過Proxy類中的newProxyInstance來完成的,下面我們進入這個函數(shù)看一看:
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
//如果h為空將拋出異常
Objects.requireNonNull(h);
final Class<?>[] intfs = interfaces.clone();//拷貝被代理類實現(xiàn)的一些接口暴心,用于后面權(quán)限方面的一些檢查
final SecurityManager sm = System.getSecurityManager();
if (sm != null) {
//在這里對某些安全權(quán)限進行檢查妓盲,確保我們有權(quán)限對預期的被代理類進行代理
checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
}
/*
* 下面這個方法將產(chǎn)生代理類
*/
Class<?> cl = getProxyClass0(loader, intfs);
/*
* 使用指定的調(diào)用處理程序獲取代理類的構(gòu)造函數(shù)對象
*/
try {
if (sm != null) {
checkNewProxyPermission(Reflection.getCallerClass(), cl);
}
final Constructor<?> cons = cl.getConstructor(constructorParams);
final InvocationHandler ih = h;
//假如代理類的構(gòu)造函數(shù)是private的,就使用反射來set accessible
if (!Modifier.isPublic(cl.getModifiers())) {
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
cons.setAccessible(true);
return null;
}
});
}
//根據(jù)代理類的構(gòu)造函數(shù)來生成代理類的對象并返回
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);
}
}
所以代理類其實是通過getProxyClass方法來生成的:
/**
* 生成一個代理類专普,但是在調(diào)用本方法之前必須進行權(quán)限檢查
*/
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
//如果接口數(shù)量大于65535悯衬,拋出非法參數(shù)錯誤
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
// 如果在緩存中有對應的代理類,那么直接返回
// 否則代理類將有 ProxyClassFactory 來創(chuàng)建
return proxyClassCache.get(loader, interfaces);
}
那么ProxyClassFactory是什么呢檀夹?
/**
* 里面有一個根據(jù)給定ClassLoader和Interface來創(chuàng)建代理類的工廠函數(shù)
*
*/
private static final class ProxyClassFactory
implements BiFunction<ClassLoader, Class<?>[], Class<?>>
{
// 代理類的名字的前綴統(tǒng)一為“$Proxy”
private static final String proxyClassNamePrefix = "$Proxy";
// 每個代理類前綴后面都會跟著一個唯一的編號筋粗,如$Proxy0、$Proxy1击胜、$Proxy2
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) {
/*
* 驗證類加載器加載接口得到對象是否與由apply函數(shù)參數(shù)傳入的對象相同
*/
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");
}
/*
* 驗證這個Class對象是不是接口
*/
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());
}
}
String proxyPkg = null; // 聲明代理類所在的package
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) {
// 如果全是公共代理接口偶摔,那么生成的代理類就在com.sun.proxy package下
proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
}
/*
* 為代理類生成一個name package name + 前綴+唯一編號
* 如 com.sun.proxy.$Proxy0.class
*/
long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;
/*
* 生成指定代理類的字節(jié)碼文件
*/
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);
try {
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
} catch (ClassFormatError e) {
/*
* A ClassFormatError here means that (barring bugs in the
* proxy class generation code) there was some other
* invalid aspect of the arguments supplied to the proxy
* class creation (such as virtual machine limitations
* exceeded).
*/
throw new IllegalArgumentException(e.toString());
}
}
}
由上方代碼byte[] proxyClassFile = ProxyGenerator.generateProxyClass(proxyName, interfaces, accessFlags);可以看到,其實生成代理類字節(jié)碼文件的工作是通過 ProxyGenerate類中的generateProxyClass方法來完成的促脉。
public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
// 真正用來生成代理類字節(jié)碼文件的方法在這里
final byte[] var4 = var3.generateClassFile();
// 保存代理類的字節(jié)碼文件
if(saveGeneratedFiles) {
AccessController.doPrivileged(new PrivilegedAction() {
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;
}
下面來看看真正用于生成代理類字節(jié)碼文件的generateClassFile方法:
private byte[] generateClassFile() {
//下面一系列的addProxyMethod方法是將接口中的方法和Object中的方法添加到代理方法中(proxyMethod)
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);
}
//后面一系列的步驟用于寫代理類Class文件
Iterator var15;
try {
//生成代理類的構(gòu)造函數(shù)
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();
//將代理類字段聲明為Method辰斋,并且字段修飾符為 private static.
//因為 10 是 ACC_PRIVATE和ACC_STATIC的與運算 故代理類的字段都是 private static Method ***
this.fields.add(new ProxyGenerator.FieldInfo(var16.methodFieldName,
"Ljava/lang/reflect/Method;", 10));
//生成代理類的方法
this.methods.add(var16.generateMethod());
}
}
//為代理類生成靜態(tài)代碼塊對某些字段進行初始化
this.methods.add(this.generateStaticInitializer());
} catch (IOException var10) {
throw new InternalError("unexpected I/O Exception", var10);
}
if(this.methods.size() > '\uffff') { //代理類中的方法數(shù)量超過65535就拋異常
throw new IllegalArgumentException("method limit exceeded");
} else if(this.fields.size() > '\uffff') {// 代理類中字段數(shù)量超過65535也拋異常
throw new IllegalArgumentException("field limit exceeded");
} else {
// 后面是對文件進行處理的過程
this.cp.getClass(dotToSlash(this.className));
this.cp.getClass("java/lang/reflect/Proxy");
var1 = this.interfaces;
var2 = var1.length;
for(var3 = 0; var3 < var2; ++var3) {
var4 = var1[var3];
this.cp.getClass(dotToSlash(var4.getName()));
}
this.cp.setReadOnly();
ByteArrayOutputStream var13 = new ByteArrayOutputStream();
DataOutputStream var14 = new DataOutputStream(var13);
try {
var14.writeInt(-889275714);
var14.writeShort(0);
var14.writeShort(49);
this.cp.write(var14);
var14.writeShort(this.accessFlags);
var14.writeShort(this.cp.getClass(dotToSlash(this.className)));
var14.writeShort(this.cp.getClass("java/lang/reflect/Proxy"));
var14.writeShort(this.interfaces.length);
Class[] var17 = this.interfaces;
int var18 = var17.length;
for(int var19 = 0; var19 < var18; ++var19) {
Class var22 = var17[var19];
var14.writeShort(this.cp.getClass(dotToSlash(var22.getName())));
}
var14.writeShort(this.fields.size());
var15 = this.fields.iterator();
while(var15.hasNext()) {
ProxyGenerator.FieldInfo var20 = (ProxyGenerator.FieldInfo)var15.next();
var20.write(var14);
}
var14.writeShort(this.methods.size());
var15 = this.methods.iterator();
while(var15.hasNext()) {
ProxyGenerator.MethodInfo var21 = (ProxyGenerator.MethodInfo)var15.next();
var21.write(var14);
}
var14.writeShort(0);
return var13.toByteArray();
} catch (IOException var9) {
throw new InternalError("unexpected I/O Exception", var9);
}
}
}
下面是將接口與Object中一些方法添加到代理類中的addProxyMethod方法:
private void addProxyMethod(Method var1, Class<?> var2) {
String var3 = var1.getName();//獲得方法名稱
Class[] var4 = var1.getParameterTypes();//獲得方法參數(shù)類型
Class var5 = var1.getReturnType();//獲得方法返回類型
Class[] var6 = var1.getExceptionTypes();//異常類型
String var7 = var3 + getParameterDescriptors(var4);//獲得方法簽名
Object var8 = (List)this.proxyMethods.get(var7);//根據(jù)方法前面獲得proxyMethod的value
if(var8 != null) {//處理多個代理接口中方法重復的情況
Iterator var9 = ((List)var8).iterator();
while(var9.hasNext()) {
ProxyGenerator.ProxyMethod var10 = (ProxyGenerator.ProxyMethod)var9.next();
if(var5 == var10.returnType) {
ArrayList var11 = new ArrayList();
collectCompatibleTypes(var6, var10.exceptionTypes, var11);
collectCompatibleTypes(var10.exceptionTypes, var6, var11);
var10.exceptionTypes = new Class[var11.size()];
var10.exceptionTypes = (Class[])var11.toArray(var10.exceptionTypes);
return;
}
}
} else {
var8 = new ArrayList(3);
this.proxyMethods.put(var7, var8);
}
((List)var8).add(new ProxyGenerator.ProxyMethod(var3, var4, var5, var6, var2, null));
}