jdk動態代理的使用及實現原理


已經畢業兩個月啦,在找工作的過程中經常有人問起spring相關的知識,尤其是spring核心aop是必不可少的,回答時總會回答spring的aop是由動態代理實現的,但是具體使用方法和原理有些模糊。spring提供了jdk動態代理,那么什么是jdk動態代理呢,jdk動態代理是java本身提供的一種代理實現,提供了一些實現jdk動態代理的重要類或接口在java.lang.reflect包下,如proxy類和InvocationHandler接口,我們先使用一下jdk動態代理,了解如何使用。jdk動態代理需要提供一個接口和接口的實現類,使用Proxy類的newProxyInstance方法得到生成的代理類,然后就可以調用這個代理類的方法啦。我的代碼結構

 

//接口提供了一個HelloReflect方法
public interface HelloReflect { void helloReflect(); }
//接口的實現
public class HelloReflectImpl implements HelloReflect{ public void helloReflect() { System.out.println("hello reflect"); } }
JDKProxy 類繼承了InvocationHandler接口,因為在Porxy類生產代理類的newProxyInstance方法中,需要三個參數,一個是類加載器,一個是實現接口的Class數組,還有一個就是InvocationHandler
的實現,重寫了InvocationHandler接口的invoke方法,生成的代理類調用方法時最終會調用這個我們重寫的invoke方法,在JDKProxy中還提供了一個getProxy方法里面使用newProxyInstance來獲得代理類

 

 

 

public class JDKProxy implements InvocationHandler {
    private Object target;
    public JDKProxy(Object target) {
        this.target=target;
    }

    public <T> T getProxy(){
        return (T) Proxy.newProxyInstance(target.getClass().getClassLoader(),target.getClass().getInterfaces(),this);
    }
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        System.out.println("輸出hello reflect之前");
        Object result=method.invoke(target,args);
        System.out.println("輸出hello reflect之后");
        return result;
    }
}

 下面是我們測試的主方法

public class TestProxy {
    public static void main(String[] args) {
        System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles","true");//將生成的代理類的字節碼文件保存到本地,后面分析原理會用到
        HelloReflect helloReflect1=new HelloReflectImpl();
        Class<?>[] arr=helloReflect1.getClass().getInterfaces();
        for(Class clazz:arr){
            System.out.println(clazz.getName());
        }
        HelloReflect helloReflect2=new JDKProxy(helloReflect1).getProxy();
        helloReflect2.helloReflect();
    }
}

 結果輸出

 

這就是jdk動態代理的使用過程,下面進行一下原理的分析

在上面我們可以知道,我們是通過Proxy類的newProxyInstance來獲取生產的代理類的,我們看一下

 

 public static Object newProxyInstance(ClassLoader loader,
                                          Class<?>[] interfaces,
                                          InvocationHandler h)
        throws IllegalArgumentException
    {
        Objects.requireNonNull(h);//檢查InvocationHandler是否為空

        final Class<?>[] intfs = interfaces.clone();//拷貝實現類實現的接口
        final SecurityManager sm = System.getSecurityManager();
        if (sm != null) {
            checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
        }

        /*
         * Look up or generate the designated proxy class.
         */
        Class<?> cl = getProxyClass0(loader, intfs); //獲取代理類的Class對象,在這個過程中,生成代理類的字節碼,並通過類加載器加載到JVN中

        /*
         * Invoke its constructor with the designated invocation handler.
         */
        try {
            if (sm != null) {
                checkNewProxyPermission(Reflection.getCallerClass(), cl);
            }

            final Constructor<?> cons = cl.getConstructor(constructorParams); //通過Class對象獲取構造器
            final InvocationHandler ih = h;
            if (!Modifier.isPublic(cl.getModifiers())) {
                AccessController.doPrivileged(new PrivilegedAction<Void>() {
                    public Void run() {
                        cons.setAccessible(true);
                        return null;
                    }
                });
            }
            return cons.newInstance(new Object[]{h}); //返回實例化的代理類,並且將我們實現的InvocationHandler作為參數傳入其中
        } 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);
        }
    }

 從上面可以看出來,通過getProxyClass0方法得到了代理類的Class對象,有了Class對象,我們就可以通過反射初始化代理類。因此在newProxyInstance方法中主要做了兩件事

1.得到代理類的Class對象

2.通過反射得到代理類的構造器並生成代理對象,然后返回

