java的动态代理原理

之前虽然会用JDK的动态代理，但是有些问题却一直没有搞明白。比如说：InvocationHandler的invoke方法是由谁来调用的，代理对象是怎么生成的，直到前几个星期才把这些问题全部搞明白了。 
    废话不多说了，先来看一下JDK的动态是怎么用的。

1. package dynamic.proxy;
2. import java.lang.reflect.InvocationHandler;
3. import java.lang.reflect.Method;
4. import java.lang.reflect.Proxy;
5. /**
6. * 实现自己的InvocationHandler
7. * @author zyb
8. * @since 2012-8-9
9. *
10. */
11. public class MyInvocationHandler implements InvocationHandler {
12. // 目标对象
13. private Object target;
14. /**
15. * 构造方法
16. * @param target 目标对象
17. */
18. public MyInvocationHandler(Object target) {
19. super();
20. this.target = target;
21. }
22. /**
23. * 执行目标对象的方法
24. */
25. public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
26. // 在目标对象的方法执行之前简单的打印一下
27. System.out.println("------------------before------------------");
28. // 执行目标对象的方法
29. Object result = method.invoke(target, args);
30. // 在目标对象的方法执行之后简单的打印一下
31. System.out.println("-------------------after------------------");
32. return result;
33. }
34. /**
35. * 获取目标对象的代理对象
36. * @return 代理对象
37. */
38. public Object getProxy() {
39. return Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(),
40. target.getClass().getInterfaces(), this);
41. }
42. }
43. package dynamic.proxy;
44. /**
45. * 目标对象实现的接口，用JDK来生成代理对象一定要实现一个接口
46. * @author zyb
47. * @since 2012-8-9
48. *
49. */
50. public interface UserService {
51. /**
52. * 目标方法
53. */
54. public abstract void add();
55. }
56. package dynamic.proxy;
57. /**
58. * 目标对象
59. * @author zyb
60. * @since 2012-8-9
61. *
62. */
63. public class UserServiceImpl implements UserService {
64. /* (non-Javadoc)
65. * @see dynamic.proxy.UserService#add()
66. */
67. public void add() {
68. System.out.println("--------------------add---------------");
69. }
70. }
71. package dynamic.proxy;
72. import org.junit.Test;
73. /**
74. * 动态代理测试类
75. * @author zyb
76. * @since 2012-8-9
77. *
78. */
79. public class ProxyTest {
80. @Test
81. public void testProxy() throws Throwable {
82. // 实例化目标对象
83. UserService userService = new UserServiceImpl();
84. // 实例化InvocationHandler
85. MyInvocationHandler invocationHandler = new MyInvocationHandler(userService);
86. // 根据目标对象生成代理对象
87. UserService proxy = (UserService) invocationHandler.getProxy();
88. // 调用代理对象的方法
89. proxy.add();
90. }
91. }

执行结果如下： 
------------------before------------------ 
--------------------add--------------- 
-------------------after------------------

用起来是很简单吧，其实这里基本上就是AOP的一个简单实现了，在目标对象的方法执行之前和执行之后进行了增强。Spring的AOP实现其实也是用了Proxy和InvocationHandler这两个东西的。

用起来是比较简单，但是如果能知道它背后做了些什么手脚，那就更好不过了。首先来看一下JDK是怎样生成代理对象的。既然生成代理对象是用的Proxy类的静态方newProxyInstance，那么我们就去它的源码里看一下它到底都做了些什么？

1. /**
2. * loader:类加载器
3. * interfaces:目标对象实现的接口
4. * h:InvocationHandler的实现类
5. */
6. public static Object newProxyInstance(ClassLoader loader,
7. Class<?>[] interfaces,
8. InvocationHandler h)
9. throws IllegalArgumentException
10. {
11. if (h == null) {
12. throw new NullPointerException();
13. }
14. /*
15. * Look up or generate the designated proxy class.
16. */
17. Class cl = getProxyClass(loader, interfaces);
18. /*
19. * Invoke its constructor with the designated invocation handler.
20. */
21. try {
22. // 调用代理对象的构造方法（也就是$Proxy0(InvocationHandler h)）
23. Constructor cons = cl.getConstructor(constructorParams);
24. // 生成代理类的实例并把MyInvocationHandler的实例传给它的构造方法
25. return (Object) cons.newInstance(new Object[] { h });
26. } catch (NoSuchMethodException e) {
27. throw new InternalError(e.toString());
28. } catch (IllegalAccessException e) {
29. throw new InternalError(e.toString());
30. } catch (InstantiationException e) {
31. throw new InternalError(e.toString());
32. } catch (InvocationTargetException e) {
33. throw new InternalError(e.toString());
34. }
35. }

我们再进去getProxyClass方法看一下

