源碼解析--JDK動(dòng)態(tài)代理

動(dòng)態(tài)代理的兩種方式JDK動(dòng)態(tài)代理和cglib動(dòng)態(tài)代理在上一篇中動(dòng)態(tài)代理jdk和cglib的區(qū)別已經(jīng)通過(guò)實(shí)例做了比較,那么動(dòng)態(tài)代理的使用我們已經(jīng)掌握了,但是知道了使用方法還遠(yuǎn)遠(yuǎn)不夠,要想更深入了解,還得從源碼讀起,學(xué)習(xí)其根源才是我們學(xué)習(xí)的正確方式。

為了方便理解本文的重點(diǎn),我們先說(shuō)一下靜態(tài)代理和動(dòng)態(tài)代理的根本上的區(qū)別

靜態(tài)代理是由程序員創(chuàng)建或工具生成代理類(lèi)的源碼,再編譯代理類(lèi)。所謂靜態(tài)也就是在程序運(yùn)行前就已經(jīng)存在代理類(lèi)的字節(jié)碼文件(.class文件),代理類(lèi)和委托類(lèi)的關(guān)系在運(yùn)行前就確定了。
動(dòng)態(tài)代理類(lèi)的源碼是在程序運(yùn)行期間由JVM根據(jù)反射等機(jī)制動(dòng)態(tài)的生成,所以不存在代理類(lèi)的字節(jié)碼文件(.class文件)。代理類(lèi)和委托類(lèi)的關(guān)系是在程序運(yùn)行時(shí)確定。

我們先來(lái)看一個(gè)熟悉的JDK動(dòng)態(tài)代理的例子

Car接口

package proxy;

public interface Car {

    public void run();
}

Car實(shí)現(xiàn)類(lèi)

package proxy;

public class CarImpl implements Car{

    public void run() {
        System.out.println("car running");
    }

}

Car代理類(lèi)

package proxy;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
//JDK動(dòng)態(tài)代理代理類(lèi) 
public class CarHandler implements InvocationHandler{
    //真實(shí)類(lèi)的對(duì)象
    private Object car;
    //構(gòu)造方法賦值給真實(shí)的類(lèi)
    public CarHandler(Object obj){
        this.car = obj;
    }
//代理類(lèi)執(zhí)行方法時(shí),調(diào)用的是這個(gè)方法
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        System.out.println("before");
        Object res = method.invoke(car, args);
        System.out.println("after");
        return res;
    }
}

main方法

package proxy;

import java.lang.reflect.Proxy;

public class main {

    public static void main(String[] args) {
        CarImpl carImpl = new CarImpl();
        CarHandler carHandler = new CarHandler(carImpl);
        Car proxy = (Car)Proxy.newProxyInstance(
                main.class.getClassLoader(), //第一個(gè)參數(shù),獲取ClassLoader
                carImpl.getClass().getInterfaces(), //第二個(gè)參數(shù),獲取被代理類(lèi)的接口
                carHandler);//第三個(gè)參數(shù),一個(gè)InvocationHandler對(duì)象,表示的是當(dāng)我這個(gè)動(dòng)態(tài)代理對(duì)象在調(diào)用方法的時(shí)候,會(huì)關(guān)聯(lián)到哪一個(gè)InvocationHandler對(duì)象上
        proxy.run();
    }
}

運(yùn)行結(jié)果

before
car running
after

我們知道JDK動(dòng)態(tài)代理的核心在于Proxy.newProxyInstance方法上,也就是生成的代理類(lèi)上,我們跟進(jìn)去查看

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

        final Class<?>[] intfs = interfaces.clone();
        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 {
            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);
        }
    }

在這個(gè)方法里,我標(biāo)注了兩處注釋?zhuān)?strong>這兩處源碼編寫(xiě)者也為我們做了英文注釋,我們來(lái)看一下

Look up or generate the designated proxy class.//查找并生成指定的代理類(lèi)的class
Invoke its constructor with the designated invocation handler.//使用我們實(shí)現(xiàn)的InvocationHandler作為參數(shù)調(diào)用構(gòu)造方法來(lái)獲得代理類(lèi)的實(shí)例

其中第一處是生成class文件,也就是java動(dòng)態(tài)生成class類(lèi),第二處是調(diào)用該class類(lèi)的構(gòu)造函數(shù),并將我們的carHandler作為參數(shù)傳進(jìn)去。第二步我們都知道,就是一個(gè)普通的java類(lèi)調(diào)用一下構(gòu)造方法而已,我們關(guān)注的重點(diǎn)是jdk怎么動(dòng)態(tài)生成的這個(gè)class文件。
我們跟進(jìn)Class<?> cl = getProxyClass0(loader, intfs);

private static Class<?> getProxyClass0(ClassLoader loader,  
                                       Class<?>... interfaces) {  
    // 代理的接口數(shù)量大于65535時(shí)拋出異常
    if (interfaces.length > 65535) {  
        throw new IllegalArgumentException("interface limit exceeded");  
    }  
    // JDK對(duì)代理類(lèi)進(jìn)行了緩存,如果已經(jīng)存在相應(yīng)的代理類(lèi),則直接返回,否則才會(huì)通過(guò)ProxyClassFactory來(lái)創(chuàng)建代理  
    return proxyClassCache.get(loader, interfaces);  
}  

