溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊(cè)×
其他方式登錄
點(diǎn)擊 登錄注冊(cè) 即表示同意《億速云用戶服務(wù)條款》

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

發(fā)布時(shí)間:2021-12-17 13:56:27 來源:億速云 閱讀:128 作者:小新 欄目:編程語(yǔ)言

這篇文章給大家分享的是有關(guān)Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析的內(nèi)容。小編覺得挺實(shí)用的,因此分享給大家做個(gè)參考,一起跟隨小編過來看看吧。

Java代理介紹

Java中代理的實(shí)現(xiàn)一般分為三種:JDK靜態(tài)代理、JDK動(dòng)態(tài)代理以及CGLIB動(dòng)態(tài)代理。在Spring的AOP實(shí)現(xiàn)中,主要應(yīng)用了JDK動(dòng)態(tài)代理以及CGLIB動(dòng)態(tài)代理。但是本文著重介紹JDK動(dòng)態(tài)代理機(jī)制,CGLIB動(dòng)態(tài)代理后面會(huì)接著探究。

代理一般實(shí)現(xiàn)的模式為JDK靜態(tài)代理:創(chuàng)建一個(gè)接口,然后創(chuàng)建被代理的類實(shí)現(xiàn)該接口并且實(shí)現(xiàn)該接口中的抽象方法。之后再創(chuàng)建一個(gè)代理類,同時(shí)使其也實(shí)現(xiàn)這個(gè)接口。在代理類中持有一個(gè)被代理對(duì)象的引用,而后在代理類方法中調(diào)用該對(duì)象的方法。

其實(shí)就是代理類為被代理類預(yù)處理消息、過濾消息并在此之后將消息轉(zhuǎn)發(fā)給被代理類,之后還能進(jìn)行消息的后置處理。代理類和被代理類通常會(huì)存在關(guān)聯(lián)關(guān)系(即上面提到的持有的被帶離對(duì)象的引用),代理類本身不實(shí)現(xiàn)服務(wù),而是通過調(diào)用被代理類中的方法來提供服務(wù)。

靜態(tài)代理

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

接口

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

被代理類

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

代理類

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

測(cè)試類以及輸出結(jié)果

我們可以看出,使用JDK靜態(tài)代理很容易就完成了對(duì)一個(gè)類的代理操作。但是JDK靜態(tài)代理的缺點(diǎn)也暴露了出來:由于代理只能為一個(gè)類服務(wù),如果需要代理的類很多,那么就需要編寫大量的代理類,比較繁瑣。

下面我們使用JDK動(dòng)態(tài)代理來做同樣的事情

JDK動(dòng)態(tài)代理

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

接口

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

被代理類

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

代理類

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

測(cè)試類以及輸出結(jié)果

JDK動(dòng)態(tài)代理實(shí)現(xiàn)原理

JDK動(dòng)態(tài)代理其實(shí)也是基本接口實(shí)現(xiàn)的。因?yàn)橥ㄟ^接口指向?qū)崿F(xiàn)類實(shí)例的多態(tài)方式,可以有效地將具體實(shí)現(xiàn)與調(diào)用解耦,便于后期的修改和維護(hù)。

通過上面的介紹,我們可以發(fā)現(xiàn)JDK靜態(tài)代理與JDK動(dòng)態(tài)代理之間有些許相似,比如說都要?jiǎng)?chuàng)建代理類,以及代理類都要實(shí)現(xiàn)接口等。但是不同之處也非常明顯——在靜態(tài)代理中我們需要對(duì)哪個(gè)接口和哪個(gè)被代理類創(chuàng)建代理類,所以我們?cè)诰幾g前就需要代理類實(shí)現(xiàn)與被代理類相同的接口,并且直接在實(shí)現(xiàn)的方法中調(diào)用被代理類相應(yīng)的方法;但是動(dòng)態(tài)代理則不同,我們不知道要針對(duì)哪個(gè)接口、哪個(gè)被代理類創(chuàng)建代理類,因?yàn)樗窃谶\(yùn)行時(shí)被創(chuàng)建的。