1. public static Class<?> getProxyClass(ClassLoader loader,
2. Class<?>... interfaces)
3. throws IllegalArgumentException
4. {
5. // 如果目标类实现的接口数大于65535个则抛出异常（我XX，谁会写这么NB的代码啊？）
6. if (interfaces.length > 65535) {
7. throw new IllegalArgumentException("interface limit exceeded");
8. }
9. // 声明代理对象所代表的Class对象（有点拗口）
10. Class proxyClass = null;
11. String[] interfaceNames = new String[interfaces.length];
12. Set interfaceSet = new HashSet();   // for detecting duplicates
13. // 遍历目标类所实现的接口
14. for (int i = 0; i < interfaces.length; i++) {
15. // 拿到目标类实现的接口的名称
16. String interfaceName = interfaces[i].getName();
17. Class interfaceClass = null;
18. try {
19. // 加载目标类实现的接口到内存中
20. interfaceClass = Class.forName(interfaceName, false, loader);
21. } catch (ClassNotFoundException e) {
22. }
23. if (interfaceClass != interfaces[i]) {
24. throw new IllegalArgumentException(
25. interfaces[i] + " is not visible from class loader");
26. }
27. // 中间省略了一些无关紧要的代码 .......
28. // 把目标类实现的接口代表的Class对象放到Set中
29. interfaceSet.add(interfaceClass);
30. interfaceNames[i] = interfaceName;
31. }
32. // 把目标类实现的接口名称作为缓存（Map）中的key
33. Object key = Arrays.asList(interfaceNames);
34. Map cache;
35. synchronized (loaderToCache) {
36. // 从缓存中获取cache
37. cache = (Map) loaderToCache.get(loader);
38. if (cache == null) {
39. // 如果获取不到，则新建地个HashMap实例
40. cache = new HashMap();
41. // 把HashMap实例和当前加载器放到缓存中
42. loaderToCache.put(loader, cache);
43. }
44. }
45. synchronized (cache) {
46. do {
47. // 根据接口的名称从缓存中获取对象
48. Object value = cache.get(key);
49. if (value instanceof Reference) {
50. proxyClass = (Class) ((Reference) value).get();
51. }
52. if (proxyClass != null) {
53. // 如果代理对象的Class实例已经存在，则直接返回
54. return proxyClass;
55. } else if (value == pendingGenerationMarker) {
56. try {
57. cache.wait();
58. } catch (InterruptedException e) {
59. }
60. continue;
61. } else {
62. cache.put(key, pendingGenerationMarker);
63. break;
64. }
65. } while (true);
66. }
67. try {
68. // 中间省略了一些代码 .......
69. // 这里就是动态生成代理对象的最关键的地方
70. byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
71. proxyName, interfaces);
72. try {
73. // 根据代理类的字节码生成代理类的实例
74. proxyClass = defineClass0(loader, proxyName,
75. proxyClassFile, 0, proxyClassFile.length);
76. } catch (ClassFormatError e) {
77. throw new IllegalArgumentException(e.toString());
78. }
79. }
80. // add to set of all generated proxy classes, for isProxyClass
81. proxyClasses.put(proxyClass, null);
82. }
83. // 中间省略了一些代码 .......
84. return proxyClass;
85. }

进去ProxyGenerator类的静态方法generateProxyClass，这里是真正生成代理类class字节码的地方。

1. public static byte[] generateProxyClass(final String name,
2. Class[] interfaces)
3. {
4. ProxyGenerator gen = new ProxyGenerator(name, interfaces);
5. // 这里动态生成代理类的字节码，由于比较复杂就不进去看了
6. final byte[] classFile = gen.generateClassFile();
7. // 如果saveGeneratedFiles的值为true，则会把所生成的代理类的字节码保存到硬盘上
8. if (saveGeneratedFiles) {
9. java.security.AccessController.doPrivileged(
10. new java.security.PrivilegedAction<Void>() {
11. public Void run() {
12. try {
13. FileOutputStream file =
14. new FileOutputStream(dotToSlash(name) + ".class");
15. file.write(classFile);
16. file.close();
17. return null;
18. } catch (IOException e) {
19. throw new InternalError(
20. "I/O exception saving generated file: " + e);
21. }
22. }
23. });
24. }
25. // 返回代理类的字节码
26. return classFile;
27. }

现在，JDK是怎样动态生成代理类的字节的原理已经一目了然了。

好了，再来解决另外一个问题，那就是由谁来调用InvocationHandler的invoke方法的。要解决这个问题就要看一下JDK到底为我们生成了一个什么东西。用以下代码可以获取到JDK为我们生成的字节码并写到硬盘中。

