JDK动态代理的原理与底层实现

动态代理是许多框架底层实现的基础，比如Spirng的AOP、RPC框架Dubbo等，其实弄清楚了动态代理的实现原理，它就没那么神奇了，下面就来通过案例和分析JDK底层源码来揭秘她的神秘面纱。

代理模式定义

这里只是简单说明一下代理模式，代理模式是指存在一个代理对象，并且这个代理对象持有真实对象的引用，以实现对真实对象的访问控制。

代理模式的分类

静态代理

该代理对象持有被代理对象的引用，客户端通过调用代理对象的方法间接实现调用真实对象的方法。代理对象可以在调用真实对象的方法前面加入一些操作：比如身份验证，权限验证，记录日志等。

通过一个示例说明
定义一个接口

public interface IUserService {

    void sayHello(String name);

    void sayBye(String name);
}

接口实现

public class UserServiceImpl implements IUserService {

    @Override
    public void sayHello(String name) {
        System.out.println("Hello " + name);
    }

    @Override
    public void sayBye(String name) {
        System.out.println("Bye " + name);
    }
}

静态代理类，实现同样的接口，包含一个真实对象的引用

public class StaticProxy implements IUserService{

    private IUserService target;

    public StaticProxy(IUserService target) {
        this.target = target;
    }

    @Override
    public void sayHello(String name) {
        System.out.println("StaticProxy before sayHello......");
        target.sayHello(name);
    }

    @Override
    public void sayBye(String name) {
        System.out.println("StaticProxy before sayBye......");
        target.sayBye(name);
    }
}

测试

public class JdkProxyTest {

    public static void main(String[] args){
        testStaticProxy();
    }

    public static void testStaticProxy() {
        IUserService userService = new UserServiceImpl();
        StaticProxy proxy = new StaticProxy(userService);
        proxy.sayHello("andy");
        proxy.sayBye("andy");

    }
}

执行结果

StaticProxy before sayHello......
Hello andy
StaticProxy before sayBye......
Bye andy

在代理对象中对每个真实对象方法执行之前和之后都可以加入额外的操作，如果这些操作都是相同的操作，那么每个方法都要写一遍且不是很麻烦，所以这就需要使用动态代理来解决。

动态代理

动态的生成代理类，而不用像静态代理一样，在编译期间进行定义类。动态代理更加灵活，不用显示的在所有方法前面或者后面加入权限验证、记录日志等操作。其接口和实现与静态代理一样，不同的是代理对象的生成。

静态代理是直接新增一个代理类，而动态代理则不是。动态代理是通过JDK的Proxy和一个调用处理器InvocationHandler来实现的，通过Proxy来生成代理类实例，而这个代理实例通过调用处理器InvocationHandler接收不同的参数灵活调用真实对象的方法。

所以我们需要做的是创建调用处理器，该调用处理器必须实现JDK的InvocationHandler

public class DynamicProxyHandler implements InvocationHandler {

    private IUserService target;

    public DynamicProxyHandler(IUserService target) {
        this.target = target;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        Object result = null;
        System.out.println("++++++before " + method.getName() + "++++++");
        result = method.invoke(target, args);
        System.out.println("++++++after " + method.getName() + "++++++");
        return result;
    }

    public Object getProxy(){
        /*
         * Proxy.newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h)
         * 方法的第一个参数的作用就是 获取当前类的类加载器,作用是用来生成类的
         * 第二个参数是获取真实对象的所有接口    获取所有接口的目的是用来生成代理的,因为代理要实现所有的接口
         * 第三个参数是 调用处理器  这里传入调用处理器，是因为生成代理实例需要 调用处理器    为什么需要调用处理器，因为生成的代理不能直接调用真实对象的方法,
         * 而是通过调用处理器来调用真实对象的方法，具体就是通过上面定义的DynamicProxyHandler重写父类InvocationHandler的invoke方法
         */
        return  Proxy.newProxyInstance(this.getClass().getClassLoader(), target.getClass().getInterfaces(), this );
    }

}

方法：Proxy.newProxyInstance(ClassLoader loader,Class<?>[] interfaces, InvocationHandler h)

方法的第一个参数ClassLoader是类加载器,作用是用来生成类的

第二个参数interfaces是获取真实对象的所有接口，获取所有接口的目的是用来生成代理的,因为代理要实现所有的接口

第三个参数InvocationHandler是调用处理器,这里传入调用处理器，是因为生成代理实例需要调用处理器,至于为什么需要调用处理器，是因为生成的代理不能直接调用真实对象的方法,而是通过调用处理器来调用真实对象的方法，具体就是上面DynamicProxyHandler重写父类的InvocationHandler的invoke方法来调用真实对象的方法。为什么是这样，后面再分析，先来看客户端怎么调用

public static void main(String[] args){
//        testStaticProxy();
   testDynamicProxy();
}

