拆轮子系列--java动态代理源码分析

0.前言

代理模式是常见的设计模式，通常分为普通代理模式和动态代理模式，区别就在于代理类一个是本身写的，一个是动态生成的。不管是静态代理模式仍是动态代理模式，其实结构都是相同的，看看UML类图。

（UML类图在编码设计的时候有很大做用，有时间写篇文章） 经过UML类图能够很清晰的看到代理类Proxy和被代理类RealSubject都实现了Subject接口，同时Proxy持有了RealSubject对象。经过代理类，咱们就能够在被代理类的方法执行前和执行后执行一些咱们须要的东西。动态代理就是这个Proxy是动态生成的。

1.动态代理用法

//Demo
import java.util.*;
import java.lang.reflect.*;

public class ProxyTest
{

   public static void main(String[] args)
   {

   	    System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
        Bat bat=new Bat();
        FlyableInvocationHandler handler=new FlyableInvocationHandler(bat);
        Flyable flyable= (Flyable) Proxy.newProxyInstance(Flyable.class.getClassLoader(),new Class<?>[]{Flyable.class},handler);
        flyable.fly();
   }

}

interface Flyable
{
    void fly();
}

class Bat implements Flyable
{

    @Override
    public void fly()
    {
        System.out.println("fly in dark night");
    }
}

class FlyableInvocationHandler implements InvocationHandler
{
    private Flyable flyable;

    public FlyableInvocationHandler(Flyable flyable)
    {
        this.flyable = flyable;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable
    {
        System.out.println("展翅");
        Object result = method.invoke(flyable, args);
        System.out.println("收翅");
        return result;
    }
}

复制代码

这是一个动态代理的基本用法，经过调用Proxy.newProxyInstance生成一个代理类，这个代理类如何生成的，接着就看一下Proxy.newProxyInstance这个方法

@CallerSensitive
    public static Object newProxyInstance(ClassLoader loader,
                                          Class<?>[] interfaces,
                                          InvocationHandler h)
        throws IllegalArgumentException
    {
        Objects.requireNonNull(h);

        final Class<?>[] intfs = interfaces.clone();
        // Android-changed: sm is always null
        // 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);

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

            final Constructor<?> cons = cl.getConstructor(constructorParams);
            final InvocationHandler ih = h;
            if (!Modifier.isPublic(cl.getModifiers())) {
                // Android-changed: Removed AccessController.doPrivileged
                cons.setAccessible(true);
            }
            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);
        }
    }
复制代码

首先生成代理类的Class对象

/*
         * Look up or generate the designated proxy class.
         */
        Class<?> cl = getProxyClass0(loader, intfs);
复制代码

关于这个Class对象是如何生的，咱们待会儿再说。接着往下看。

final Constructor<?> cons = cl.getConstructor(constructorParams);
            final InvocationHandler ih = h;
            if (!Modifier.isPublic(cl.getModifiers())) {
                // Android-changed: Removed AccessController.doPrivileged
                cons.setAccessible(true);
            }
            return cons.newInstance(new Object[]{h});
复制代码

经过代理类的class对象，找到其中参数类型为constructorParams的构造函数，这个constructorParams又是是什么

private static final Class<?>[] constructorParams =
        { InvocationHandler.class };
复制代码

能够看到这是一个只包含InvocationHandler.class的Class数组。到这里咱们就能够推测出，生成的代理类的某个构造函数是要传入InvocationHandler对象的，而这个InvocationHandler对象就是咱们在调用Proxy.newInstance()方法时传入的，对应Demo里的FlyableInvocationHandler。以后就是调用该构造函数传入InvocationHandler参数构造一个对象并返回。

2.代理类的生成

上面说了，代理类的Class对象是由

Class<?> cl = getProxyClass0(loader, intfs);
复制代码

生成的。那么接着看看这个getProxyClass0方法

private static Class<?> getProxyClass0(ClassLoader loader,
                                           Class<?>... interfaces) {
        if (interfaces.length > 65535) {
            throw new IllegalArgumentException("interface limit exceeded");
        }

        // If the proxy class defined by the given loader implementing
        // the given interfaces exists, this will simply return the cached copy;
        // otherwise, it will create the proxy class via the ProxyClassFactory
        return proxyClassCache.get(loader, interfaces);
    }
复制代码

首先是一个65535的判断，若是接口数组的大小超过65535，就会报错，至于为何是65535，不太清楚， 接着就是调用这个方法proxyClassCache.get(loader, interfaces)返回class对象，这个proxyClassCache是Proxy的一个成员变量

private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
        proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());
复制代码

这里你能够理解为代理类的缓存，咱们重点关注的就是ProxyClassFactory这个类，从名字也能够看出，这就是咱们要找的生成代理类Class对象的地方。