讓我們用一句話來總結(jié)一下JDK靜態(tài)代理和JDK動(dòng)態(tài)代理的區(qū)別,然后開始探究JDK動(dòng)態(tài)代理的底層實(shí)現(xiàn)機(jī)制:
JDK靜態(tài)代理是通過直接編碼創(chuàng)建的,而JDK動(dòng)態(tài)代理是利用反射機(jī)制在運(yùn)行時(shí)創(chuàng)建代理類的。
其實(shí)在動(dòng)態(tài)代理中,核心是InvocationHandler。每一個(gè)代理的實(shí)例都會(huì)有一個(gè)關(guān)聯(lián)的調(diào)用處理程序(InvocationHandler)。對(duì)待代理實(shí)例進(jìn)行調(diào)用時(shí),將對(duì)方法的調(diào)用進(jìn)行編碼并指派到它的調(diào)用處理器(InvocationHandler)的invoke方法。所以對(duì)代理對(duì)象實(shí)例方法的調(diào)用都是通過InvocationHandler中的invoke方法來完成的,而invoke方法會(huì)根據(jù)傳入的代理對(duì)象、方法名稱以及參數(shù)決定調(diào)用代理的哪個(gè)方法。

我們從JDK動(dòng)態(tài)代理的測(cè)試類中可以發(fā)現(xiàn)代理類生成是通過Proxy類中的newProxyInstance來完成的,下面我們進(jìn)入這個(gè)函數(shù)看一看:

Proxy類中的newProxyInstance

 public static Object newProxyInstance(ClassLoader loader,
                                          Class<?>[] interfaces,
                                          InvocationHandler h)
        throws IllegalArgumentException
    {
        //如果h為空將拋出異常
        Objects.requireNonNull(h);
        final Class<?>[] intfs = interfaces.clone();//拷貝被代理類實(shí)現(xiàn)的一些接口,用于后面權(quán)限方面的一些檢查
        final SecurityManager sm = System.getSecurityManager();
        if (sm != null) {
            //在這里對(duì)某些安全權(quán)限進(jìn)行檢查,確保我們有權(quán)限對(duì)預(yù)期的被代理類進(jìn)行代理
            checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
        }
        /*
         * 下面這個(gè)方法將產(chǎn)生代理類
         */
        Class<?> cl = getProxyClass0(loader, intfs);
        /*
         * 使用指定的調(diào)用處理程序獲取代理類的構(gòu)造函數(shù)對(duì)象
         */
        try {
            if (sm != null) {
                checkNewProxyPermission(Reflection.getCallerClass(), cl);
            }
            final Constructor<?> cons = cl.getConstructor(constructorParams);
            final InvocationHandler ih = h;
            //假如代理類的構(gòu)造函數(shù)是private的,就使用反射來set accessible
            if (!Modifier.isPublic(cl.getModifiers())) {
                AccessController.doPrivileged(new PrivilegedAction<Void>() {
                    public Void run() {
                        cons.setAccessible(true);
                        return null;
                    }
                });
            }
            //根據(jù)代理類的構(gòu)造函數(shù)來生成代理類的對(duì)象并返回
            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);
        }
    }

所以代理類其實(shí)是通過getProxyClass方法來生成的:

 /**
     * 生成一個(gè)代理類,但是在調(diào)用本方法之前必須進(jìn)行權(quán)限檢查
     */
    private static Class<?> getProxyClass0(ClassLoader loader,
                                           Class<?>... interfaces) {
        //如果接口數(shù)量大于65535,拋出非法參數(shù)錯(cuò)誤
        if (interfaces.length > 65535) {
            throw new IllegalArgumentException("interface limit exceeded");
        }
        // 如果在緩存中有對(duì)應(yīng)的代理類,那么直接返回
        // 否則代理類將有 ProxyClassFactory 來創(chuàng)建
        return proxyClassCache.get(loader, interfaces);
    }

