JDK動態代理實現原理
之前雖然會用JDK的動態代理,但是有些問題卻一直沒有搞明白。比如說:InvocationHandler的invoke方法是由誰來呼叫的,代理物件是怎麼生成的,直到前幾個星期才把這些問題全部搞明白了。 廢話不多說了,先來看一下JDK的動態是怎麼用的。 Java程式碼
package dynamic.proxy; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Method; import java.lang.reflect.Proxy; /** * 實現自己的InvocationHandler * @author zyb * @since 2012-8-9 * */ public class MyInvocationHandler implements InvocationHandler { // 目標物件 private Object target; /** * 構造方法 * @param target 目標物件 */ public MyInvocationHandler(Object target) { super(); this.target = target; } /** * 執行目標物件的方法 */ public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { // 在目標物件的方法執行之前簡單的列印一下 System.out.println("------------------before------------------"); // 執行目標物件的方法 Object result = method.invoke(target, args); // 在目標物件的方法執行之後簡單的列印一下 System.out.println("-------------------after------------------"); return result; } /** * 獲取目標物件的代理物件 * @return 代理物件 */ public Object getProxy() { return Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(), target.getClass().getInterfaces(), this); } } package dynamic.proxy; /** * 目標物件實現的介面,用JDK來生成代理物件一定要實現一個介面 * @author zyb * @since 2012-8-9 * */ public interface UserService { /** * 目標方法 */ public abstract void add(); } package dynamic.proxy; /** * 目標物件 * @author zyb * @since 2012-8-9 * */ public class UserServiceImpl implements UserService { /* (non-Javadoc) * @see dynamic.proxy.UserService#add() */ public void add() { System.out.println("--------------------add---------------"); } } package dynamic.proxy; import org.junit.Test; /** * 動態代理測試類 * @author zyb * @since 2012-8-9 * */ public class ProxyTest { @Test public void testProxy() throws Throwable { // 例項化目標物件 UserService userService = new UserServiceImpl(); // 例項化InvocationHandler MyInvocationHandler invocationHandler = new MyInvocationHandler(userService); // 根據目標物件生成代理物件 UserService proxy = (UserService) invocationHandler.getProxy(); // 呼叫代理物件的方法 proxy.add(); } }
執行結果如下: ------------------before------------------ --------------------add--------------- -------------------after------------------ 用起來是很簡單吧,其實這裡基本上就是AOP的一個簡單實現了,在目標物件的方法執行之前和執行之後進行了增強。Spring的AOP實現其實也是用了Proxy和InvocationHandler這兩個東西的。 用起來是比較簡單,但是如果能知道它背後做了些什麼手腳,那就更好不過了。首先來看一下JDK是怎樣生成代理物件的。既然生成代理物件是用的Proxy類的靜態方newProxyInstance,那麼我們就去它的原始碼裡看一下它到底都做了些什麼?
我們再進去getProxyClass方法看一下
Java程式碼
/** * loader:類載入器 * interfaces:目標物件實現的介面 * h:InvocationHandler的實現類 */ public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h) throws IllegalArgumentException { if (h == null) { throw new NullPointerException(); } /* * Look up or generate the designated proxy class. */ Class cl = getProxyClass(loader, interfaces); /* * Invoke its constructor with the designated invocation handler. */ try { // 呼叫代理物件的構造方法(也就是$Proxy0(InvocationHandler h)) Constructor cons = cl.getConstructor(constructorParams); // 生成代理類的例項並把MyInvocationHandler的例項傳給它的構造方法 return (Object) cons.newInstance(new Object[] { h }); } catch (NoSuchMethodException e) { throw new InternalError(e.toString()); } catch (IllegalAccessException e) { throw new InternalError(e.toString()); } catch (InstantiationException e) { throw new InternalError(e.toString()); } catch (InvocationTargetException e) { throw new InternalError(e.toString()); } }
我們再進去getProxyClass方法看一下
Java程式碼
public static Class<?> getProxyClass(ClassLoader loader,
Class<?>... interfaces)
throws IllegalArgumentException
{
// 如果目標類實現的介面數大於65535個則丟擲異常(我XX,誰會寫這麼NB的程式碼啊?)
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
// 宣告代理物件所代表的Class物件(有點拗口)
Class proxyClass = null;
String[] interfaceNames = new String[interfaces.length];
Set interfaceSet = new HashSet(); // for detecting duplicates
// 遍歷目標類所實現的介面
for (int i = 0; i < interfaces.length; i++) {
// 拿到目標類實現的介面的名稱
String interfaceName = interfaces[i].getName();
Class interfaceClass = null;
try {
// 載入目標類實現的介面到記憶體中
interfaceClass = Class.forName(interfaceName, false, loader);
} catch (ClassNotFoundException e) {
}
if (interfaceClass != interfaces[i]) {
throw new IllegalArgumentException(
interfaces[i] + " is not visible from class loader");
}
// 中間省略了一些無關緊要的程式碼 .......
// 把目標類實現的介面代表的Class物件放到Set中
interfaceSet.add(interfaceClass);
interfaceNames[i] = interfaceName;
}
// 把目標類實現的介面名稱作為快取(Map)中的key
Object key = Arrays.asList(interfaceNames);
Map cache;
synchronized (loaderToCache) {
// 從快取中獲取cache
cache = (Map) loaderToCache.get(loader);
if (cache == null) {
// 如果獲取不到,則新建地個HashMap例項
cache = new HashMap();
// 把HashMap例項和當前載入器放到快取中
loaderToCache.put(loader, cache);
}
}
synchronized (cache) {
do {
// 根據介面的名稱從快取中獲取物件
Object value = cache.get(key);
if (value instanceof Reference) {
proxyClass = (Class) ((Reference) value).get();
}
if (proxyClass != null) {
// 如果代理物件的Class例項已經存在,則直接返回
return proxyClass;
} else if (value == pendingGenerationMarker) {
try {
cache.wait();
} catch (InterruptedException e) {
}
continue;
} else {
cache.put(key, pendingGenerationMarker);
break;
}
} while (true);
}
try {
// 中間省略了一些程式碼 .......
// 這裡就是動態生成代理物件的最關鍵的地方
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces);
try {
// 根據代理類的位元組碼生成代理類的例項
proxyClass = defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
} catch (ClassFormatError e) {
throw new IllegalArgumentException(e.toString());
}
}
// add to set of all generated proxy classes, for isProxyClass
proxyClasses.put(proxyClass, null);
}
// 中間省略了一些程式碼 .......
return proxyClass;
}
進去ProxyGenerator類的靜態方法generateProxyClass,這裡是真正生成代理類class位元組碼的地方。
Java程式碼
public static byte[] generateProxyClass(final String name,
Class[] interfaces)
{
ProxyGenerator gen = new ProxyGenerator(name, interfaces);
// 這裡動態生成代理類的位元組碼,由於比較複雜就不進去看了
final byte[] classFile = gen.generateClassFile();
// 如果saveGeneratedFiles的值為true,則會把所生成的代理類的位元組碼儲存到硬碟上
if (saveGeneratedFiles) {
java.security.AccessController.doPrivileged(
new java.security.PrivilegedAction<Void>() {
public Void run() {
try {
FileOutputStream file =
new FileOutputStream(dotToSlash(name) + ".class");
file.write(classFile);
file.close();
return null;
} catch (IOException e) {
throw new InternalError(
"I/O exception saving generated file: " + e);
}
}
});
}
// 返回代理類的位元組碼
return classFile;
}
現在,JDK是怎樣動態生成代理類的位元組的原理已經一目瞭然了。 好了,再來解決另外一個問題,那就是由誰來呼叫InvocationHandler的invoke方法的。要解決這個問題就要看一下JDK到底為我們生成了一個什麼東西。用以下程式碼可以獲取到JDK為我們生成的位元組碼並寫到硬碟中。
Java程式碼
package dynamic.proxy;
import java.io.FileOutputStream;
import java.io.IOException;
import sun.misc.ProxyGenerator;
/**
* 代理類的生成工具
* @author zyb
* @since 2012-8-9
*/
public class ProxyGeneratorUtils {
/**
* 把代理類的位元組碼寫到硬碟上
* @param path 儲存路徑
*/
public static void writeProxyClassToHardDisk(String path) {
// 第一種方法,這種方式在剛才分析ProxyGenerator時已經知道了
// System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", true);
// 第二種方法
// 獲取代理類的位元組碼
byte[] classFile = ProxyGenerator.generateProxyClass("$Proxy11", UserServiceImpl.class.getInterfaces());
FileOutputStream out = null;
try {
out = new FileOutputStream(path);
out.write(classFile);
out.flush();
} catch (Exception e) {
e.printStackTrace();
} finally {
try {
out.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
package dynamic.proxy;
import org.junit.Test;
/**
* 動態代理測試類
* @author zyb
* @since 2012-8-9
*
*/
public class ProxyTest {
@Test
public void testProxy() throws Throwable {
// 例項化目標物件
UserService userService = new UserServiceImpl();
// 例項化InvocationHandler
MyInvocationHandler invocationHandler = new MyInvocationHandler(userService);
// 根據目標物件生成代理物件
UserService proxy = (UserService) invocationHandler.getProxy();
// 呼叫代理物件的方法
proxy.add();
}
@Test
public void testGenerateProxyClass() {
ProxyGeneratorUtils.writeProxyClassToHardDisk("F:/$Proxy11.class");
}
}
通過以上程式碼,就可以在F盤上生成一個$Proxy.class檔案了,現在用反編譯工具來看一下這個class檔案裡面的內容。
Java程式碼
// Decompiled by DJ v3.11.11.95 Copyright 2009 Atanas Neshkov Date: 2012/8/9 20:11:32
// Home Page: http://members.fortunecity.com/neshkov/dj.html http://www.neshkov.com/dj.html - Check often for new version!
// Decompiler options: packimports(3)
import dynamic.proxy.UserService;
import java.lang.reflect.*;
public final class $Proxy11 extends Proxy
implements UserService
{
// 構造方法,引數就是剛才傳過來的MyInvocationHandler類的例項
public $Proxy11(InvocationHandler invocationhandler)
{
super(invocationhandler);
}
public final boolean equals(Object obj)
{
try
{
return ((Boolean)super.h.invoke(this, m1, new Object[] {
obj
})).booleanValue();
}
catch(Error _ex) { }
catch(Throwable throwable)
{
throw new UndeclaredThrowableException(throwable);
}
}
/**
* 這個方法是關鍵部分
*/
public final void add()
{
try
{
// 實際上就是呼叫MyInvocationHandler的public Object invoke(Object proxy, Method method, Object[] args)方法,第二個問題就解決了
super.h.invoke(this, m3, null);
return;
}
catch(Error _ex) { }
catch(Throwable throwable)
{
throw new UndeclaredThrowableException(throwable);
}
}
public final int hashCode()
{
try
{
return ((Integer)super.h.invoke(this, m0, null)).intValue();
}
catch(Error _ex) { }
catch(Throwable throwable)
{
throw new UndeclaredThrowableException(throwable);
}
}
public final String toString()
{
try
{
return (String)super.h.invoke(this, m2, null);
}
catch(Error _ex) { }
catch(Throwable throwable)
{
throw new UndeclaredThrowableException(throwable);
}
}
private static Method m1;
private static Method m3;
private static Method m0;
private static Method m2;
// 在靜態程式碼塊中獲取了4個方法:Object中的equals方法、UserService中的add方法、Object中的hashCode方法、Object中toString方法
static
{
try
{
m1 = Class.forName("java.lang.Object").getMethod("equals", new Class[] {
Class.forName("java.lang.Object")
});
m3 = Class.forName("dynamic.proxy.UserService").getMethod("add", new Class[0]);
m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);
m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);
}
catch(NoSuchMethodException nosuchmethodexception)
{
throw new NoSuchMethodError(nosuchmethodexception.getMessage());
}
catch(ClassNotFoundException classnotfoundexception)
{
throw new NoClassDefFoundError(classnotfoundexception.getMessage());
}
}
}
好了,到目前為止,前面 的兩個問題都已經知道回事了,現在再用JDK動態代理的時候就不只會用而已了,真正的達到了“知其然,知其所以然”的目的。