下面我們查看得到Class對象的getProxyClass0方法

 private static Class<?> getProxyClass0(ClassLoader loader,
                                           Class<?>... interfaces) {
        if (interfaces.length > 65535) {
            throw new IllegalArgumentException("interface limit exceeded");
        }
        return proxyClassCache.get(loader, interfaces);//查看緩存中是否已經有代理類的Class對象,如果沒有,進行創建
    }

 proxyClassCache.get方法中會查看緩存中是否已經存在,如果不存在,則會調用Proxy的內部類ProxyClassFactory的apply方法進行創建

 

 private static final class ProxyClassFactory
        implements BiFunction<ClassLoader, Class<?>[], Class<?>>
    {
        // prefix for all proxy class names
        private static final String proxyClassNamePrefix = "$Proxy";//代理類的名字前綴

        // next number to use for generation of unique proxy class names
        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) {
                /*
                 * Verify that the class loader resolves the name of this
                 * interface to the same Class object.
                 */
                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");
                }
                /*
                 * Verify that the Class object actually represents an
                 * interface.
                 */
                if (!interfaceClass.isInterface()) {
                    throw new IllegalArgumentException(
                        interfaceClass.getName() + " is not an interface");
                }
                /*
                 * Verify that this interface is not a duplicate.
                 */
                if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
                    throw new IllegalArgumentException(
                        "repeated interface: " + interfaceClass.getName());
                }
            }

            String proxyPkg = null;     // package to define proxy class in
            int accessFlags = Modifier.PUBLIC | Modifier.FINAL;

            /*
             * Record the package of a non-public proxy interface so that the
             * proxy class will be defined in the same package.  Verify that
             * all non-public proxy interfaces are in the same package.
             */
            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) {
                // if no non-public proxy interfaces, use com.sun.proxy package
                proxyPkg = ReflectUtil.PROXY_PACKAGE + "."; //ReflectUtil.PROXY_PACKAGE值為com.sun.proxy
            }

            /*
             * Choose a name for the proxy class to generate.
             */
            long num = nextUniqueNumber.getAndIncrement();
            String proxyName = proxyPkg + proxyClassNamePrefix + num;//創建出來代理類的名稱

            /*
             * Generate the specified proxy class.
             */
            byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
                proxyName, interfaces, accessFlags);  //生成代理類字節碼的地方
            try {
                return defineClass0(loader, proxyName,
                                    proxyClassFile, 0, proxyClassFile.length); //類加載加載到JVM中
            } catch (ClassFormatError e) {
          
                throw new IllegalArgumentException(e.toString());
            }
        }
    }

 可以看到在這類中生成了代理類的class字節碼文件,並通過類加載器加載到了JVM中,可以設置將生成的字節碼文件保存下來,在com.sun.proxy包下。generateProxyClass是具體生成字節碼的地方,因此我們在測試的main函數中設置了System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles","true");這樣就能將生成的class文件保存下來

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) { //如果設置了saveGeneratedFiles為true,則保存生成的class文件在var0下,也就是com.sun.proxy加上class文件的名稱
            AccessController.doPrivileged(new PrivilegedAction<Void>() {
                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));
                            Files.createDirectories(var3);
                            var2 = var3.resolve(var0.substring(var1 + 1, var0.length()) + ".class");
                        } else {
                            var2 = Paths.get(var0 + ".class");
                        }

                        Files.write(var2, var4, new OpenOption[0]);
                        return null;
                    } catch (IOException var4x) {
                        throw new InternalError("I/O exception saving generated file: " + var4x);
                    }
                }
            });
        }

        return var4; //返回生成的字節碼
    }

 

看生成的Proxy0.class文件

public final class $Proxy0 extends Proxy implements HelloReflect {
    private static Method m1;
    private static Method m2;
    private static Method m3;
    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 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 helloReflect() throws  {
        try {
            super.h.invoke(this, m3, (Object[])null);
        } catch (RuntimeException | 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 { //靜態代碼塊,默認重寫了hashcode,equals,toString方法,再加上接口的方法
        try {
            m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
            m2 = Class.forName("java.lang.Object").getMethod("toString");
            m3 = Class.forName("com.jinz.reflect.HelloReflect").getMethod("helloReflect");
            m0 = Class.forName("java.lang.Object").getMethod("hashCode");
        } catch (NoSuchMethodException var2) {
            throw new NoSuchMethodError(var2.getMessage());
        } catch (ClassNotFoundException var3) {
            throw new NoClassDefFoundError(var3.getMessage());
        }
    }
}

 可以看到我們在調用代理類的helloReflect方法時,實際調用了我們寫的InvocationHandler的invoke方法

 

 

 

 

 

整個jdk動態代理的過程就是這樣了


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM