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動态代理源碼解析

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

SpringAOP--JDK動态代理源碼解析

繼續閱讀

馴服爛代碼_馴服Tomcat：Tomcat 5的過濾技巧

基于Springboot+VUE+Mysql的大學生校園疫情防控管理系統

Using MessageConverter

馴服爛代碼_C＃中的馴服配置

Spring Cloud整合Sleuth，當請求完成後，Zipkin沒有鍊路資訊

JAVA自學之路——馬士兵

Rabbitmq指令行手動建立隊列

整合 Spring 開發架構及服務端技術

SSM整合02---Spring-SpringMVC層一、添加web架構支援二、web.xml三、spring-mvc.xml

SSM架構（二）------------表現層的SpringMVC

Intellij idea基于Maven 的SSM 架構整合

Spring資料和Redis

SpringMVC的啟動過程源碼分析1 SpringMVC 配置XML的方式啟動2 SpringMVC純注解模式啟動

Java Spring 架構

spring boot @SpringBootApplication @EnableAutoConfiguration 的工作原理

SpringCloud微服務（四）之ribbon筆記ribbon是什麼？入門案例自定義均衡負載算法