那么ProxyClassFactory是什么呢?

   /**
     *  里面有一個(gè)根據(jù)給定ClassLoader和Interface來創(chuàng)建代理類的工廠函數(shù)  
     *
     */
    private static final class ProxyClassFactory
        implements BiFunction<ClassLoader, Class<?>[], Class<?>>
    {
        // 代理類的名字的前綴統(tǒng)一為“$Proxy”
        private static final String proxyClassNamePrefix = "$Proxy";
        // 每個(gè)代理類前綴后面都會(huì)跟著一個(gè)唯一的編號(hào),如$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) {
                /*
                 * 驗(yàn)證類加載器加載接口得到對(duì)象是否與由apply函數(shù)參數(shù)傳入的對(duì)象相同
                 */
                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");
                }
                /*
                 * 驗(yàn)證這個(gè)Class對(duì)象是不是接口
                 */
                if (!interfaceClass.isInterface()) {
                    throw new IllegalArgumentException(
                        interfaceClass.getName() + " is not an interface");
                }
                /*
                 * 驗(yàn)證這個(gè)接口是否重復(fù)
                 */
                if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
                    throw new IllegalArgumentException(
                        "repeated interface: " + interfaceClass.getName());
                }
            }
            String proxyPkg = null;     // 聲明代理類所在的package
            int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
            /*
             * 記錄一個(gè)非公共代理接口的包,以便在同一個(gè)包中定義代理類。同時(shí)驗(yàn)證所有非公共
             * 代理接口都在同一個(gè)包中
             */
            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 + ".";
            }
            /*
             * 為代理類生成一個(gè)name  package name + 前綴+唯一編號(hào)
             * 如 com.sun.proxy.$Proxy0.class
             */
            long num = nextUniqueNumber.getAndIncrement();
            String proxyName = proxyPkg + proxyClassNamePrefix + num;
            /*
             * 生成指定代理類的字節(jié)碼文件
             */
            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());
            }
        }
    }

字節(jié)碼生成

由上方代碼byte[] proxyClassFile = ProxyGenerator.generateProxyClass(proxyName, interfaces, accessFlags);可以看到,其實(shí)生成代理類字節(jié)碼文件的工作是通過 ProxyGenerate類中的generateProxyClass方法來完成的。

 public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
        ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
       // 真正用來生成代理類字節(jié)碼文件的方法在這里
        final byte[] var4 = var3.generateClassFile();
       // 保存代理類的字節(jié)碼文件
        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;
    }

下面來看看真正用于生成代理類字節(jié)碼文件的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();
        //驗(yàn)證具有相同方法簽名的方法的返回類型是否一致
        List var12;
        while(var11.hasNext()) {
            var12 = (List)var11.next();
            checkReturnTypes(var12);
        }
        //后面一系列的步驟用于寫代理類Class文件
        Iterator var15;
        try {
             //生成代理類的構(gòu)造函數(shù)
            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.
                   //因?yàn)?nbsp;10 是 ACC_PRIVATE和ACC_STATIC的與運(yùn)算 故代理類的字段都是 private static Method ***
                    this.fields.add(new ProxyGenerator.FieldInfo(var16.methodFieldName, 
                                   "Ljava/lang/reflect/Method;", 10));
                   //生成代理類的方法
                    this.methods.add(var16.generateMethod());
                }
            }
           //為代理類生成靜態(tài)代碼塊對(duì)某些字段進(jìn)行初始化
            this.methods.add(this.generateStaticInitializer());
        } catch (IOException var10) {
            throw new InternalError("unexpected I/O Exception", var10);
        }
        if(this.methods.size() > '\uffff') { //代理類中的方法數(shù)量超過65535就拋異常
            throw new IllegalArgumentException("method limit exceeded");
        } else if(this.fields.size() > '\uffff') {// 代理類中字段數(shù)量超過65535也拋異常
            throw new IllegalArgumentException("field limit exceeded");
        } else {
            // 后面是對(duì)文件進(jìn)行處理的過程
            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);
            }
        }
    }

代理類的方法調(diào)用

下面是將接口與Object中一些方法添加到代理類中的addProxyMethod方法:

private void addProxyMethod(Method var1, Class<?> var2) {
        String var3 = var1.getName();//獲得方法名稱
        Class[] var4 = var1.getParameterTypes();//獲得方法參數(shù)類型
        Class var5 = var1.getReturnType();//獲得方法返回類型
        Class[] var6 = var1.getExceptionTypes();//異常類型
        String var7 = var3 + getParameterDescriptors(var4);//獲得方法簽名
        Object var8 = (List)this.proxyMethods.get(var7);//根據(jù)方法前面獲得proxyMethod的value
        if(var8 != null) {//處理多個(gè)代理接口中方法重復(fù)的情況
            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));
    }

這就是最終真正的代理類,它繼承自Proxy并實(shí)現(xiàn)了我們定義的Subject接口。我們通過

HelloInterface helloInterface = (HelloInterface ) Proxy.newProxyInstance(loader, interfaces, handler);
  • 1

得到的最終代理類對(duì)象就是上面這個(gè)類的實(shí)例。那么我們執(zhí)行如下語(yǔ)句:

helloInterface.hello("Tom");
  • 1

實(shí)際上就是執(zhí)行上面類的相應(yīng)方法,也就是:

 public final void hello(String paramString)
  {
    try
    {
      this.h.invoke(this, m3, new Object[] { paramString });
      //就是調(diào)用我們自定義的InvocationHandlerImpl的 invoke方法:
      return;
    }
    catch (Error|RuntimeException localError)
    {
      throw localError;
    }
    catch (Throwable localThrowable)
    {
      throw new UndeclaredThrowableException(localThrowable);
    }
  }

注意這里的this.h.invoke中的h,它是類Proxy中的一個(gè)屬性

 protected InvocationHandler h;

因?yàn)檫@個(gè)代理類繼承了Proxy,所以也就繼承了這個(gè)屬性,而這個(gè)屬性值就是我們定義的

InvocationHandler handler = new InvocationHandlerImpl(hello);
  • 1

同時(shí)我們還發(fā)現(xiàn),invoke方法的第一參數(shù)在底層調(diào)用的時(shí)候傳入的是this,也就是最終生成的代理對(duì)象ProxySubject,這是JVM自己動(dòng)態(tài)生成的,而不是我們自己定義的代理對(duì)象。

深入理解CGLIB動(dòng)態(tài)代理機(jī)制

Cglib是什么

Cglib是一個(gè)強(qiáng)大的、高性能的代碼生成包,它廣泛被許多AOP框架使用,為他們提供方法的攔截。下圖是我網(wǎng)上找到的一張Cglib與一些框架和語(yǔ)言的關(guān)系:

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

對(duì)此圖總結(jié)一下:

  • 最底層的是字節(jié)碼Bytecode,字節(jié)碼是Java為了保證“一次編譯、到處運(yùn)行”而產(chǎn)生的一種虛擬指令格式,例如iload_0、iconst_1、if_icmpne、dup等

  • 位于字節(jié)碼之上的是ASM,這是一種直接操作字節(jié)碼的框架,應(yīng)用ASM需要對(duì)Java字節(jié)碼、Class結(jié)構(gòu)比較熟悉

  • 位于ASM之上的是CGLIB、Groovy、BeanShell,后兩種并不是Java體系中的內(nèi)容而是腳本語(yǔ)言,它們通過ASM框架生成字節(jié)碼變相執(zhí)行Java代碼,這說明在JVM中執(zhí)行程序并不一定非要寫Java代碼——只要你能生成Java字節(jié)碼,JVM并不關(guān)心字節(jié)碼的來源,當(dāng)然通過Java代碼生成的JVM字節(jié)碼是通過編譯器直接生成的,算是最“正統(tǒng)”的JVM字節(jié)碼

  • 位于CGLIB、Groovy、BeanShell之上的就是Hibernate、Spring AOP這些框架了,這一層大家都比較熟悉

  • 最上層的是Applications,即具體應(yīng)用,一般都是一個(gè)Web項(xiàng)目或者本地跑一個(gè)程序

本文是基于CGLIB 3.1進(jìn)行探究的

cglib is a powerful, high performance and quality Code Generation Library, It is used to extend JAVA classes and implements interfaces at runtime.

在Spring AOP中,通常會(huì)用它來生成AopProxy對(duì)象。不僅如此,在Hibernate中PO(Persistant Object 持久化對(duì)象)字節(jié)碼的生成工作也要靠它來完成。

本文將深入探究CGLIB動(dòng)態(tài)代理的實(shí)現(xiàn)機(jī)制,配合下面這篇文章一起食用口味更佳:
深入理解JDK動(dòng)態(tài)代理機(jī)制

CGLIB動(dòng)態(tài)代理示例

