1. JDK动态代理的简单实现

首先我们写个简单的代理实现：

package com.siyi.proxypattern;import java.lang.reflect.InvocationHandler;import java.lang.reflect.Method;import java.lang.reflect.Proxy;public class JDKProxy {    public static void main(String[] args) {        Subject subject = new ConcreteSubject();        /**         * Object newProxyInstance(ClassLoader loader, Class
   [] interfaces, InvocationHandler h)         * loader: 指定类加载器，一般和被代理对象使用相同的类加载器。         * interfaces: 生成的代理对象需要实现的接口。         * h: 调用时处理器对象，实现其invoke方法来进行方法增强。         * return: 返回代理后的对象         */        Subject s = (Subject) Proxy.newProxyInstance(ConcreteSubject.class.getClassLoader(),                new Class[]{Subject.class},                new InvocationHandler() {                    /**                     * 执行被代理对象的任何接口方法都会经过该方法                     * @param proxy 代理生成的对象，一般情况用不到，当然有时可以通过proxy来调用其他被代理的方法                     * @param method 正在执行的方法对象                     * @param args 执行方法所传入的参数                     * @return 执行成功后一般返回null                     * @throws Throwable                     */                    @Override                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {                        System.out.println("Before...");                        Object o = method.invoke(subject, args);                        System.out.println("after...");                        return o;                    }                });        s.fun();    }}interface Subject{    void fun();}class ConcreteSubject implements Subject{    @Override    public void fun() {        System.out.println("fun...");    }}

运行结果：

2. 代理后的调用逻辑

当我们想要看到代理后的调用逻辑时，最简单的方法就是看看代理后的对象。那么我们需要稍微改一下上面的代码，使我们能看到代理后的对象代码。

package com.siyi.proxypattern;import java.lang.reflect.InvocationHandler;import java.lang.reflect.Method;import java.lang.reflect.Proxy;public class JDKProxy {    public static void main(String[] args) {        Subject subject = new ConcreteSubject();        //保存生成的代理类的字节码文件        System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");        /**         * Object newProxyInstance(ClassLoader loader, Class
   [] interfaces, InvocationHandler h)         * loader: 指定类加载器，一般和被代理对象使用相同的类加载器。         * interfaces: 生成的代理对象需要实现的接口。         * h: 调用时处理器对象，实现其invoke方法来进行方法增强。         * return: 返回代理后的对象         */        Subject s = (Subject) Proxy.newProxyInstance(ConcreteSubject.class.getClassLoader(),                new Class[]{Subject.class},                new InvocationHandler() {                    /**                     *                     * @param proxy 代理生成的对象，一般情况用不到，当然有时可以通过proxy来调用其他被代理的方法                     * @param method 正在执行的方法对象                     * @param args 执行方法所传入的参数                     * @return 执行成功后一般返回null                     * @throws Throwable                     */                    @Override                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {                        System.out.println("Before...");                        Object o = method.invoke(subject, args);                        System.out.println("after...");                        return o;                    }                });        s.fun();    }}interface Subject{    void fun();}class ConcreteSubject implements Subject{    @Override    public void fun() {        System.out.println("fun...");    }}

我们新增了一行：

//保存生成的代理类的字节码文件System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");

我用的是jdk8，所以用上面那句。如果是jdk11的话请用下面这句：

System.getProperties().put("jdk.proxy.ProxyGenerator.saveGeneratedFiles", "true");

这样我们就能把代理生成的字节码文件保存下来了，然后凭借IDEA的自动反编译，我们就可以看到一个大概的代理类了。

运行结束后，我们发现生成了一个$Proxy.class文件，这就是我们需要查看的文件了。

//// Source code recreated from a .class file by IntelliJ IDEA// (powered by Fernflower decompiler)//package com.siyi.proxypattern;import java.lang.reflect.InvocationHandler;import java.lang.reflect.Method;import java.lang.reflect.Proxy;import java.lang.reflect.UndeclaredThrowableException;final class $Proxy0 extends Proxy implements Subject {    private static Method m1;    private static Method m3;    private static Method m2;    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 fun() throws  {        try {            super.h.invoke(this, m3, (Object[])null);        } catch (RuntimeException | 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 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("com.siyi.proxypattern.Subject").getMethod("fun");            m2 = Class.forName("java.lang.Object").getMethod("toString");            m0 = Class.forName("java.lang.Object").getMethod("hashCode");        } catch (NoSuchMethodException var2) {            throw new NoSuchMethodError(var2.getMessage());        } catch (ClassNotFoundException var3) {            throw new NoClassDefFoundError(var3.getMessage());        }    }}

当我们new这个代理对象时，肯定会调用其构造方法，那么我们观察可知，其构造方法传入了一个调用时处理器对象。即我们在代码中new的那个匿名对象。

那么我们需要查看其父类，使用什么来接收这个调用时处理器对象了。

由此可知，在Proxy类中存在一个成员变量h来接收我们写的调用时处理器对象。