getProxyClass0(loader, intfs);方法里我們根據(jù)注釋可以知道,JDK對(duì)代理類(lèi)的接口做了個(gè)數(shù)限制,并且維護(hù)了一個(gè)代理類(lèi)的緩存集合,如果有緩存就直接返回,否則就通過(guò)ProxyClassFactory去創(chuàng)建,在我們上面的實(shí)例中,并沒(méi)有代理緩存,所以我們?nèi)タ碢roxyClassFactory類(lèi)是怎么生成class的,ProxyClassFactory是Proxy的一個(gè)靜態(tài)內(nèi)部類(lèi)

private static final class ProxyClassFactory
        implements BiFunction<ClassLoader, Class<?>[], Class<?>>
    {
        // prefix for all proxy class names
// 第1處注釋  
        private static final String proxyClassNamePrefix = "$Proxy";
// 第2處注釋  
        // 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);
//驗(yàn)證邏輯,我們可以略過(guò)這段邏輯
            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());
                }
            }
//第3處注釋  
            String proxyPkg = null;     // package to define proxy class in
            int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
//第4處注釋  
            /*
             * 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 + ".";
            }
// 獲取計(jì)數(shù)用來(lái)生成代理類(lèi)的類(lèi)名(proxy+num)
            /*
             * Choose a name for the proxy class to generate.
             */
            long num = nextUniqueNumber.getAndIncrement();
// 第5處注釋   
            String proxyName = proxyPkg + proxyClassNamePrefix + num;
// 第6處注釋    
            /*
             * 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());
            }
        }
    }

上面的代碼中,標(biāo)注了幾處注釋我們來(lái)一一解釋

1.proxyClassNamePrefix變量是所有代理類(lèi)的類(lèi)名前綴
2.AtomicLong同步類(lèi),用來(lái)實(shí)現(xiàn)生成代理類(lèi)名字的計(jì)數(shù)器
3.proxyPkg變量是代理類(lèi)的包名
4.這一段邏輯是挨個(gè)循環(huán)得到代理類(lèi)的路徑
5.生成類(lèi)名,默認(rèn)情況下,代理類(lèi)的完全限定名為:com.sun.proxy.$Proxy0,com.sun.proxy.$Proxy1……依次遞增
6.這里才是真正的生成代理類(lèi)的字節(jié)碼的地方,通過(guò)ProxyGenerator.generateProxyClass方法。

我們跟進(jìn)ProxyGenerator.generateProxyClass方法

public static byte[] generateProxyClass(final String var0, Class[] var1) {  
    ProxyGenerator var2 = new ProxyGenerator(var0, var1);  
    final byte[] var3 = var2.generateClassFile();  
    // 這里根據(jù)參數(shù)配置,決定是否把生成的字節(jié)碼(.class文件)保存到本地磁盤(pán),我們可以通過(guò)把相應(yīng)的class文件保存到本地,再反編譯來(lái)看看具體的實(shí)現(xiàn),這樣更直觀  
    if(saveGeneratedFiles) {  
        AccessController.doPrivileged(new PrivilegedAction() {  
            public Void run() {  
                try {  
                    FileOutputStream var1 = new FileOutputStream(ProxyGenerator.dotToSlash(var0) + ".class");  
                    var1.write(var3);  
                    var1.close();  
                    return null;  
                } catch (IOException var2) {  
                    throw new InternalError("I/O exception saving generated file: " + var2);  
                }  
            }  
        });  
    }  
    return var3;  
}  

在這個(gè)類(lèi)中,我們看到了熟悉的FileOutputStream,也就是在這里生成了新的class文件,生成了代理類(lèi)。我們操作一下生成一下class文件,然后打開(kāi)查看一下這個(gè)神秘的class文件

package com.sun.proxy;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
import proxy.Car;

public final class $Proxy0
  extends Proxy
  implements Car
{
  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 run()
  {
    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("proxy.Car").getMethod("run", 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());
    }
  }
}

到這里大家估計(jì)就豁然開(kāi)朗了,這個(gè)代理類(lèi)有以下幾個(gè)特點(diǎn)

1.繼承了Proxy類(lèi),實(shí)現(xiàn)了代理的接口(interface--Car),由于java不能多繼承,這里已經(jīng)繼承了Proxy類(lèi)了,不能再繼承其他的類(lèi),所以JDK的動(dòng)態(tài)代理不支持對(duì)實(shí)現(xiàn)類(lèi)的代理,只支持接口的代理。
2.提供了一個(gè)使用InvocationHandler作為參數(shù)的構(gòu)造方法。
3.生成靜態(tài)代碼塊來(lái)初始化接口中方法的Method對(duì)象,以及Object類(lèi)的equals、hashCode、toString方法。
4.重寫(xiě)了Object類(lèi)的equals、hashCode、toString,它們都只是簡(jiǎn)單的調(diào)用了InvocationHandler的invoke方法,即可以對(duì)其進(jìn)行特殊的操作,也就是說(shuō)JDK的動(dòng)態(tài)代理還可以代理上述三個(gè)方法。
5.代理類(lèi)實(shí)現(xiàn)代理接口的run方法中,只是簡(jiǎn)單的調(diào)用了InvocationHandler的invoke方法,我們可以在invoke方法中進(jìn)行一些特殊操作,甚至不調(diào)用實(shí)現(xiàn)的方法,直接返回。

上面是JDK動(dòng)態(tài)代理實(shí)現(xiàn)的基本框架代碼,Spring AOP的實(shí)現(xiàn)也是同理,當(dāng)然具體的實(shí)現(xiàn)肯定比這個(gè)復(fù)雜得多,但是基本原理不外乎如是。所以理解基本原理對(duì)于理解其他的代碼也是很有好處的。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容