1. package dynamic.proxy;
2. import java.io.FileOutputStream;
3. import java.io.IOException;
4. import sun.misc.ProxyGenerator;
5. /**
6. * 代理类的生成工具
7. * @author zyb
8. * @since 2012-8-9
9. */
10. public class ProxyGeneratorUtils {
11. /**
12. * 把代理类的字节码写到硬盘上
13. * @param path 保存路径
14. */
15. public static void writeProxyClassToHardDisk(String path) {
16. // 第一种方法，这种方式在刚才分析ProxyGenerator时已经知道了
17. // System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", true);
18. // 第二种方法
19. // 获取代理类的字节码
20. byte[] classFile = ProxyGenerator.generateProxyClass("$Proxy11", UserServiceImpl.class.getInterfaces());
21. FileOutputStream out = null;
22. try {
23. out = new FileOutputStream(path);
24. out.write(classFile);
25. out.flush();
26. } catch (Exception e) {
27. e.printStackTrace();
28. } finally {
29. try {
30. out.close();
31. } catch (IOException e) {
32. e.printStackTrace();
33. }
34. }
35. }
36. }
37. package dynamic.proxy;
38. import org.junit.Test;
39. /**
40. * 动态代理测试类
41. * @author zyb
42. * @since 2012-8-9
43. *
44. */
45. public class ProxyTest {
46. @Test
47. public void testProxy() throws Throwable {
48. // 实例化目标对象
49. UserService userService = new UserServiceImpl();
50. // 实例化InvocationHandler
51. MyInvocationHandler invocationHandler = new MyInvocationHandler(userService);
52. // 根据目标对象生成代理对象
53. UserService proxy = (UserService) invocationHandler.getProxy();
54. // 调用代理对象的方法
55. proxy.add();
56. }
57. @Test
58. public void testGenerateProxyClass() {
59. ProxyGeneratorUtils.writeProxyClassToHardDisk("F:/$Proxy11.class");
60. }
61. }

通过以上代码，就可以在F盘上生成一个$Proxy.class文件了，现在用反编译工具来看一下这个class文件里面的内容。

1. // Decompiled by DJ v3.11.11.95 Copyright 2009 Atanas Neshkov  Date: 2012/8/9 20:11:32
2. // Home Page: http://members.fortunecity.com/neshkov/dj.html  http://www.neshkov.com/dj.html - Check often for new version!
3. // Decompiler options: packimports(3)
4. import dynamic.proxy.UserService;
5. import java.lang.reflect.*;
6. public final class $Proxy11 extends Proxy
7. implements UserService
8. {
9. // 构造方法，参数就是刚才传过来的MyInvocationHandler类的实例
10. public $Proxy11(InvocationHandler invocationhandler)
11. {
12. super(invocationhandler);
13. }
14. public final boolean equals(Object obj)
15. {
16. try
17. {
18. return ((Boolean)super.h.invoke(this, m1, new Object[] {
19. obj
20. })).booleanValue();
21. }
22. catch(Error _ex) { }
23. catch(Throwable throwable)
24. {
25. throw new UndeclaredThrowableException(throwable);
26. }
27. }
28. /**
29. * 这个方法是关键部分
30. */
31. public final void add()
32. {
33. try
34. {
35. // 实际上就是调用MyInvocationHandler的public Object invoke(Object proxy, Method method, Object[] args)方法，第二个问题就解决了
36. super.h.invoke(this, m3, null);
37. return;
38. }
39. catch(Error _ex) { }
40. catch(Throwable throwable)
41. {
42. throw new UndeclaredThrowableException(throwable);
43. }
44. }
45. public final int hashCode()
46. {
47. try
48. {
49. return ((Integer)super.h.invoke(this, m0, null)).intValue();
50. }
51. catch(Error _ex) { }
52. catch(Throwable throwable)
53. {
54. throw new UndeclaredThrowableException(throwable);
55. }
56. }
57. public final String toString()
58. {
59. try
60. {
61. return (String)super.h.invoke(this, m2, null);
62. }
63. catch(Error _ex) { }
64. catch(Throwable throwable)
65. {
66. throw new UndeclaredThrowableException(throwable);
67. }
68. }
69. private static Method m1;
70. private static Method m3;
71. private static Method m0;
72. private static Method m2;
73. // 在静态代码块中获取了4个方法：Object中的equals方法、UserService中的add方法、Object中的hashCode方法、Object中toString方法
74. static
75. {
76. try
77. {
78. m1 = Class.forName("java.lang.Object").getMethod("equals", new Class[] {
79. Class.forName("java.lang.Object")
80. });
81. m3 = Class.forName("dynamic.proxy.UserService").getMethod("add", new Class[0]);
82. m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);
83. m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);
84. }
85. catch(NoSuchMethodException nosuchmethodexception)
86. {
87. throw new NoSuchMethodError(nosuchmethodexception.getMessage());
88. }
89. catch(ClassNotFoundException classnotfoundexception)
90. {
91. throw new NoClassDefFoundError(classnotfoundexception.getMessage());
92. }
93. }
94. }