JDK动态代理[2]----JDK动态代理的底层实现之Proxy源码分析
在上一篇里为大家简单介绍了什么是代理模式?为什么要使用代理模式?并用例子演示了一下静态代理和动态代理的实现,分析了静态代理和动态代理各自的优缺点。在这一篇中笔者打算深入源码为大家剖析JDK动态代理实现的机制,建议读者阅读本篇前可先阅读一下笔者上一篇关于代理模式的介绍《JDK动态代理[1]----代理模式实现方式的概要介绍》
上一篇动态代理的测试类中使用了Proxy类的静态方法newProxyInstance方法去生成一个代理类,这个静态方法接收三个参数,分别是目标类的类加载器,目标类实现的接口集合,InvocationHandler实例,最后返回一个Object类型的代理类。我们先从该方法开始,看看代理类是怎样一步一步造出来的,废话不多说,直接上代码
newProxyInstance方法:
1 public static Object newProxyInstance(ClassLoader loader, 2 Class<?>[] interfaces, 3 InvocationHandler h) throws IllegalArgumentException { 4 //验证传入的InvocationHandler不能为空 5 Objects.requireNonNull(h); 6 //复制代理类实现的所有接口 7 final Class<?>[] intfs = interfaces.clone(); 8 //获取安全管理器 9 final SecurityManager sm = System.getSecurityManager(); 10 //进行一些权限检验 11 if (sm != null) { 12 checkProxyAccess(Reflection.getCallerClass(), loader, intfs); 13 } 14 //该方法先从缓存获取代理类, 如果没有再去生成一个代理类 15 Class<?> cl = getProxyClass0(loader, intfs); 16 try { 17 //进行一些权限检验 18 if (sm != null) { 19 checkNewProxyPermission(Reflection.getCallerClass(), cl); 20 } 21 //获取参数类型是InvocationHandler.class的代理类构造器 22 final Constructor<?> cons = cl.getConstructor(constructorParams); 23 final InvocationHandler ih = h; 24 //如果代理类是不可访问的, 就使用特权将它的构造器设置为可访问 25 if (!Modifier.isPublic(cl.getModifiers())) { 26 AccessController.doPrivileged(new PrivilegedAction<Void>() { 27 public Void run() { 28 cons.setAccessible(true); 29 return null; 30 } 31 }); 32 } 33 //传入InvocationHandler实例去构造一个代理类的实例 34 //所有代理类都继承自Proxy, 因此这里会调用Proxy的构造器将InvocationHandler引用传入 35 return cons.newInstance(new Object[]{h}); 36 } catch (Exception e) { 37 //为了节省篇幅, 笔者统一用Exception捕获了所有异常 38 throw new InternalError(e.toString(), e); 39 } 40 }
可以看到,newProxyInstance方法首先是对参数进行一些权限校验,之后通过调用getProxyClass0方法生成了代理类的类对象,然后获取参数类型是InvocationHandler.class的代理类构造器。检验构造器是否可以访问,最后传入InvocationHandler实例的引用去构造出一个代理类实例,InvocationHandler实例的引用其实是Proxy持有着,因为生成的代理类默认继承自Proxy,所以最后会调用Proxy的构造器将引用传入。在这里我们重点关注getProxyClass0这个方法,看看代理类的Class对象是怎样来的,下面贴上该方法的代码
getProxyClass0方法:
1 private static Class<?> getProxyClass0(ClassLoader loader, 2 Class<?>... interfaces) { 3 //目标类实现的接口不能大于65535 4 if (interfaces.length > 65535) { 5 throw new IllegalArgumentException("interface limit exceeded"); 6 } 7 //获取代理类使用了缓存机制 8 return proxyClassCache.get(loader, interfaces); 9 }
可以看到getProxyClass0方法内部没有多少内容,首先是检查目标代理类实现的接口不能大于65535这个数,之后是通过类加载器和接口集合去缓存里面获取,如果能找到代理类就直接返回,否则就会调用ProxyClassFactory这个工厂去生成一个代理类。关于这里使用到的缓存机制我们留到下一篇专门介绍,首先我们先看看这个工厂类是怎样生成代理类的。
ProxyClassFactory工厂类:
1 //代理类生成工厂 2 private static final class ProxyClassFactory 3 implements BiFunction<ClassLoader, Class<?>[], Class<?>> { 4 //代理类名称前缀 5 private static final String proxyClassNamePrefix = "$Proxy"; 6 //用原子类来生成代理类的序号, 以此来确定唯一的代理类 7 private static final AtomicLong nextUniqueNumber = new AtomicLong(); 8 @Override 9 public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) { 10 Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length); 11 for (Class<?> intf : interfaces) { 12 //这里遍历interfaces数组进行验证, 主要做三件事情 13 //1.intf是否可以由指定的类加载进行加载 14 //2.intf是否是一个接口 15 //3.intf在数组中是否有重复 16 } 17 //生成代理类的包名 18 String proxyPkg = null; 19 //生成代理类的访问标志, 默认是public final的 20 int accessFlags = Modifier.PUBLIC | Modifier.FINAL; 21 for (Class<?> intf : interfaces) { 22 //获取接口的访问标志 23 int flags = intf.getModifiers(); 24 //如果接口的访问标志不是public, 那么生成代理类的包名和接口包名相同 25 if (!Modifier.isPublic(flags)) { 26 //生成的代理类的访问标志设置为final 27 accessFlags = Modifier.FINAL; 28 //获取接口全限定名, 例如:java.util.Collection 29 String name = intf.getName(); 30 int n = name.lastIndexOf('.'); 31 //剪裁后得到包名:java.util 32 String pkg = ((n == -1) ? "" : name.substring(0, n + 1)); 33 //生成的代理类的包名和接口包名是一样的 34 if (proxyPkg == null) { 35 proxyPkg = pkg; 36 } else if (!pkg.equals(proxyPkg)) { 37 //代理类如果实现不同包的接口, 并且接口都不是public的, 那么就会在这里报错 38 throw new IllegalArgumentException( 39 "non-public interfaces from different packages"); 40 } 41 } 42 } 43 //如果接口访问标志都是public的话, 那生成的代理类都放到默认的包下:com.sun.proxy 44 if (proxyPkg == null) { 45 proxyPkg = ReflectUtil.PROXY_PACKAGE + "."; 46 } 47 //生成代理类的序号 48 long num = nextUniqueNumber.getAndIncrement(); 49 //生成代理类的全限定名, 包名+前缀+序号, 例如:com.sun.proxy.$Proxy0 50 String proxyName = proxyPkg + proxyClassNamePrefix + num; 51 //这里是核心, 用ProxyGenerator来生成字节码, 该类放在sun.misc包下 52 byte[] proxyClassFile = ProxyGenerator.generateProxyClass(proxyName, 53 interfaces, accessFlags); 54 try { 55 //根据二进制文件生成相应的Class实例 56 return defineClass0(loader, proxyName, proxyClassFile, 57 0, proxyClassFile.length); 58 } catch (ClassFormatError e) { 59 throw new IllegalArgumentException(e.toString()); 60 } 61 } 62 }
该工厂的apply方法会被调用用来生成代理类的Class对象,由于代码的注释比较详细,我们只挑关键点进行阐述,其他的就不反复赘述了。
1. 在代码中可以看到JDK生成的代理类的类名是“$Proxy”+序号。
2. 如果接口是public的,代理类默认是public final的,并且生成的代理类默认放到com.sun.proxy这个包下。
3. 如果接口是非public的,那么代理类也是非public的,并且生成的代理类会放在对应接口所在的包下。
4. 如果接口是非public的,并且这些接口不在同一个包下,那么就会报错。
生成具体的字节码是调用了ProxyGenerator这个类的generateProxyClass方法。这个类放在sun.misc包下,后续我们会扒出这个类继续深究其底层源码。到这里我们已经分析了Proxy这个类是怎样生成代理类对象的,通过源码我们更直观的了解了整个的执行过程,包括代理类的类名是怎样生成的,代理类的访问标志是怎样确定的,生成的代理类会放到哪个包下面,以及InvocationHandler实例的引用是怎样传入的。不过读者可能还会有疑问,WeakCache缓存是怎样实现的?为什么proxyClassCache.get(loader, interfaces)最后会调用到ProxyClassFactory工厂的apply方法?在下一篇中将会为读者详细介绍WeakCache缓存的实现原理。