美文网首页工作相关JAVAJAVA
深入理解JDK动态代理机制

深入理解JDK动态代理机制

作者: EakonZhao | 来源:发表于2017-08-03 16:40 被阅读3998次

    本文是基于jdk1.8来对动态代理的底层机制进行探究的

    Java中代理的实现一般分为三种:JDK静态代理、JDK动态代理以及CGLIB动态代理。在Spring的AOP实现中,主要应用了JDK动态代理以及CGLIB动态代理。但是本文着重介绍JDK动态代理机制,CGLIB动态代理后面会接着探究。

    代理一般实现的模式为JDK静态代理:创建一个接口,然后创建被代理的类实现该接口并且实现该接口中的抽象方法。之后再创建一个代理类,同时使其也实现这个接口。在代理类中持有一个被代理对象的引用,而后在代理类方法中调用该对象的方法。

    其实就是代理类为被代理类预处理消息、过滤消息并在此之后将消息转发给被代理类,之后还能进行消息的后置处理。代理类和被代理类通常会存在关联关系(即上面提到的持有的被带离对象的引用),代理类本身不实现服务,而是通过调用被代理类中的方法来提供服务。

    接口 被代理类 代理类 测试类以及输出结果

    我们可以看出,使用JDK静态代理很容易就完成了对一个类的代理操作。但是JDK静态代理的缺点也暴露了出来:由于代理只能为一个类服务,如果需要代理的类很多,那么就需要编写大量的代理类,比较繁琐。

    下面我们使用JDK动态代理来做同样的事情

    接口 被代理类 代理类 测试类以及输出结果

    JDK动态代理其实也是基本接口实现的。因为通过接口指向实现类实例的多态方式,可以有效地将具体实现与调用解耦,便于后期的修改和维护。

    通过上面的介绍,我们可以发现JDK静态代理与JDK动态代理之间有些许相似,比如说都要创建代理类,以及代理类都要实现接口等。但是不同之处也非常明显----在静态代理中我们需要对哪个接口和哪个被代理类创建代理类,所以我们在编译前就需要代理类实现与被代理类相同的接口,并且直接在实现的方法中调用被代理类相应的方法;但是动态代理则不同,我们不知道要针对哪个接口、哪个被代理类创建代理类,因为它是在运行时被创建的。

    让我们用一句话来总结一下JDK静态代理和JDK动态代理的区别,然后开始探究JDK动态代理的底层实现机制:
    JDK静态代理是通过直接编码创建的,而JDK动态代理是利用反射机制在运行时创建代理类的。
    其实在动态代理中,核心是InvocationHandler。每一个代理的实例都会有一个关联的调用处理程序(InvocationHandler)。对待代理实例进行调用时,将对方法的调用进行编码并指派到它的调用处理器(InvocationHandler)的invoke方法。所以对代理对象实例方法的调用都是通过InvocationHandler中的invoke方法来完成的,而invoke方法会根据传入的代理对象、方法名称以及参数决定调用代理的哪个方法。

    我们从JDK动态代理的测试类中可以发现代理类生成是通过Proxy类中的newProxyInstance来完成的,下面我们进入这个函数看一看:

     public static Object newProxyInstance(ClassLoader loader,
                                              Class<?>[] interfaces,
                                              InvocationHandler h)
            throws IllegalArgumentException
        {
            //如果h为空将抛出异常
            Objects.requireNonNull(h);
    
            final Class<?>[] intfs = interfaces.clone();//拷贝被代理类实现的一些接口,用于后面权限方面的一些检查
            final SecurityManager sm = System.getSecurityManager();
            if (sm != null) {
                //在这里对某些安全权限进行检查,确保我们有权限对预期的被代理类进行代理
                checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
            }
    
            /*
             * 下面这个方法将产生代理类
             */
            Class<?> cl = getProxyClass0(loader, intfs);
    
            /*
             * 使用指定的调用处理程序获取代理类的构造函数对象
             */
            try {
                if (sm != null) {
                    checkNewProxyPermission(Reflection.getCallerClass(), cl);
                }
    
                final Constructor<?> cons = cl.getConstructor(constructorParams);
                final InvocationHandler ih = h;
                //假如代理类的构造函数是private的,就使用反射来set accessible
                if (!Modifier.isPublic(cl.getModifiers())) {
                    AccessController.doPrivileged(new PrivilegedAction<Void>() {
                        public Void run() {
                            cons.setAccessible(true);
                            return null;
                        }
                    });
                }
                //根据代理类的构造函数来生成代理类的对象并返回
                return cons.newInstance(new Object[]{h});
            } catch (IllegalAccessException|InstantiationException e) {
                throw new InternalError(e.toString(), e);
            } catch (InvocationTargetException e) {
                Throwable t = e.getCause();
                if (t instanceof RuntimeException) {
                    throw (RuntimeException) t;
                } else {
                    throw new InternalError(t.toString(), t);
                }
            } catch (NoSuchMethodException e) {
                throw new InternalError(e.toString(), e);
            }
        }
    

    所以代理类其实是通过getProxyClass方法来生成的:

     /**
         * 生成一个代理类,但是在调用本方法之前必须进行权限检查
         */
        private static Class<?> getProxyClass0(ClassLoader loader,
                                               Class<?>... interfaces) {
            //如果接口数量大于65535,抛出非法参数错误
            if (interfaces.length > 65535) {
                throw new IllegalArgumentException("interface limit exceeded");
            }
    
           
            // 如果在缓存中有对应的代理类,那么直接返回
            // 否则代理类将有 ProxyClassFactory 来创建
            return proxyClassCache.get(loader, interfaces);
        }
    

    那么ProxyClassFactory是什么呢?

       /**
         *  里面有一个根据给定ClassLoader和Interface来创建代理类的工厂函数  
         *
         */
        private static final class ProxyClassFactory
            implements BiFunction<ClassLoader, Class<?>[], Class<?>>
        {
            // 代理类的名字的前缀统一为“$Proxy”
            private static final String proxyClassNamePrefix = "$Proxy";
    
            // 每个代理类前缀后面都会跟着一个唯一的编号,如$Proxy0、$Proxy1、$Proxy2
            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) {
                    /*
                     * 验证类加载器加载接口得到对象是否与由apply函数参数传入的对象相同
                     */
                    Class<?> interfaceClass = null;
                    try {
                        interfaceClass = Class.forName(intf.getName(), false, loader);
                    } catch (ClassNotFoundException e) {
                    }
                    if (interfaceClass != intf) {
                        throw new IllegalArgumentException(
                            intf + " is not visible from class loader");
                    }
                    /*
                     * 验证这个Class对象是不是接口
                     */
                    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
                int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
    
                /*
                 * 记录一个非公共代理接口的包,以便在同一个包中定义代理类。同时验证所有非公共
                 * 代理接口都在同一个包中
                 */
                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");
                        }
                    }
                }
    
                if (proxyPkg == null) {
                    // 如果全是公共代理接口,那么生成的代理类就在com.sun.proxy package下
                    proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
                }
    
                /*
                 * 为代理类生成一个name  package name + 前缀+唯一编号
                 * 如 com.sun.proxy.$Proxy0.class
                 */
                long num = nextUniqueNumber.getAndIncrement();
                String proxyName = proxyPkg + proxyClassNamePrefix + num;
    
                /*
                 * 生成指定代理类的字节码文件
                 */
                byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
                    proxyName, interfaces, accessFlags);
                try {
                    return defineClass0(loader, proxyName,
                                        proxyClassFile, 0, proxyClassFile.length);
                } 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());
                }
            }
        }
    

    由上方代码byte[] proxyClassFile = ProxyGenerator.generateProxyClass(proxyName, interfaces, accessFlags);可以看到,其实生成代理类字节码文件的工作是通过 ProxyGenerate类中的generateProxyClass方法来完成的。

     public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
            ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
           // 真正用来生成代理类字节码文件的方法在这里
            final byte[] var4 = var3.generateClassFile();
           // 保存代理类的字节码文件
            if(saveGeneratedFiles) {
                AccessController.doPrivileged(new PrivilegedAction() {
                    public Void run() {
                        try {
                            int var1 = var0.lastIndexOf(46);
                            Path var2;
                            if(var1 > 0) {
                                Path var3 = Paths.get(var0.substring(0, var1).replace('.', File.separatorChar), 
                                                                                       new String[0]);
                                Files.createDirectories(var3, new FileAttribute[0]);
                                var2 = var3.resolve(var0.substring(var1 + 1, var0.length()) + ".class");
                            } else {
                                var2 = Paths.get(var0 + ".class", new String[0]);
                            }
    
                            Files.write(var2, var4, new OpenOption[0]);
                            return null;
                        } catch (IOException var4x) {
                            throw new InternalError("I/O exception saving generated file: " + var4x);
                        }
                    }
                });
            }
    
            return var4;
        }
    

    下面来看看真正用于生成代理类字节码文件的generateClassFile方法:

    private byte[] generateClassFile() {
            //下面一系列的addProxyMethod方法是将接口中的方法和Object中的方法添加到代理方法中(proxyMethod)
            this.addProxyMethod(hashCodeMethod, Object.class);
            this.addProxyMethod(equalsMethod, Object.class);
            this.addProxyMethod(toStringMethod, Object.class);
            Class[] var1 = this.interfaces;
            int var2 = var1.length;
    
            int var3;
            Class var4;
           //获得接口中所有方法并添加到代理方法中
            for(var3 = 0; var3 < var2; ++var3) {
                var4 = var1[var3];
                Method[] var5 = var4.getMethods();
                int var6 = var5.length;
    
                for(int var7 = 0; var7 < var6; ++var7) {
                    Method var8 = var5[var7];
                    this.addProxyMethod(var8, var4);
                }
            }
    
            Iterator var11 = this.proxyMethods.values().iterator();
            //验证具有相同方法签名的方法的返回类型是否一致
            List var12;
            while(var11.hasNext()) {
                var12 = (List)var11.next();
                checkReturnTypes(var12);
            }
    
            //后面一系列的步骤用于写代理类Class文件
            Iterator var15;
            try {
                 //生成代理类的构造函数
                this.methods.add(this.generateConstructor());
                var11 = this.proxyMethods.values().iterator();
    
                while(var11.hasNext()) {
                    var12 = (List)var11.next();
                    var15 = var12.iterator();
    
                    while(var15.hasNext()) {
                        ProxyGenerator.ProxyMethod var16 = (ProxyGenerator.ProxyMethod)var15.next();
                        //将代理类字段声明为Method,并且字段修饰符为 private static.
                       //因为 10 是 ACC_PRIVATE和ACC_STATIC的与运算 故代理类的字段都是 private static Method ***
                        this.fields.add(new ProxyGenerator.FieldInfo(var16.methodFieldName, 
                                       "Ljava/lang/reflect/Method;", 10));
                       //生成代理类的方法
                        this.methods.add(var16.generateMethod());
                    }
                }
               //为代理类生成静态代码块对某些字段进行初始化
                this.methods.add(this.generateStaticInitializer());
            } catch (IOException var10) {
                throw new InternalError("unexpected I/O Exception", var10);
            }
    
            if(this.methods.size() > '\uffff') { //代理类中的方法数量超过65535就抛异常
                throw new IllegalArgumentException("method limit exceeded");
            } else if(this.fields.size() > '\uffff') {// 代理类中字段数量超过65535也抛异常
                throw new IllegalArgumentException("field limit exceeded");
            } else {
                // 后面是对文件进行处理的过程
                this.cp.getClass(dotToSlash(this.className));
                this.cp.getClass("java/lang/reflect/Proxy");
                var1 = this.interfaces;
                var2 = var1.length;
    
                for(var3 = 0; var3 < var2; ++var3) {
                    var4 = var1[var3];
                    this.cp.getClass(dotToSlash(var4.getName()));
                }
    
                this.cp.setReadOnly();
                ByteArrayOutputStream var13 = new ByteArrayOutputStream();
                DataOutputStream var14 = new DataOutputStream(var13);
    
                try {
                    var14.writeInt(-889275714);
                    var14.writeShort(0);
                    var14.writeShort(49);
                    this.cp.write(var14);
                    var14.writeShort(this.accessFlags);
                    var14.writeShort(this.cp.getClass(dotToSlash(this.className)));
                    var14.writeShort(this.cp.getClass("java/lang/reflect/Proxy"));
                    var14.writeShort(this.interfaces.length);
                    Class[] var17 = this.interfaces;
                    int var18 = var17.length;
    
                    for(int var19 = 0; var19 < var18; ++var19) {
                        Class var22 = var17[var19];
                        var14.writeShort(this.cp.getClass(dotToSlash(var22.getName())));
                    }
    
                    var14.writeShort(this.fields.size());
                    var15 = this.fields.iterator();
    
                    while(var15.hasNext()) {
                        ProxyGenerator.FieldInfo var20 = (ProxyGenerator.FieldInfo)var15.next();
                        var20.write(var14);
                    }
    
                    var14.writeShort(this.methods.size());
                    var15 = this.methods.iterator();
    
                    while(var15.hasNext()) {
                        ProxyGenerator.MethodInfo var21 = (ProxyGenerator.MethodInfo)var15.next();
                        var21.write(var14);
                    }
    
                    var14.writeShort(0);
                    return var13.toByteArray();
                } catch (IOException var9) {
                    throw new InternalError("unexpected I/O Exception", var9);
                }
            }
        }
    

    下面是将接口与Object中一些方法添加到代理类中的addProxyMethod方法:

    private void addProxyMethod(Method var1, Class<?> var2) {
            String var3 = var1.getName();//获得方法名称
            Class[] var4 = var1.getParameterTypes();//获得方法参数类型
            Class var5 = var1.getReturnType();//获得方法返回类型
            Class[] var6 = var1.getExceptionTypes();//异常类型
            String var7 = var3 + getParameterDescriptors(var4);//获得方法签名
            Object var8 = (List)this.proxyMethods.get(var7);//根据方法前面获得proxyMethod的value
            if(var8 != null) {//处理多个代理接口中方法重复的情况
                Iterator var9 = ((List)var8).iterator();
    
                while(var9.hasNext()) {
                    ProxyGenerator.ProxyMethod var10 = (ProxyGenerator.ProxyMethod)var9.next();
                    if(var5 == var10.returnType) {
                        ArrayList var11 = new ArrayList();
                        collectCompatibleTypes(var6, var10.exceptionTypes, var11);
                        collectCompatibleTypes(var10.exceptionTypes, var6, var11);
                        var10.exceptionTypes = new Class[var11.size()];
                        var10.exceptionTypes = (Class[])var11.toArray(var10.exceptionTypes);
                        return;
                    }
                }
            } else {
                var8 = new ArrayList(3);
                this.proxyMethods.put(var7, var8);
            }
    
            ((List)var8).add(new ProxyGenerator.ProxyMethod(var3, var4, var5, var6, var2, null));
        }
    

    相关文章

      网友评论

      • e09c29ec7d5b:感谢楼主的分享。 说点自己的体会:
        其实 JDK 的动态代理天生就是为 AOP 而生的,如果没有动态代理,针对 interface,要手动实现 AOP, 最笨的办法就是写一堆重复的逻辑在每个代理类的方法里。有了动态代理,结合反射,可以相对轻松的实现接口级别的 AOP。但是动态创建代理类这个逻辑,其本身只能替开发人员省去实现接口,创建代理 stub ,具体被代理的对象是谁,代理的逻辑,这个还是需要在 InvocationHandler 中去实现。
      • 甘军:没有看懂,动态代理生成的对象是代理类的对象吧,代理类对象调用方法,怎么会相当于执行被代理的invoke方法呢,相当于代理类被注解过吗?
        唯一浩哥:理解错误,动态代理生成的是代理实例是代理类实例,这个对,使用代理实例来调用某个方法会统一经过与该代理实例关联的handler来处理,在这个handler中实现了InvocationHandler中的invoke方法,这个方法是一个对被代理实例方法调用的统一方法,在这个方法中还可以加设一些预处理和后处理语句,中间则是对被代理实例方法的调用。
        EakonZhao:我这篇博客也写得比较久了,具体的细节记不太清楚了。因为代理类是对被代理类进行代理。什么是代理呢?就是可以代替被代理的对象接受并传递消息。通俗地说,也就是可以在完成被代理类功能的基础上再多干些事情。在代理类对象被调用的时候,其实不管是静态代理还是动态代理,最终都会通过反射调用被代理对象的invoke方法。这是代理模式最基本的一种思想。
      • 1eff7f40b465:如果没有实现接口怎么代理?
        EakonZhao:@chen_long 没有实现接口的话用cglib动态代理,我后面会介绍关于cglib动态代理的博客~
      • c2e6e7333036:学习了,谢谢。同为程序猿。
      • 风起龙飞:专业文章,外行难懂,可否先科普一下,引导一下,由浅入深
        风起龙飞:@EakonZhao 谢谢,知道了,是专业人士的交流,打扰了,祝夏安!
        风起龙飞:@EakonZhao
        EakonZhao:@风起龙飞 由于本文介绍的是计算机编程领域比较经典的内容,所以面向的是具有一定编程经验的读者,抱歉。

      本文标题:深入理解JDK动态代理机制

      本文链接:https://www.haomeiwen.com/subject/pizulxtx.html