閑來無事,擼擼原始碼
食用方法
直接看代碼吧,,
package com.test.demo.proxy;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
/**
* 每個代理物件 內部都有一個實作了InvocationHandler介面的 類的實體
*
* InvocationHandler 顧名思義就是 代理物件的方法呼叫的處理類(呼叫它的invoke方法)
*
* @author lizhecao 2018/4/19
* @version 1.0
*/
public class InvocationHandlerImpl implements InvocationHandler {
// 目標物件
private Object target;
public InvocationHandlerImpl(Object target) {
this.target = target;
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
// 代理方法簡單地打下日志,這其實就是spring aop的簡單實作
System.out.println("start");
// 呼叫目標物件的實際方法
Object result = method.invoke(target, args);
System.out.println("end");
return result;
}
/**
* 通過Proxy.newProxyInstance 生成代理物件(重要的方法)
*/
public Object getProxy() {
return Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(),
target.getClass().getInterfaces(), this);
}
public static void main(String[] args) {
// 實體化目標物件
User user = new UserImpl();
// 用目標物件實體化InvocationHandler
InvocationHandlerImpl invocationHandler = new InvocationHandlerImpl(user);
// 生成代理物件
User proxyUser = (User) invocationHandler.getProxy();
// 呼叫代理物件的方法,實際上就是呼叫了invocationHandler的invoke方法
proxyUser.sayHello();
}
}
package com.test.demo.proxy;
/**
* 目標類的介面,jdk動態代理的類一定要實作某一個介面
*
* @author lizhecao 2018/4/19
* @version 1.0
*/
public interface User {
void sayHello();
}
package com.test.demo.proxy;
/**
* 目標物件的具體類
*
* @author lizhecao 2018/4/19
* @version 1.0
*/
public class UserImpl implements User {
@Override
public void sayHello() {
System.out.println("hello");
}
}
運行了InvocationHandlerImpl中的main方法我們會得到結果:
start
hello
end
理解原理
通過上面的例子可以看到,生成代理物件的重點是
Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(),
target.getClass().getInterfaces(), this);
這個方法,我們進入這個方法看看jdk動態代理的具體實作,
去繁就簡,刪掉一些不關注的東西,有興趣的自己一一過下
/**
* 回傳指定介面的代理類實體,并分配方法的呼叫給指定的invocationHandler
*
* @param loader 用來define代理類的 類加載器
* @param interfaces 代理類要實作的介面(這里也說明了jdk動態代理物件必須實作介面)
* @param h 用來分配方法呼叫的 invocation handler
* @return 一個實作了特定介面,用特定的class loader define的包含特定的invocation hanlder的代理類的實體
*/
@CallerSensitive
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
// 不允許hanlder 為空(不然搞啥)
Objects.requireNonNull(h);
// 防止介面被改
final Class<?>[] intfs = interfaces.clone();
/*
* 查找或生產指定代理類(也就是說有快取機制)(這里是重點,生產了代理類的Class!!)
*/
Class<?> cl = getProxyClass0(loader, intfs);
/*
* 用我們的handler 作為proxy class的構造方法的引數,創建proxy class實體
*/
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;
}
});
}
return cons.newInstance(new Object[]{h});
}
繼續看這個getProxyClass0(loader, intfs) 是怎么生產代理類的
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
// 介面的數量不能超過65535個(呵呵)
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
// 從WeakCache的快取中獲取,如果沒有就創建
return proxyClassCache.get(loader, interfaces);
}
這里是通過WeakCache快取了代理類的實體,就是這貨
/**
* a cache of proxy classes
*/
private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());
這里簡單講下WeakCache,不然沒玩過的朋友可能看不下去了,
WeakCache<K, P, V> 快取的是<key, sub-key> -> value這樣的鍵值對,key和value是弱參考的,sub-key是強參考的(當然,這不重要)K, P, V分別表示key,引數,value的型別,有人會好奇,那sub-key呢?引數用來干嘛?我們重點看它的構造方法
/**
* @param subKeyFactory 一個這樣 (key, parameter) -> sub-key 的函式
* @param valueFactory 一個那樣 (key, parameter) -> value的函式
*/
public WeakCache(BiFunction<K, P, ?> subKeyFactory,
BiFunction<K, P, V> valueFactory) {
this.subKeyFactory = Objects.requireNonNull(subKeyFactory);
this.valueFactory = Objects.requireNonNull(valueFactory);
}
可以看到,只要傳入兩個函式類,就可以通過key 和 parameter 分別生成 sub-key和value了,這樣我們就可以理解生成代理物件的這一句
// 第一次獲取proxy class就會通過loader 和 interfaces 分別生成快取的subkey 和 value, 并且回傳value
return proxyClassCache.get(loader, interfaces);
那么我們也知道了這個value是通過valueFactory生成的,引數是loader 和 interface,那么看下proxyClassCache的實體化方法: new WeakCache<>(new KeyFactory(), new ProxyClassFactory()) 就知道了這個ProxyClassFactory類就是真正實作了(loader, interface) -> proxyClass 的函式式類了,趕緊看下
/**
* 使用給定的ClassLoader 和 介面陣列來 生成,define,回傳代理類的函式工廠
*/
private static final class ProxyClassFactory
implements BiFunction<ClassLoader, Class<?>[], Class<?>>
{
// 所有代理類名稱的前綴(有時候debug不是會經常看到這個名稱嗎哈哈)
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 loader根據類的名稱 決議出來的 class跟我們傳進來的是否一樣(相當于看下是不是同一個loader加載的吧)
*/
Class<?> interfaceClass = null;
try {
interfaceClass = Class.forName(intf.getName(), false, loader);
} catch (ClassNotFoundException e) {
}
// 如果不一樣,拋例外(loader說我不認識這個介面class)
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());
}
}
String proxyPkg = null; // package to define proxy class in
int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
/*
* 這下面一大段就是確定下代理類要放在哪個包下
* 如果存在非public的介面,那么proxy class就要放在跟她同一個目錄下
* 而且非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) {
proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
}
/*
* 用原子數字自增產生的一個代理類的唯一的代號
*/
long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;
/*
* 上面啪啦啪啦一大堆,其實都是一些驗證啊,確定包的位置啊,名稱啊的細碎的東西
* 下面這一句才是重點,通過ProxyGenerator產生了代理類的 class 檔案的位元組陣列
*/
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);
try {
// 最后通過native方法 來生成Class 物件
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
} catch (ClassFormatError e) {
throw new IllegalArgumentException(e.toString());
}
}
}
ProxyGenerator 是sun.misc包里面的方法,沒有開源,所以我們簡單擼一下即可
public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
// 生成class檔案的位元組陣列
final byte[] var4 = var3.generateClassFile();
// 如果saveGeneratedFiles為true,那么將.class檔案寫到硬碟中
if (saveGeneratedFiles) {
// 省略具體保存檔案方法
}
return var4;
}
看下這個保存檔案的條件
private static final boolean saveGeneratedFiles = ((Boolean)AccessController.doPrivileged(new GetBooleanAction("sun.misc.ProxyGenerator.saveGeneratedFiles"))).booleanValue();
也就是說只要我們設定了這個"sun.misc.ProxyGenerator.saveGeneratedFiles" 系統值為true就可以保存檔案了
話不多說來看看jdk動態代理給我們自動生成的這個class檔案長什么樣吧,用以下代碼來測驗
package com.test.demo.proxy;
import sun.misc.ProxyGenerator;
import java.io.FileOutputStream;
import java.io.IOException;
/**
* 寫代理類檔案到磁盤中
*
* @author lizhecao 2018/4/20
* @version 1.0
*/
public class ProxyClassGen {
public static void main(String[] args) throws IOException {
// // 第一種方法,直接將生成的位元組陣列寫到檔案中
// byte[] bytes = ProxyGenerator.generateProxyClass("$Proxy33", UserImpl.class.getInterfaces());
//
// try(FileOutputStream outputStream = new FileOutputStream(
// "/Users/lizhecao/java/demo/src/main/java/com/test/demo/proxy/$Proxy33.class")) {
// outputStream.write(bytes);
// }
// 第二種方法,設定系統屬性值,有jdk自動寫
System.setProperty("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
ProxyGenerator.generateProxyClass("$Proxy34", UserImpl.class.getInterfaces());
}
}
運行之后可以看到在專案的根目錄下產生了$Proxy34.class 這么一個檔案,用ide直接打開可以看到如下內容
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
import com.test.demo.proxy.User;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
public final class $Proxy34 extends Proxy implements User {
private static Method m1;
private static Method m3;
private static Method m2;
private static Method m0;
public $Proxy34(InvocationHandler var1) throws {
super(var1);
}
// 除了介面方法之外,還實作了Object的equals, hashCode和toString方法
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);
}
}
// 實作了我們的User介面的sayHello方法
public final void sayHello() throws {
try {
// 內部其實就是呼叫了invokeHandler實體的invoke方法
// 在最下面可以看到m3 就是通過反射獲取的User介面的sayHello Method
// Class.forName("com.test.demo.proxy.User").getMethod("sayHello");
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)).intValue();
} 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.test.demo.proxy.User").getMethod("sayHello");
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());
}
}
}
到了這里,jdk動態代理就已經是撥開云霧見青天,一清二楚了
感謝以下的博主分享:
JDK動態代理實作原理
本文由博客群發一文多發等運營工具平臺 OpenWrite 發布
轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/260480.html
標籤:其他