public static void testDynamicProxy() {
   DynamicProxyHandler handler = new DynamicProxyHandler(new UserServiceImpl());
   IUserService userService = (IUserService) handler.getProxy();
   userService.sayHello("jeck");
   userService.sayBye("jeck");

}

执行结果

++++++before sayHello++++++
Hello jeck
++++++after sayHello++++++
++++++before sayBye++++++
Bye jeck
++++++after sayBye++++++

JDK动态代理是如何实现的？

JDK在运行期间帮我们生成了一个代理类的字节码，通过类加载器加载这个字节码，然后执行引擎进行一系列处理后生成代理类，再进行实例化。

下面通过源码来具体分析，JDK7和JDK8实现方式有点区别，但是原理都是相通的，这里主要以JDK8来分析

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

    final Class<?>[] intfs = interfaces.clone();
   //生成代理Class对象
    Class<?> cl = getProxyClass0(loader, intfs);

    try {
       //代理对象的构造方法
        final Constructor<?> cons = cl.getConstructor(constructorParams);
        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});
    } catch (IllegalAccessException|InstantiationException e) {

    }
}

获取代理Class对象的实现

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

private static Class<?> getProxyClass0(ClassLoader loader,
                                           Class<?>... interfaces) {
     ……
    return proxyClassCache.get(loader, interfaces);
}

//WeakCache
public V get(K key, P parameter) {
   。。。
    V value = supplier.get();
    。。。
}

这个方法中的supplier.get()方法就是生成了代理类，我们进入看下get()方法，

public synchronized V get() { // serialize access
 // re-check
     。。。
      value = Objects.requireNonNull(valueFactory.apply(key, parameter));
     。。。
}

这个同步的方法就是生成代理类的，其中的valueFactory就是我们之前提到了能生成代理类的工厂类，ProxyClassFactory()，我们进入apply方法：

public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {
       Map<Class<?>, 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");
            }
            /*
             * 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 + ".";
        }

        /*
         * 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 {
            //返回代理Class对象
            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());
        }
    }
}

下面来分析动态代理对象是如何调用处理类来实现加入额外处理逻辑的，额外的处理我们在InvocationHandler的invoke方法中加入并调用目标对象的方法，而InvocationHandler的invoke方法是在哪里调用的呢？

首先我们看看JDK生成的代理对象是什么样的，通过一个工具类输出代理对象class

/**
 * 代理类的生成工具
 */
public class ProxyGeneratorUtils {

    /**
     * 把代理类的字节码写到硬盘上
     * @param path 保存路径
     */
    public static void writeProxyClassToHardDisk(String path) {

        // 获取代理类的字节码
        byte[] classFile = ProxyGenerator.generateProxyClass("$Proxy11", UserServiceImpl.class.getInterfaces());

        FileOutputStream out = null;

        try {
            out = new FileOutputStream(path);
            out.write(classFile);
            out.flush();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                out.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

生成的代理对象class如下

import com.github.sources.proxy.service.IUserService;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;

public final class $Proxy11 extends Proxy implements IUserService {
    private static Method m1;
    private static Method m3;
    private static Method m2;
    private static Method m4;
    private static Method m0;

    //构造方法中传入处理对象
    public $Proxy11(InvocationHandler var1) throws  {
        super(var1);
    }

    public final boolean equals(Object var1) throws  {
        try {
            return ((Boolean)super.h.invoke(this, m1, new Object[]{var1})).booleanValue();
        } catch (RuntimeException | Error var3) {
            throw var3;
        } catch (Throwable var4) {
            throw new UndeclaredThrowableException(var4);
        }
    }

    //实现了相同的接口，通过处理对象的invoke方法调用
    public final void sayHello(String var1) throws  {
        try {
            super.h.invoke(this, m3, 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 sayBye(String var1) throws  {
        try {
            super.h.invoke(this, m4, new Object[]{var1});
        } catch (RuntimeException | Error var3) {
            throw var3;
        } catch (Throwable var4) {
            throw new UndeclaredThrowableException(var4);
        }
    }

    public final int hashCode() throws  {
        try {
            return ((Integer)super.h.invoke(this, m0, (Object[])null)).intValue();
        } catch (RuntimeException | Error var2) {
            throw var2;
        } catch (Throwable var3) {
            throw new UndeclaredThrowableException(var3);
        }
    }

    static {
        try {
            m1 = Class.forName("java.lang.Object").getMethod("equals", new Class[]{Class.forName("java.lang.Object")});
            m3 = Class.forName("com.github.sources.proxy.service.IUserService").getMethod("sayHello", new Class[]{Class.forName("java.lang.String")});
            m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);
            m4 = Class.forName("com.github.sources.proxy.service.IUserService").getMethod("sayBye", new Class[]{Class.forName("java.lang.String")});
            m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);
        } catch (NoSuchMethodException var2) {
            throw new NoSuchMethodError(var2.getMessage());
        } catch (ClassNotFoundException var3) {
            throw new NoClassDefFoundError(var3.getMessage());
        }
    }
}