下面由一個(gè)簡(jiǎn)單的示例開始我們對(duì)CGLIB動(dòng)態(tài)代理的介紹:

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

為了后續(xù)編碼的順利進(jìn)行,我們需要使用Maven引入CGLIB的包

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

圖1.1 被代理類

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

圖1.2 實(shí)現(xiàn)MethodInterceptor接口生成方法攔截器

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

圖1.3 生成代理類對(duì)象并打印在代理類對(duì)象調(diào)用方法之后的執(zhí)行結(jié)果

JDK代理要求被代理的類必須實(shí)現(xiàn)接口,有很強(qiáng)的局限性。而CGLIB動(dòng)態(tài)代理則沒有此類強(qiáng)制性要求。簡(jiǎn)單的說,CGLIB會(huì)讓生成的代理類繼承被代理類,并在代理類中對(duì)代理方法進(jìn)行強(qiáng)化處理(前置處理、后置處理等)。在CGLIB底層,其實(shí)是借助了ASM這個(gè)非常強(qiáng)大的Java字節(jié)碼生成框架。

生成代理類對(duì)象

從圖1.3中我們看到,代理類對(duì)象是由Enhancer類創(chuàng)建的。Enhancer是CGLIB的字節(jié)碼增強(qiáng)器,可以很方便的對(duì)類進(jìn)行拓展,如圖1.3中的為類設(shè)置Superclass。

創(chuàng)建代理對(duì)象的幾個(gè)步驟:

  • 生成代理類的二進(jìn)制字節(jié)碼文件;

  • 加載二進(jìn)制字節(jié)碼,生成Class對(duì)象( 例如使用Class.forName()方法 );

  • 通過反射機(jī)制獲得實(shí)例構(gòu)造,并創(chuàng)建代理類對(duì)象

我們來看看將代理類Class文件反編譯之后的Java代碼

