SpringAOP--JDK动态代理源码解析

一，示例代码

上一篇我们学习了代理模式、静态代理和动态代理。这一篇我们一起来通过示例代码分析下JDK动态代理的源码，搞懂JDK动态代理背后的原理。

public class DynamicProxy implements InvocationHandler {
    private Object target;

    public Object newProxy(Object object) {
        this.target = object;
        return Proxy.newProxyInstance(target.getClass().getClassLoader(),
                target.getClass().getInterfaces(), this);
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        before();
        Object ret = method.invoke(this.target, args);
        after();
        return ret;
    }

    private void before() {
        System.out.println("开始时间: " + System.currentTimeMillis());
    }

    private void after() {
        System.out.println("结束时间: " + System.currentTimeMillis());
    }

    public static void main(String[] args) {
        // 该段注释主要用于观察生成的代理类。代理类生成在com.sun.proxy下（接口为public的情况下）
        // System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
        UserService userService = (UserService) new DynamicProxy().newProxy(new UserServiceImpl());
        userService.delete(1);
        userService.save("zhangsan", 28);

        Test1Service test1Service = (Test1Service) new DynamicProxy().newProxy(new TestServiceImpl());
        test1Service.test1();

        Test2Service test2Service = (Test2Service) new DynamicProxy().newProxy(new TestServiceImpl());
        test2Service.test2();

        AccountService accountService = (AccountService) new DynamicProxy().newProxy(new AccountServiceImpl());
        accountService.login();
    }
}

二，JDK动态代理源码解析

动态代理的中心原理可以用一句话总结概括：动态生成静态代理类（静态代理类我们在上一篇已经学过）

Proxy#newProxyInstance()

该函数的主要目的用于返回指定接口的代理类实例。该实例将方法的调用调度到指定的程序处理器（InvocationHandler）。

public static Object newProxyInstance(ClassLoader loader,
                                          Class<?>[] interfaces,
                                          InvocationHandler h)
        throws IllegalArgumentException
{
    // 检查指定的对象是否为null
    // requireNonNull方法主要用于在方法和构造函数中进行参数验证
    Objects.requireNonNull(h);

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

    // 查找或生成指定的代理类
    // 如果指定加载器和接口定义的代理类存在，则将仅返回缓存的副本；否则，通过ProxyClassFactory创建代理类
    Class<?> cl = getProxyClass0(loader, intfs);

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

WeakCache#get()

该函数主要用户在缓存中查找已经缓存过的Proxy代理对象。如果缓存中没有，或者该条目已被清除，则使用valueFactory来生成新的值（value）。

public V get(K key, P parameter) {
    Objects.requireNonNull(parameter);

    // 清除无效的缓存条目
    expungeStaleEntries();

    // 构造缓存Key
    Object cacheKey = CacheKey.valueOf(key, refQueue);

    // 从Map中根据key获取值
    // map是一个ConcurrentMap中嵌套ConcurrentMap的结构
    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
    // valuesMap是map中根据key查找出来的ConcurrentMap，它的key是接口，而value则是$Proxy代理类的工厂
    Object subKey = Objects.requireNonNull(subKeyFactory.apply(key, parameter));
    Supplier<V> supplier = valuesMap.get(subKey);
    Factory factory = null;

    while (true) {
        // 如果缓存的value不为空
        if (supplier != null) {
            // supplier可能是一个工厂或者是CacheValue的实例
            V value = supplier.get();
            // value如果不为空
            if (value != null) {
                // 返回代理对象$Proxy
                return value;
            }
        }
        
        // 如果supplier为空表示在缓存中不存在
        // 如果工厂也为空，则新建一个工厂
        if (factory == null) {
            factory = new Factory(key, parameter, subKey, valuesMap);
        }

        if (supplier == null) {
            // subKey作为键，factory作为值放入到valuesMap中
            supplier = valuesMap.putIfAbsent(subKey, factory);
            // 如果supplier为空
            if (supplier == null) {
                // 直接将工厂赋值给supplier
                supplier = factory;
            }
        } else {
            if (valuesMap.replace(subKey, supplier, factory)) {
                // 如果成功替换则清除条目
                // 没替换成功的话，直接将工厂赋值给supplier
                supplier = factory;
            } else {
                // retry with current supplier
                supplier = valuesMap.get(subKey);
            }
        }
    }
}

WeakCache.Factory

该类是一个工厂类，主要实现值的构造并将其放入到缓存中。

private final class Factory implements Supplier<V> {

    private final K key;
    private final P parameter;
    private final Object subKey;
    private final ConcurrentMap<Object, Supplier<V>> valuesMap;

    Factory(K key, P parameter, Object subKey,
            ConcurrentMap<Object, Supplier<V>> valuesMap) {
        this.key = key;
        this.parameter = parameter;
        this.subKey = subKey;
        this.valuesMap = valuesMap;
    }

    public synchronized V get() {
        // 再次检测
        // 再次检测的目的，是因为在等待时可能发生了一些变化：也许是CacheValue被替换或者被删除
        Supplier<V> supplier = valuesMap.get(subKey);
        if (supplier != this) {
            return null;
        }

        // 创建新的值
        V value = null;
        try {
            // 调用Proxy.ProxyClassFactory生成com.sun.proxy.$Proxy代理类
            value = Objects.requireNonNull(valueFactory.apply(key, parameter));
        } finally {
            if (value == null) {
                // 失败的话移除
                valuesMap.remove(subKey, this);
            }
        }
        // the only path to reach here is with non-null value
        assert value != null;

        // 将value值封装成CacheValue(WeakReference)
        CacheValue<V> cacheValue = new CacheValue<>(value);

        // 将封装后的值放进reverseMap
        reverseMap.put(cacheValue, Boolean.TRUE);

        // 用封装后的CacheValue代替subKey的值(一般都是成功的)
        if (!valuesMap.replace(subKey, this, cacheValue)) {
            throw new AssertionError("Should not reach here");
        }

        // 返回新的封装后的，并且已经替换成功的CacheValue
        return value;
    }
}

Proxy.KeyFactory

该类的目的是根据提供的参数生成保存缓存所需要的键。

private static final class KeyFactory
    implements BiFunction<ClassLoader, Class<?>[], Object>
{
    @Override
    // 将接口数组映射到Key的函数，其中interface接口数组设置为弱引用
    public Object apply(ClassLoader classLoader, Class<?>[] interfaces) {
        switch (interfaces.length) {
            case 1: return new Key1(interfaces[0]); // the most frequent
            case 2: return new Key2(interfaces[0], interfaces[1]);
            case 0: return key0;
            default: return new KeyX(interfaces);
        }
    }
}

Proxy.ProxyClassFactory

ProxyClassFactory会根据给定的ClassLoader和接口数组生成返回代理类。

private static final class ProxyClassFactory
    implements BiFunction<ClassLoader, Class<?>[], Class<?>>
{
    // 所有代理类的类名前缀
    private static final String proxyClassNamePrefix = "$Proxy";

    // 用于生成下一个代理类名的数字（唯一标识）
    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) {
            // 验证类加载器是否将此接口的名称解析为同一Class对象
            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");
            }

            // 验证Class对象确实代表一个接口
            // JDK动态代理为什么只代理接口，原因就在此
            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;

        // 记录非公共代理接口的包名，以便将在同一包中定义代理类
        // 验证所有非公共代理接口都在同一程序包中
        // 原因：default访问控制符，只能在当前包下，所以代理类也要放在同一包中
        for (Class<?> intf : interfaces) {
            // 获取接口访问控制符
            int flags = intf.getModifiers();
            // 判断是否不为public
            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 {
            return defineClass0(loader, proxyName,
                                proxyClassFile, 0, proxyClassFile.length);
        } catch (ClassFormatError e) {
            throw new IllegalArgumentException(e.toString());
        }
    }
}