jdk动态代理实现原理

jdk动态代理实现原理

jdk动态代理是基于接口实现，动态代理是生成新的class代理类。将原本调用的方法，改为调用代理类的方法。代理方法中可以做一些增强操作。

jdk动态代理的简单实现。

被代理的接口

/**
 * jdk被代理的接口
 */
public interface JDKProxy {
    /**
     * 被代理的方法
     */
    void proxyMethod();
    public void proxyMethod2();
}

被代理的接口的实现类

public class JDKProxyImpl implements JDKProxy{
    @Override
    public void proxyMethod() {
        // 被代理方法的实现类
        System.out.println("这是被代理类的实现方法");
    }
    @Override
    public void proxyMethod2() {
        // 被代理方法的实现类
        System.out.println("这是被代理类的实现方法2");
    }
}

动态代理实现

/**
 * jdk动态代理类
 */
public class MyProxy {
    public static void main(String[] args) {
        JDKProxy jdkProxy = new JDKProxyImpl();
        JDKProxy o = (JDKProxy)Proxy.newProxyInstance(jdkProxy.getClass().getClassLoader(), new Class[]{JDKProxy.class}, new ProxyHandler(jdkProxy));
        o.proxyMethod();
        o.proxyMethod2();
        }
    }

class ProxyHandler implements InvocationHandler{
    private Object object;
    public ProxyHandler(JDKProxy jdkProxy) {
        this.object = jdkProxy;
    }
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

        System.out.println("被代理方法执行之前执行，方法名字：" + method.getName());
        Object invoke = method.invoke(object, args);
        System.out.println("被代理方法执行之后执行，参数名称：" + args);
        return invoke;
    }
}

执行结果

被代理方法执行之前执行，方法名字：proxyMethod
这是被代理类的实现方法
被代理方法执行之后执行，参数名称：null
被代理方法执行之前执行，方法名字：proxyMethod2
这是被代理类的实现方法2
被代理方法执行之后执行，参数名称：null

jdk动态代理源码解析

Java的动态代理其实很简单，和静态代理类似；静态代理是重新写一个接口的实现类，写同样的方法，再在方法里面调用被代理类的方法，当然在这个方法执行前后可以做一些增强操作。动态代理也是一样的操作，它也会生成一个代理类实现被代理的接口，当你调用接口方法的时候，其实他执行的invoke方法，同时把你调用的方法名，参数传递过去，而我们需要从写invoke方法，在方法里面实现增强操作，实际方法的调用也是在invoke方法里面执行的。下面就看看，代理类的具体生成的大致过程。

Proxy类里面的newProxyInstance方法。

 @CallerSensitive
    public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h) throws IllegalArgumentException{
        // 检查h是否为空
        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);
        // 使用指定的调用处理程序调用其构造函数。
        try {
            if (sm != null) {
                checkNewProxyPermission(Reflection.getCallerClass(), cl);
            }
            final Constructor<?> cons = cl.getConstructor(constructorParams);
            final InvocationHandler ih = h;
            // 判断是不是public类型的
            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) {
            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);
        }
    }

Proxy类的getProxyClass0()方法

    //生成一个代理类。在调用此方法之前，必须调用checkProxyAccess方法来执行权限检查。
    private static Class<?> getProxyClass0(ClassLoader loader,
                                           Class<?>... interfaces) {
        if (interfaces.length > 65535) {
            throw new IllegalArgumentException("interface limit exceeded");
        }

        //如果实现给定接口的给定装入器定义的代理类存在，这将简单地返回缓存副本;否则，它将通过ProxyClassFactory创建代理类
        return proxyClassCache.get(loader, interfaces);
    }

WeakCache类的get()方法。

    /**
     * 通过缓存查找值。它总是对subKeyFactory函数求值，如果给定的(key, subKey)对的缓存中没有条目，
     * 或者条目已经被清除，则可选地对valueFactory函数求值。
     *
     * @param key       可能是空键
     * @param parameter 参数与键一起使用以创建子键和值(不应为空)
     * @return 缓存的值(从不为空)
     * @throws NullPointerException if {@code parameter} passed in or
     *                              {@code sub-key} calculated by
     *                              {@code subKeyFactory} or {@code value}
     *                              calculated by {@code valueFactory} is null.
     */
    public V get(K key, P parameter) {
        Objects.requireNonNull(parameter);
        expungeStaleEntries();
        Object cacheKey = CacheKey.valueOf(key, refQueue);
        // 惰性地为特定的cacheKey安装第二层valuesMap
        ConcurrentMap<Object, Supplier<V>> valuesMap = map.get(cacheKey);
        if (valuesMap == null) {
            ConcurrentMap<Object, Supplier<V>> oldValuesMap
                = map.putIfAbsent(cacheKey,
                                  valuesMap = new ConcurrentHashMap<>());
            if (oldValuesMap != null) {
                valuesMap = oldValuesMap;
            }
        }

        // 创建subKey并从valuesMap中检索由该subKey存储的可能的Supplier<V>
        Object subKey = Objects.requireNonNull(subKeyFactory.apply(key, parameter));
        Supplier<V> supplier = valuesMap.get(subKey);
        Factory factory = null;

        while (true) {
            if (supplier != null) {
                // supplier可能是Factory或CacheValue<V>实例
                V value = supplier.get(); // 《《这步获取代理类》》
                if (value != null) {
                    return value;
                }
            }
            //否则缓存中没有供应商或供应商返回null(可能是一个清除的CacheValue或一个工厂没有成功安装CacheValue)
            // lazily construct a Factory
            if (factory == null) {
                factory = new Factory(key, parameter, subKey, valuesMap);
            }

            if (supplier == null) {
                supplier = valuesMap.putIfAbsent(subKey, factory);
                if (supplier == null) {
                    // successfully installed Factory
                    supplier = factory;
                }
                // else retry with winning supplier
            } else {
                if (valuesMap.replace(subKey, supplier, factory)) {
                    // successfully replaced
                    // cleared CacheEntry / unsuccessful Factory
                    // with our Factory
                    supplier = factory;
                } else {
                    // retry with current supplier
                    supplier = valuesMap.get(subKey);
                }
            }
        }
    }

然后调用的是Supplier接口实现类Factory类的get方法,Factorys实现类是WeakCache类的静态内部类。

 @Override
        public synchronized V get() { // serialize access
            // re-check
            Supplier<V> supplier = valuesMap.get(subKey);
            if (supplier != this) {
                // something changed while we were waiting:
                // might be that we were replaced by a CacheValue
                // or were removed because of failure ->
                // return null to signal WeakCache.get() to retry
                // the loop
                return null;
            }
            // else still us (supplier == this)

            // create new value
            V value = null;
            try {
                // <<<<<<<<<<<创建代理类>>>>>>>>>>>
                value = Objects.requireNonNull(valueFactory.apply(key, parameter));
            } finally {
                if (value == null) { // remove us on failure
                    valuesMap.remove(subKey, this);
                }
            }
            // the only path to reach here is with non-null value
            assert value != null;

            // wrap value with CacheValue (WeakReference)
            CacheValue<V> cacheValue = new CacheValue<>(value);

            // put into reverseMap
            reverseMap.put(cacheValue, Boolean.TRUE);

            // try replacing us with CacheValue (this should always succeed)
            if (!valuesMap.replace(subKey, this, cacheValue)) {
                throw new AssertionError("Should not reach here");
            }

            // successfully replaced us with new CacheValue -> return the value
            // wrapped by it
            return value;
        }
    }

然后调用的是BiFunction接口的实现类ProxyClassFactory里面的apply方法，ProxyClassFactory是Proxy类的内部类。

@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 + ".";
            }

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

最终就是通过ProxyGenerator类的generateProxyClass方法生成的代理类，方法的实现大致是，通过反射获取到被代理类的信息，然后根据一定规则生成代理类。最终生成类的本地方法：

    private static native Class<?> defineClass0(ClassLoader loader, String name,
                                            byte[] b, int off, int len);

代理类是默认直接加载在内存中的，看不到具体文件，通过一下源码可以发现，其实是可以生成文件的，但是需要手动配置；

// 是否生成文件参数控制参数
private static final boolean saveGeneratedFiles = (Boolean)AccessController.doPrivileged(new GetBooleanAction("sun.misc.ProxyGenerator.saveGeneratedFiles"));


public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
    ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
    final byte[] var4 = var3.generateClassFile();
    // saveGeneratedFiles控制是否输入文件
    if (saveGeneratedFiles) {
        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;
}

可以在动态代理生成之前添加配置：

public class MyProxy {
    public static void main(String[] args) {
        JDKProxy jdkProxy = new JDKProxyImpl();
        // 此配置生成动态代理类
        System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
        JDKProxy o = (JDKProxy)Proxy.newProxyInstance(jdkProxy.getClass().getClassLoader(), new Class[]{JDKProxy.class}, new ProxyHandler(jdkProxy));
        o.proxyMethod();
        o.proxyMethod2();
    }
}

具体生成的代理类：

import com.lbh.demo.proxy.JDKProxy;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;

public final class $Proxy0 extends Proxy implements JDKProxy {
    private static Method m1;
    private static Method m2;
    private static Method m4;
    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 proxyMethod2() throws  {
        try {
            super.h.invoke(this, m4, (Object[])null);
        } catch (RuntimeException | Error var2) {
            throw var2;
        } catch (Throwable var3) {
            throw new UndeclaredThrowableException(var3);
        }
    }

    public final void proxyMethod() 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 {
        try {
            m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
            m2 = Class.forName("java.lang.Object").getMethod("toString");
            m4 = Class.forName("com.lbh.demo.proxy.JDKProxy").getMethod("proxyMethod2");
            m3 = Class.forName("com.lbh.demo.proxy.JDKProxy").getMethod("proxyMethod");
            m0 = Class.forName("java.lang.Object").getMethod("hashCode");
        } catch (NoSuchMethodException var2) {
            throw new NoSuchMethodError(var2.getMessage());
        } catch (ClassNotFoundException var3) {
            throw new NoClassDefFoundError(var3.getMessage());
        }
    }
}