package proxy;
import java.lang.reflect.Method;
import net.sf.cglib.core.ReflectUtils;
import net.sf.cglib.core.Signature;
import net.sf.cglib.proxy.Callback;
import net.sf.cglib.proxy.Factory;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;
public class HelloServiceImpl$EnhancerByCGLIB$82ef2d06
  extends HelloServiceImpl
  implements Factory
{
  private boolean CGLIB$BOUND;
  private static final ThreadLocal CGLIB$THREAD_CALLBACKS;
  private static final Callback[] CGLIB$STATIC_CALLBACKS;
  private MethodInterceptor CGLIB$CALLBACK_0;
  private static final Method CGLIB$sayHello$0$Method;
  private static final MethodProxy CGLIB$sayHello$0$Proxy;
  private static final Object[] CGLIB$emptyArgs;
  private static final Method CGLIB$finalize$1$Method;
  private static final MethodProxy CGLIB$finalize$1$Proxy;
  private static final Method CGLIB$equals$2$Method;
  private static final MethodProxy CGLIB$equals$2$Proxy;
  private static final Method CGLIB$toString$3$Method;
  private static final MethodProxy CGLIB$toString$3$Proxy;
  private static final Method CGLIB$hashCode$4$Method;
  private static final MethodProxy CGLIB$hashCode$4$Proxy;
  private static final Method CGLIB$clone$5$Method;
  private static final MethodProxy CGLIB$clone$5$Proxy;
  static void CGLIB$STATICHOOK1()
  {
    CGLIB$THREAD_CALLBACKS = new ThreadLocal();
    CGLIB$emptyArgs = new Object[0];
    Class localClass1 = Class.forName("proxy.HelloServiceImpl$EnhancerByCGLIB$82ef2d06");
    Class localClass2;
    Method[] tmp95_92 = ReflectUtils.findMethods(new String[] { "finalize", "()V", "equals", "(Ljava/lang/Object;)Z", "toString", "()Ljava/lang/String;", "hashCode", "()I", "clone", "()Ljava/lang/Object;" }, (localClass2 = Class.forName("java.lang.Object")).getDeclaredMethods());
    CGLIB$finalize$1$Method = tmp95_92[0];
    CGLIB$finalize$1$Proxy = MethodProxy.create(localClass2, localClass1, "()V", "finalize", "CGLIB$finalize$1");
    Method[] tmp115_95 = tmp95_92;
    CGLIB$equals$2$Method = tmp115_95[1];
    CGLIB$equals$2$Proxy = MethodProxy.create(localClass2, localClass1, "(Ljava/lang/Object;)Z", "equals", "CGLIB$equals$2");
    Method[] tmp135_115 = tmp115_95;
    CGLIB$toString$3$Method = tmp135_115[2];
    CGLIB$toString$3$Proxy = MethodProxy.create(localClass2, localClass1, "()Ljava/lang/String;", "toString", "CGLIB$toString$3");
    Method[] tmp155_135 = tmp135_115;
    CGLIB$hashCode$4$Method = tmp155_135[3];
    CGLIB$hashCode$4$Proxy = MethodProxy.create(localClass2, localClass1, "()I", "hashCode", "CGLIB$hashCode$4");
    Method[] tmp175_155 = tmp155_135;
    CGLIB$clone$5$Method = tmp175_155[4];
    CGLIB$clone$5$Proxy = MethodProxy.create(localClass2, localClass1, "()Ljava/lang/Object;", "clone", "CGLIB$clone$5");
    tmp175_155;
    Method[] tmp223_220 = ReflectUtils.findMethods(new String[] { "sayHello", "()V" }, (localClass2 = Class.forName("proxy.HelloServiceImpl")).getDeclaredMethods());
    CGLIB$sayHello$0$Method = tmp223_220[0];
    CGLIB$sayHello$0$Proxy = MethodProxy.create(localClass2, localClass1, "()V", "sayHello", "CGLIB$sayHello$0");
    tmp223_220;
    return;
  }
  final void CGLIB$sayHello$0()
  {
    super.sayHello();
  }
  public final void sayHello()
  {
    MethodInterceptor tmp4_1 = this.CGLIB$CALLBACK_0;
    if (tmp4_1 == null)
    {
      tmp4_1;
      CGLIB$BIND_CALLBACKS(this);
    }
    if (this.CGLIB$CALLBACK_0 != null) {
      return;
    }
    super.sayHello();
  }
  final void CGLIB$finalize$1()
    throws Throwable
  {
    super.finalize();
  }
  protected final void finalize()
    throws Throwable
  {
    MethodInterceptor tmp4_1 = this.CGLIB$CALLBACK_0;
    if (tmp4_1 == null)
    {
      tmp4_1;
      CGLIB$BIND_CALLBACKS(this);
    }
    if (this.CGLIB$CALLBACK_0 != null) {
      return;
    }
    super.finalize();
  }
  final boolean CGLIB$equals$2(Object paramObject)
  {
    return super.equals(paramObject);
  }
  public final boolean equals(Object paramObject)
  {
    MethodInterceptor tmp4_1 = this.CGLIB$CALLBACK_0;
    if (tmp4_1 == null)
    {
      tmp4_1;
      CGLIB$BIND_CALLBACKS(this);
    }
    MethodInterceptor tmp17_14 = this.CGLIB$CALLBACK_0;
    if (tmp17_14 != null)
    {
      Object tmp41_36 = tmp17_14.intercept(this, CGLIB$equals$2$Method, new Object[] { paramObject }, CGLIB$equals$2$Proxy);
      tmp41_36;
      return tmp41_36 == null ? false : ((Boolean)tmp41_36).booleanValue();
    }
    return super.equals(paramObject);
  }
  final String CGLIB$toString$3()
  {
    return super.toString();
  }
  public final String toString()
  {
    MethodInterceptor tmp4_1 = this.CGLIB$CALLBACK_0;
    if (tmp4_1 == null)
    {
      tmp4_1;
      CGLIB$BIND_CALLBACKS(this);
    }
    MethodInterceptor tmp17_14 = this.CGLIB$CALLBACK_0;
    if (tmp17_14 != null) {
      return (String)tmp17_14.intercept(this, CGLIB$toString$3$Method, CGLIB$emptyArgs, CGLIB$toString$3$Proxy);
    }
    return super.toString();
  }
  final int CGLIB$hashCode$4()
  {
    return super.hashCode();
  }
  public final int hashCode()
  {
    MethodInterceptor tmp4_1 = this.CGLIB$CALLBACK_0;
    if (tmp4_1 == null)
    {
      tmp4_1;
      CGLIB$BIND_CALLBACKS(this);
    }
    MethodInterceptor tmp17_14 = this.CGLIB$CALLBACK_0;
    if (tmp17_14 != null)
    {
      Object tmp36_31 = tmp17_14.intercept(this, CGLIB$hashCode$4$Method, CGLIB$emptyArgs, CGLIB$hashCode$4$Proxy);
      tmp36_31;
      return tmp36_31 == null ? 0 : ((Number)tmp36_31).intValue();
    }
    return super.hashCode();
  }
  final Object CGLIB$clone$5()
    throws CloneNotSupportedException
  {
    return super.clone();
  }
  protected final Object clone()
    throws CloneNotSupportedException
  {
    MethodInterceptor tmp4_1 = this.CGLIB$CALLBACK_0;
    if (tmp4_1 == null)
    {
      tmp4_1;
      CGLIB$BIND_CALLBACKS(this);
    }
    MethodInterceptor tmp17_14 = this.CGLIB$CALLBACK_0;
    if (tmp17_14 != null) {
      return tmp17_14.intercept(this, CGLIB$clone$5$Method, CGLIB$emptyArgs, CGLIB$clone$5$Proxy);
    }
    return super.clone();
  }
  public static MethodProxy CGLIB$findMethodProxy(Signature paramSignature)
  {
    String tmp4_1 = paramSignature.toString();
    switch (tmp4_1.hashCode())
    {
    case -1574182249: 
      if (tmp4_1.equals("finalize()V")) {
        return CGLIB$finalize$1$Proxy;
      }
      break;
    }
  }
  public HelloServiceImpl$EnhancerByCGLIB$82ef2d06()
  {
    CGLIB$BIND_CALLBACKS(this);
  }
  public static void CGLIB$SET_THREAD_CALLBACKS(Callback[] paramArrayOfCallback)
  {
    CGLIB$THREAD_CALLBACKS.set(paramArrayOfCallback);
  }
  public static void CGLIB$SET_STATIC_CALLBACKS(Callback[] paramArrayOfCallback)
  {
    CGLIB$STATIC_CALLBACKS = paramArrayOfCallback;
  }
  private static final void CGLIB$BIND_CALLBACKS(Object paramObject)
  {
    82ef2d06 local82ef2d06 = (82ef2d06)paramObject;
    if (!local82ef2d06.CGLIB$BOUND)
    {
      local82ef2d06.CGLIB$BOUND = true;
      Object tmp23_20 = CGLIB$THREAD_CALLBACKS.get();
      if (tmp23_20 == null)
      {
        tmp23_20;
        CGLIB$STATIC_CALLBACKS;
      }
      local82ef2d06.CGLIB$CALLBACK_0 = (// INTERNAL ERROR //

對(duì)委托類進(jìn)行代理

我們上面貼出了生成的代理類源碼。以我們上面的例子為參考,下面我們總結(jié)一下CGLIB在進(jìn)行代理的時(shí)候都進(jìn)行了哪些工作呢

  • 生成的代理類HelloServiceImpl$EnhancerByCGLIB$82ef2d06繼承被代理類HelloServiceImpl。在這里我們需要注意一點(diǎn):如果委托類被final修飾,那么它不可被繼承,即不可被代理;同樣,如果委托類中存在final修飾的方法,那么該方法也不可被代理;

  • 代理類會(huì)為委托方法生成兩個(gè)方法,一個(gè)是重寫的sayHello方法,另一個(gè)是CGLIB$sayHello$0方法,我們可以看到它是直接調(diào)用父類的sayHello方法;

  • 當(dāng)執(zhí)行代理對(duì)象的sayHello方法時(shí),會(huì)首先判斷一下是否存在實(shí)現(xiàn)了MethodInterceptor接口的CGLIB$CALLBACK_0;,如果存在,則將調(diào)用MethodInterceptor中的intercept方法,如圖2.1。

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

圖2.1 intercept方法

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

圖2.2 代理類為每個(gè)委托方法都會(huì)生成兩個(gè)方法

在intercept方法中,我們除了會(huì)調(diào)用委托方法,還會(huì)進(jìn)行一些增強(qiáng)操作。在Spring AOP中,典型的應(yīng)用場(chǎng)景就是在某些敏感方法執(zhí)行前后進(jìn)行操作日志記錄。

我們從圖2.1中看到,調(diào)用委托方法是通過代理方法的MethodProxy對(duì)象調(diào)用invokeSuper方法來執(zhí)行的,下面我們看看invokeSuper方法中的玄機(jī):

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

圖2.3 invokeSuper方法

在這里好像不能直接看出代理方法的調(diào)用。沒關(guān)系,我會(huì)慢慢介紹。
我們知道,在JDK動(dòng)態(tài)代理中方法的調(diào)用是通過反射來完成的。如果有對(duì)此不太了解的同學(xué),可以看下我之前的博客—— 深入理解JDK動(dòng)態(tài)代理機(jī)制。但是在CGLIB中,方法的調(diào)用并不是通過反射來完成的,而是直接對(duì)方法進(jìn)行調(diào)用:FastClass對(duì)Class對(duì)象進(jìn)行特別的處理,比如將會(huì)用數(shù)組保存method的引用,每次調(diào)用方法的時(shí)候都是通過一個(gè)index下標(biāo)來保持對(duì)方法的引用。比如下面的getIndex方法就是通過方法簽名來獲得方法在存儲(chǔ)了Class信息的數(shù)組中的下標(biāo)。

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

圖2.4 getIndex方法

Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析

圖2.5 FastClassInfo類中持有兩個(gè)FastClass對(duì)象的引用.png

以我們上面的sayHello方法為例,f1指向委托類對(duì)象,f2指向代理類對(duì)象,i1和i2分別代表著sayHello方法以及CGLIB$sayHello$0方法在對(duì)象信息數(shù)組中的下標(biāo)。

到此為止CGLIB動(dòng)態(tài)代理機(jī)制就介紹完了,下面給出三種代理方式之間對(duì)比。

代理方式實(shí)現(xiàn)優(yōu)點(diǎn)缺點(diǎn)特點(diǎn)
JDK靜態(tài)代理代理類與委托類實(shí)現(xiàn)同一接口,并且在代理類中需要硬編碼接口實(shí)現(xiàn)簡(jiǎn)單,容易理解代理類需要硬編碼接口,在實(shí)際應(yīng)用中可能會(huì)導(dǎo)致重復(fù)編碼,浪費(fèi)存儲(chǔ)空間并且效率很低好像沒啥特點(diǎn)
JDK動(dòng)態(tài)代理代理類與委托類實(shí)現(xiàn)同一接口,主要是通過代理類實(shí)現(xiàn)InvocationHandler并重寫invoke方法來進(jìn)行動(dòng)態(tài)代理的,在invoke方法中將對(duì)方法進(jìn)行增強(qiáng)處理不需要硬編碼接口,代碼復(fù)用率高只能夠代理實(shí)現(xiàn)了接口的委托類底層使用反射機(jī)制進(jìn)行方法的調(diào)用
CGLIB動(dòng)態(tài)代理代理類將委托類作為自己的父類并為其中的非final委托方法創(chuàng)建兩個(gè)方法,一個(gè)是與委托方法簽名相同的方法,它在方法中會(huì)通過super調(diào)用委托方法;另一個(gè)是代理類獨(dú)有的方法。在代理方法中,它會(huì)判斷是否存在實(shí)現(xiàn)了MethodInterceptor接口的對(duì)象,若存在則將調(diào)用intercept方法對(duì)委托方法進(jìn)行代理可以在運(yùn)行時(shí)對(duì)類或者是接口進(jìn)行增強(qiáng)操作,且委托類無需實(shí)現(xiàn)接口不能對(duì)final類以及final方法進(jìn)行代理底層將方法全部存入一個(gè)數(shù)組中,通過數(shù)組索引直接進(jìn)行方法調(diào)用

感謝各位的閱讀!關(guān)于“Spring中JDK和cglib動(dòng)態(tài)代理原理的示例分析”這篇文章就分享到這里了,希望以上內(nèi)容可以對(duì)大家有一定的幫助,讓大家可以學(xué)到更多知識(shí),如果覺得文章不錯(cuò),可以把它分享出去讓更多的人看到吧!

向AI問一下細(xì)節(jié)

免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI