一、前言上篇文章《Java设计模式代理模式》中介绍了两种代理模式静态代理和动态代理的应用场景和实际应用案例。本篇文章中对动态代理的原理做进行深入的分析。二、动态代理的核心疑问关于动态代理初看可能会比较费解大概有如下几个疑问代理是怎么形成的代理类在哪里TimeHandler类是做什么用的在哪里被调用了客户端调用的时候写的是调用m.move();程序是如何执行到了TimeHandler对象的invoke方法中了呢这篇文章主要针对如上几个疑问进行展开。三、动态代理的基本概念首先声明一点案例中的TimeHandler并不是代理类而是代理依赖的一个类而已。真正的代理类是JDK直接生成的字节码并进行加载的所以对用户是不可见的。生成代理类的代码是这个Moveable m (Moveable) Proxy.newProxyInstance(cls.getClassLoader(),cls.getInterfaces(), h);这里向newProxyInstance传递了三个参数分别是原始类的加载器原始类实现的接口MoveableTimeHandler类的对象。四、Proxy.newProxyInstance源码分析Proxy.newProxyInstance是动态代理的核心入口方法其源码实现如下public static Object newProxyInstance(ClassLoader loader, Class?[] interfaces, InvocationHandler h) { Objects.requireNonNull(h); final Class? caller System.getSecurityManager() null ? null : Reflection.getCallerClass(); /* * Look up or generate the designated proxy class and its constructor. */ Constructor? cons getProxyConstructor(caller, loader, interfaces); return newProxyInstance(caller, cons, h); }newProxyInstance的代码实现比较清晰主要流程如下检查InvocationHandler参数不能为 null获取调用者类用于安全检查通过getProxyConstructor方法获取代理类的构造方法调用另一个重载的newProxyInstance方法创建代理实例4.1 getProxyConstructor方法解析getProxyConstructor方法负责获取或生成代理类的构造方法private static Constructor? getProxyConstructor(Class? caller, ClassLoader loader, Class?... interfaces) { // optimization for single interface if (interfaces.length 1) { Class? intf interfaces[0]; if (caller ! null) { checkProxyAccess(caller, loader, intf); } return proxyCache.sub(intf).computeIfAbsent( loader, (ld, clv) - new ProxyBuilder(ld, clv.key()).build() ); } else { // interfaces cloned final Class?[] intfsArray interfaces.clone(); if (caller ! null) { checkProxyAccess(caller, loader, intfsArray); } final ListClass? intfs Arrays.asList(intfsArray); return proxyCache.sub(intfs).computeIfAbsent( loader, (ld, clv) - new ProxyBuilder(ld, clv.key()).build() ); } }在getProxyConstructor函数中可以看到 if-else 分支这里是对单接口的情况做了代码优化。我们主要关注其代理类的生成部分就是new ProxyBuilder(ld, clv.key()).build()。(ld, clv) - new ProxyBuilder(ld, clv.key()).build()这种写法是 lambda 表达式的语法非常精简。4.2 ProxyBuilder.build方法分析Constructor? build() { Class? proxyClass defineProxyClass(module, interfaces); final Constructor? cons; try { cons proxyClass.getConstructor(constructorParams); } catch (NoSuchMethodException e) { throw new InternalError(e.toString(), e); } AccessController.doPrivileged(new PrivilegedActionVoid() { public Void run() { cons.setAccessible(true); return null; } }); return cons; }在build方法中从语义上可以看到代理类proxyClass在defineProxyClass方法中生成。之后通过反射并根据构造函数的参数获取到代理类的构造方法并返回。这里的参数为private static final Class?[] constructorParams { InvocationHandler.class };。所以看到这里应该明白了TimeHandler的作用了就是作为代理类的构造方法的一个参数也就是代理类依赖的对象。到这里也就找到了文章开始处提出的问题二的答案。这里可以猜测一下代理类中的对应接口的方法应该是调用的TimeHandler类的invoke方法通过控制invoke的参数来调用不同的方法。4.3 defineProxyClass方法解析在defineProxyClass方法中最关键的代码如下byte[] proxyClassFile ProxyGenerator.generateProxyClass( proxyName, interfaces.toArray(EMPTY_CLASS_ARRAY), accessFlags); try { Class? pc UNSAFE.defineClass(proxyName, proxyClassFile, 0, proxyClassFile.length, loader, null); reverseProxyCache.sub(pc).putIfAbsent(loader, Boolean.TRUE); return pc; } 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()); }这里先生成字节码之后将其加载到内存中。4.4 ProxyGenerator.generateProxyClass方法static byte[] generateProxyClass(final String name, Class?[] interfaces, int accessFlags) { ProxyGenerator gen new ProxyGenerator(name, interfaces, accessFlags); final byte[] classFile gen.generateClassFile(); if (saveGeneratedFiles) { java.security.AccessController.doPrivileged( new java.security.PrivilegedActionVoid() { public Void run() { try { int i name.lastIndexOf(.); Path path; if (i 0) { Path dir Paths.get(name.substring(0, i).replace(., File.separatorChar)); Files.createDirectories(dir); path dir.resolve(name.substring(i1, name.length()) .class); } else { path Paths.get(name .class); } Files.write(path, classFile); return null; } catch (IOException e) { throw new InternalError( I/O exception saving generated file: e); } } }); } return classFile; }在generateProxyClass方法中先生成了ProxyGenerator对象然后调用对象的generateClassFile生成字节码。可以看到其中有个saveGeneratedFiles的标志位表示是否需要保存生成的字节码文件。在generateClassFile方法中创建了ProxyMethod字段表和方法表集合并将内容按照字节码的规范写入到流中。至此代理类就生成了文章开始处的问题一就回答完毕了。此处代码中可以根据语义看到会使用InvocationHandler的方法目前对 Java 的 class 文件的格式还不够了解有机会研究一下。4.5 保存生成的代理类文件刚刚说到代码中是存在打印生成的代理类的逻辑的就是saveGeneratedFiles标志位在该变量定义处可以看到private static final boolean saveGeneratedFiles java.security.AccessController.doPrivileged( new GetBooleanAction( jdk.proxy.ProxyGenerator.saveGeneratedFiles)).booleanValue();表示该变量是由jdk.proxy.ProxyGenerator.saveGeneratedFiles控制的。所以我们在代码中只需要指定这个值为 true 就可以了代码如下import java.lang.reflect.InvocationHandler; import java.lang.reflect.Proxy; public class Test { public static void main(String[] args) throws Exception{ System.setProperty(jdk.proxy.ProxyGenerator.saveGeneratedFiles, true); Car car new Car(); Class? cls car.getClass(); InvocationHandler h new TimeHandler(car); Moveable m (Moveable) Proxy.newProxyInstance(cls.getClassLoader(),cls.getInterfaces(), h); m.move(); System.out.println(); m.move_back(); System.out.println();System.out.println(); } }运行之后就可以在工程目录下找到对应的代理类的 class 文件啦。使用 IDEA 打开可以看到对应的 Java 代码如下4.6 生成的代理类源码分析// // Source code recreated from a .class file by IntelliJ IDEA // (powered by Fernflower decompiler) // package com.sun.proxy; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Method; import java.lang.reflect.Proxy; import java.lang.reflect.UndeclaredThrowableException; public final class $Proxy0 extends Proxy implements Moveable { private static Method m1; private static Method m3; private static Method m2; private static Method m4; private static Method m0; 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}); } catch (RuntimeException | Error var3) { throw var3; } catch (Throwable var4) { throw new UndeclaredThrowableException(var4); } } public final void move() throws Exception { try { super.h.invoke(this, m3, (Object[])null); } catch (Exception | 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 void move_back() throws Exception { try { super.h.invoke(this, m4, (Object[])null); } catch (Exception | 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); } 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(Moveable).getMethod(move); m2 Class.forName(java.lang.Object).getMethod(toString); m4 Class.forName(Moveable).getMethod(move_back); m0 Class.forName(java.lang.Object).getMethod(hashCode); } catch (NoSuchMethodException var2) { throw new NoSuchMethodError(var2.getMessage()); } catch (ClassNotFoundException var3) { throw new NoClassDefFoundError(var3.getMessage()); } } }4.7 代理类解读与总结代理类解读代理类的构造方法接收一个InvocationHandler对象调用父类Proxy的初始化方法使用该对象为依赖h的对象赋值。以move方法为例我们可以看到代理类实现了Moveable接口在move方法的实现中调用了InvocationHandler对象的invoke方法并且其中第二个参数为m3对象。而m3对象是静态块中通过反射获取到的Moveable接口的move方法。所以此处就回答的文章开始处的问题三。到这里动态代理的原理就非常清晰了代理类是 JDK 直接以字节码的形式生成出来的继承Proxy类实现客户端定义的接口。因为Proxy依赖InvocationHandler实现类所以代理类也同样依赖。对于接口中定义的函数move代理类中也会实现其逻辑是调用InvocationHandler类中的invoke方法并将方法move方法作为invoke的一个参数。在invoke方法中可以进行功能扩展进而执行invoke参数中的方法完成对原始对象的move方法的调用。不得不佩服 Java 源码的作者们的深厚功力能够设计出如此高扩展的结构自己需要学习和实践的还有很多。参考文章看了这篇文章非常不错转载[Java] 动态代理的实现原理 - 简书