/**
     * A factory function that generates, defines and returns the proxy class given
     * the ClassLoader and array of interfaces.
     */
    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 the default package.
                proxyPkg = "";
            }

            {
                // Android-changed: Generate the proxy directly instead of calling
                // through to ProxyGenerator.
                List<Method> methods = getMethods(interfaces);
                Collections.sort(methods, ORDER_BY_SIGNATURE_AND_SUBTYPE);
                validateReturnTypes(methods);
                List<Class<?>[]> exceptions = deduplicateAndGetExceptions(methods);

                Method[] methodsArray = methods.toArray(new Method[methods.size()]);
                Class<?>[][] exceptionsArray = exceptions.toArray(new Class<?>[exceptions.size()][]);

                /*
                 * Choose a name for the proxy class to generate.
                 */
                long num = nextUniqueNumber.getAndIncrement();
                String proxyName = proxyPkg + proxyClassNamePrefix + num;

                return generateProxy(proxyName, interfaces, loader, methodsArray,
                                     exceptionsArray);
            }
        }
    }
复制代码

接下来分析一下这个方法

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

复制代码

这段代码就是用来生验证类加载器是否解析了此名称接口到同一个Class对象。其中有一行代码

if (!interfaceClass.isInterface()) {
                    throw new IllegalArgumentException(
                        interfaceClass.getName() + " is not an interface");
                }
复制代码

判断Class对象是不是接口类型，这就要求咱们调用Proxy.newInstance方法时传入的Class<?>[] interfaces是接口的class对象。 剩下的代码使用来得到代理类的包名，代理类的名称以及代理类的Method数组，就再也不细说了。最终调用

generateProxy(proxyName, interfaces, loader, methodsArray,
                                     exceptionsArray);
复制代码

生成代理类的Class对象，这个方法是一个native方法，就不进去再看了，分析到这里也差很少了。

3.代理类字节码

想要输出动态代理生成的字节码文件默认是不输出的，想输出到存储空间调用

System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
复制代码

反编译字节码

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 Flyable
{
  private static Method m1;
  private static Method m3;
  private static Method m2;
  private static Method m0;
  
  public $Proxy0(InvocationHandler paramInvocationHandler)
  {
    super(paramInvocationHandler);
  }
  
  public final boolean equals(Object paramObject)
  {
    try
    {
      return ((Boolean)this.h.invoke(this, m1, new Object[] { paramObject })).booleanValue();
    }
    catch (Error|RuntimeException localError)
    {
      throw localError;
    }
    catch (Throwable localThrowable)
    {
      throw new UndeclaredThrowableException(localThrowable);
    }
  }
  
  public final void fly()
  {
    try
    {
      this.h.invoke(this, m3, null);
      return;
    }
    catch (Error|RuntimeException localError)
    {
      throw localError;
    }
    catch (Throwable localThrowable)
    {
      throw new UndeclaredThrowableException(localThrowable);
    }
  }
  
  public final String toString()
  {
    try
    {
      return (String)this.h.invoke(this, m2, null);
    }
    catch (Error|RuntimeException localError)
    {
      throw localError;
    }
    catch (Throwable localThrowable)
    {
      throw new UndeclaredThrowableException(localThrowable);
    }
  }
  
  public final int hashCode()
  {
    try
    {
      return ((Integer)this.h.invoke(this, m0, null)).intValue();
    }
    catch (Error|RuntimeException localError)
    {
      throw localError;
    }
    catch (Throwable localThrowable)
    {
      throw new UndeclaredThrowableException(localThrowable);
    }
  }
  
  static
  {
    try
    {
      m1 = Class.forName("java.lang.Object").getMethod("equals", new Class[] { Class.forName("java.lang.Object") });
      m3 = Class.forName("Flyable").getMethod("fly", new Class[0]);
      m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);
      m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);
      return;
    }
    catch (NoSuchMethodException localNoSuchMethodException)
    {
      throw new NoSuchMethodError(localNoSuchMethodException.getMessage());
    }
    catch (ClassNotFoundException localClassNotFoundException)
    {
      throw new NoClassDefFoundError(localClassNotFoundException.getMessage());
    }
  }
}

复制代码

和咱们设想的同样，代理类持有了InvocationHandler对象，同时实现了传入的Interface接口，能够看到fly方法里调用了InvocationHandler的invoke方法，传入了this指针，方法method和参数null。

4.应用

至此动态代理基本上就分析完了，动态代理最多见的用处可能就是AOP编程了，在不改变已有类的状况下生成代理添加新的逻辑，有兴趣的能够看一下AOP编程。

关注个人公众号