那么现在我们将重点放在fun()方法上，其他方法我们就暂时不在意了。我们可以看到fun()方法实际上调用的是父类Proxy的成员变量h的invoke方法。那么这不就是我们写匿名对象时实现的方法吗

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {    System.out.println("Before...");    Object o = method.invoke(subject, args);    System.out.println("after...");    return o;}

我们也可以看到代理对象中传入的参数分别是this,m3,null。

那么这就迎合上前面我们所说的invoke参数代表的含义了。同时我们也明白了方法是怎么增强的。

那么下面我们只需要去搞清楚这个代理对象是如何被创建出来的了。

3. JDK动态代理的实现流程

首先，我们需要从newProxyInstance()方法入手。

@CallerSensitive    public static Object newProxyInstance(ClassLoader loader,                                          Class
   [] interfaces,                                          InvocationHandler h)        throws IllegalArgumentException    {        //判断InvocationHandler是否为空，若为空，抛出空指针异常        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);        /*         * 使用自定义的InvocationHandler作为参数，调用构造函数获取代理类对象实例         */        try {            if (sm != null) {                checkNewProxyPermission(Reflection.getCallerClass(), cl);            }            final Constructor
    cons = cl.getConstructor(constructorParams);            final InvocationHandler ih = h;            if (!Modifier.isPublic(cl.getModifiers())) {                AccessController.doPrivileged(new PrivilegedAction
   
    () {                    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);        }    }

很容易看出我们重点的执行逻辑是在getProxyClass0()方法。

/**     * 代理类的缓存     */    private static final WeakCache
   
    [], Class
    >        proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());    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);    }

其中缓存使用的是WeakCache实现的，此处主要关注使用ProxyClassFactory创建代理的情况。ProxyClassFactory是Proxy类的静态内部类，实现了BiFunction接口，实现了BiFunction接口中的apply方法。

当WeakCache中没有缓存相应接口的代理类，则会调用ProxyClassFactory类的apply方法来创建代理类。

private static final class ProxyClassFactory            implements BiFunction
   
    [], Class
    >    {        // 代理类前缀        private static final String proxyClassNamePrefix = "$Proxy";        // 生成代理类名称的计数器        private static final AtomicLong nextUniqueNumber = new AtomicLong();        @Override        public Class
     apply(ClassLoader loader, Class
    [] interfaces) {            Map
    
     , Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length);            for (Class
      intf : interfaces) {                /*                 * 校验类加载器是否能通过接口名称加载该类                 */                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");                }                /*                 * 校验该类是否是接口类型                 */                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;     // 代理类包名            int accessFlags = Modifier.PUBLIC | Modifier.FINAL;            /*             * 非public接口，代理类的包名与接口的包名相同             */            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) {                // public代理接口，使用com.sun.proxy包名                proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";            }            /*             * 为代理类生成名字             */            long num = nextUniqueNumber.getAndIncrement();            String proxyName = proxyPkg + proxyClassNamePrefix + num;            /*             * 真正生成代理类的字节码文件的地方             */            byte[] proxyClassFile = ProxyGenerator.generateProxyClass(                    proxyName, interfaces, accessFlags);            try {                // 使用类加载器将代理类的字节码文件加载到JVM中                return defineClass0(loader, proxyName,                        proxyClassFile, 0, proxyClassFile.length);            } catch (ClassFormatError e) {                throw new IllegalArgumentException(e.toString());            }        }    }

在ProxyClassFactory类的apply方法中可看出真正生成代理类字节码的地方是ProxyGenerator类中的generateProxyClass，该类未开源，但是可以使用IDEA、或者反编译工具jd-gui来查看。

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));                            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;    }

通过查看反编译的代码我们可以发现重点可以放在generateClassFile()上。

private byte[] generateClassFile() {        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);        }        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();                    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() > 65535) {            throw new IllegalArgumentException("method limit exceeded");        } else if (this.fields.size() > 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);            }        }    }

当然，没必要全看完，我们只需要抓住其中几个有趣的点即可：

this.addProxyMethod(hashCodeMethod, Object.class);        this.addProxyMethod(equalsMethod, Object.class);        this.addProxyMethod(toStringMethod, Object.class);            this.methods.add(this.generateConstructor());

通过变量名以及方法名我们可以知道，这实际上就是添加hashCode(),equals(),toString()以及我们的fun方法。具体源码我就不粘贴了。

在测试案例中，设置系统属性sun.misc.ProxyGenerator.saveGeneratedFiles值为true

// 保存生成的代理类的字节码文件 System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");

所以我们现在可以保存代理对象的.class文件。

最终我们可以看到：

代理类继承了Proxy类并且实现了要代理的接口，由于java不支持多继承，所以JDK动态代理不能代理类

重写了equals、hashCode、toString

有一个静态代码块，通过反射或者代理类的所有方法

通过invoke执行代理类中的目标方法doSomething

转载地址：http://mryof.baihongyu.com/

你可能感兴趣的文章