java基礎:深入理解JDK動態代理

Hiway發表於2019-03-04

其他更多java基礎文章: java基礎學習(目錄)


經過上一節我們講了Class物件和反射機制,這節就來講一下反射機制在java中的主要應用——動態代理。在講動態代理之前,會先講一下代理模式和靜態代理。

一、代理模式

代理模式是常用的java設計模式,他的特徵是代理類與委託類有同樣的介面,代理類主要負責為委託類預處理訊息、過濾訊息、把訊息轉發給委託類,以及事後處理訊息等。代理類與委託類之間通常會存在關聯關係,一個代理類的物件與一個委託類的物件關聯,代理類的物件本身並不真正實現服務,而是通過呼叫委託類的物件的相關方法,來提供特定的服務。簡單的說就是,我們在訪問實際物件時,是通過代理物件來訪問的,代理模式就是在訪問實際物件時引入一定程度的間接性,因為這種間接性,可以附加多種用途,比如說Spring的AOP。代理模式結構圖(圖片來自《大話設計模式》):

image

二、靜態代理

1、靜態代理

靜態代理:由程式設計師建立或特定工具自動生成原始碼,也就是在編譯時就已經將介面,被代理類,代理類等確定下來。在程式執行之前,代理類的.class檔案就已經生成。

2、靜態代理簡單實現

根據上面代理模式的類圖,來寫一個簡單的靜態代理的例子。 首先定義一個商品介面

public interface ProductService {
    void addProduct(String productName);
}
複製程式碼

然後定義一個商品的實現

public class ProductServiceImpl implements ProductService{

    public void addProduct(String productName) {
        System.out.println("正在新增"+productName);
    }
}
複製程式碼

此時我們定義一個商品銷售員工,員工在新增商品的時候,會先檢查產品是否合格,然後新增完後會報告一聲。

public class ProductEmployee implements  ProductService{
    ProductServiceImpl productService;

    public ProductEmployee(ProductServiceImpl productService) {
        this.productService = productService;
    }

    @Override
    public void addProduct(String productName) {
        System.out.println("檢查產品"+productName);
        productService.addProduct(productName);
        System.out.println("新增完成");
    }

    public static void main(String[] args) {
        ProductServiceImpl impl = new ProductServiceImpl();
        ProductEmployee productEmployee = new ProductEmployee (impl);
        productEmployee .addProduct("book");
    }
}

/*output
檢查產品book
正在新增book
新增完成
複製程式碼

代理模式最主要的就是有一個公共介面(ProductService ),一個具體的類(ProductServiceImpl ),一個代理類(ProductEmployee ),代理類持有具體類的例項,代為執行具體類例項方法。上面說到,代理模式就是在訪問實際物件時引入一定程度的間接性,因為這種間接性,可以附加多種用途。最直白的就是在Spring中的面向切面程式設計(AOP),我們能在一個切點之前執行一些操作,在一個切點之後執行一些操作,這個切點就是一個個方法。這些方法所在類肯定就是被代理了,在代理過程中切入了一些其他操作。

三、動態代理

靜態代理有不少缺點,每需要一個代理類就要新增一個類,當代理類越來越多時,就會顯得非常的龐大和臃腫。而且當需要修改代理類中的方法時,就需要每個代理類都修改方法程式碼,代理類越多,越繁瑣。此時,就需要使用我們的動態代理。代理類在程式執行時建立的代理方式被成為動態代理。
我們上面靜態代理的例子中,代理類(ProductEmployee)是自己定義好的,在程式執行之前就已經編譯完成。然而動態代理,代理類並不是在Java程式碼中定義的,而是在執行時根據我們在Java程式碼中的“指示”動態生成的。相比於靜態代理, 動態代理的優勢在於可以很方便的對代理類的函式進行統一的處理,而不用修改每個代理類中的方法。

動態代理的簡單實現

我們需要定義一個InvocationHandler的實現類

public class ProductInvocationHandler implements InvocationHandler {
    // 目標物件
    private Object target;

    /**
     * 構造方法
     * @param target 目標物件
     */
    public ProductInvocationHandler(Object target) {
        this.target = target;
    }


    /**
     * 執行目標物件的方法
     */
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        // 在目標物件的方法執行之前簡單的列印一下
        System.out.println("檢查產品");
        // 執行目標物件的方法
        Object result = method.invoke(target, args);
        // 在目標物件的方法執行之後簡單的列印一下
        System.out.println("新增完成");

        return result;
    }

    /**
     * 獲取目標物件的代理物件
     * @return 代理物件
     */
    public Object getProxy() {
        return Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(),
                target.getClass().getInterfaces(), this);
    }
}
複製程式碼

然後呼叫這個類生成代理物件,執行方法

    public static void main(String[] args) {
        ProductService impl = new ProductServiceImpl();
        ProductInvocationHandler productInvocationHandler = new ProductInvocationHandler(impl);
        ProductService proxy = (ProductService) productInvocationHandler.getProxy();
        proxy.addProduct("book");
    }

/* output
檢查產品
正在新增book
新增完成

複製程式碼
動態代理的原理分析

通過上面例子,我們可以看到動態代理機制中有兩個重要的類和介面InvocationHandler(介面)Proxy(類),這兩個類Proxy和介面InvocationHandler是我們實現動態代理的核心;
InvocationHandler
InvocationHandler介面是proxy代理例項的呼叫處理程式實現的一個介面,每一個代理的例項都會有一個關聯的呼叫處理程式(InvocationHandler)。對待代理例項進行呼叫時,將對方法的呼叫進行編碼並指派到它的呼叫處理器(InvocationHandler)的invoke方法。所以對代理物件例項方法的呼叫都是通過InvocationHandler中的invoke方法來完成的,而invoke方法會根據傳入的代理物件、方法名稱以及引數決定呼叫代理的哪個方法。
可能現在看起來會覺得有點繞,有點難懂,在學習完下面Proxy代理類的生成之後,再回來看會更好理解。

Proxy
Proxy類是用來建立一個代理物件的類。通過上面的簡單例子,我們可以看到建立獲取代理物件是通過Proxy的newProxyInstance方法得到的。那我們就以此為入口,深入瞭解一下Proxy類。

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

        /*
         * 使用指定的呼叫處理程式(invocation handler)獲取代理類的建構函式物件
         */
        try {
            if (sm != null) {
                checkNewProxyPermission(Reflection.getCallerClass(), cl);
            }
            //獲取代理類的建構函式
            final Constructor<?> cons = cl.getConstructor(constructorParams);
            final InvocationHandler ih = h;
            //假如代理類的建構函式是private的,就使用反射來set accessible
            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);
        }
    }
複製程式碼

文中的註釋已經很清楚的標明瞭這個方法的執行邏輯,其中有三行程式碼是這個方法的重點。

  • Class<?> cl = getProxyClass0(loader, intfs);生成代理類的Class
  • final Constructor<?> cons = cl.getConstructor(constructorParams);獲取代理類的建構函式
  • return cons.newInstance(new Object[]{h});通過建構函式建立代理類例項

其中的重中之重就是getProxy0這個方法了,因為後面兩個就是反射的常用方法。

getProxyClass0(loader, intfs)
我們跟進去看一下這個方法的程式碼:

/**
     * 生成一個代理類,但是在呼叫本方法之前必須進行許可權檢查
     */
    private static Class<?> getProxyClass0(ClassLoader loader,
                                           Class<?>... interfaces) {
        //如果介面數量大於65535,丟擲非法引數錯誤
        if (interfaces.length > 65535) {
            throw new IllegalArgumentException("interface limit exceeded");
        }

       
        // 如果在快取中有對應的代理類,那麼直接返回
        // 否則代理類將有 ProxyClassFactory 來建立
        return proxyClassCache.get(loader, interfaces);
    }

複製程式碼

這裡說的ProxyClassFactory是在Proxy類下的一個靜態類

/**
     *  一個工廠函式,用於生成、定義和返回給定ClassLoader和介面陣列的代理類。 
     *
     */
    private static final class ProxyClassFactory
        implements BiFunction<ClassLoader, Class<?>[], Class<?>>
    {
        // 代理類的名字的字首統一為“$Proxy”
        private static final String proxyClassNamePrefix = "$Proxy";

        // 每個代理類字首後面都會跟著一個唯一的編號,如$Proxy0$Proxy1$Proxy2
        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) {
                /*
                 * 驗證類載入器載入介面得到物件是否與由apply函式引數傳入的物件相同
                 */
                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物件是不是介面
                 */
                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;     // 宣告代理類所在的package
            int accessFlags = Modifier.PUBLIC | Modifier.FINAL;

            /*
             * 記錄一個非公共代理介面的包,以便在同一個包中定義代理類。同時驗證所有非公共
             * 代理介面都在同一個包中
             */
            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) {
                // 如果全是公共代理介面,那麼生成的代理類就在com.sun.proxy package下
                proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
            }

            /*
             * 為代理類生成一個name  package name + 字首+唯一編號
             * 如 com.sun.proxy.$Proxy0.class
             */
            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) {
                /*
                 * 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());
            }
        }
    }
複製程式碼

從註釋中可以得知,ProxyClassFactory是通過ProxyGenerator.generateProxyClass方法生成的代理類的位元組碼檔案。由於這個jar包不公開,所以我們可以在百度Google上搜一下,或者通過OpenJDK來檢視,兩者的這部分程式碼基本一致。OpenJDK ProxyGenerator.java

public static byte[] generateProxyClass(final String name,
                                            Class[] interfaces)
    {
        ProxyGenerator gen = new ProxyGenerator(name, interfaces);
        //生成獲取位元組碼
        final byte[] classFile = gen.generateClassFile();

      //是否將二進位制儲存到本地檔案中,saveGeneratedFiles由引數sun.misc.ProxyGenerator.saveGeneratedFiles決定。
        if (saveGeneratedFiles) {
            java.security.AccessController.doPrivileged(
            new java.security.PrivilegedAction<Void>() {
                public Void run() {
                    try {
                        FileOutputStream file =
                            new FileOutputStream(dotToSlash(name) + ".class");
                        file.write(classFile);
                        file.close();
                        return null;
                    } catch (IOException e) {
                        throw new InternalError(
                            "I/O exception saving generated file: " + e);
                    }
                }
            });
        }

        return classFile;
    }
複製程式碼

我們繼續跟進生成位元組碼的gen.generateClassFile()方法

private byte[] generateClassFile() {
    /* ============================================================
    * Step 1: 為所有方法組裝ProxyMethod物件,以為其生成代理排程程式碼
    */
    //生成proxy代理類的hashcode,equals,toString方法
    addProxyMethod(hashCodeMethod, Object.class);
    addProxyMethod(equalsMethod, Object.class);
    addProxyMethod(toStringMethod, Object.class);

    //新增各個介面的方法
    //這就是為什麼我們能夠通過代理呼叫介面方法實現的原因
    for (int i = 0; i < interfaces.length; i++) {
        Method[] methods = interfaces[i].getMethods();
        for (int j = 0; j < methods.length; j++) {
            addProxyMethod(methods[j], interfaces[i]);
        }
    }

    //檢查返回型別
    for (List<ProxyMethod> sigmethods : proxyMethods.values()) {
        checkReturnTypes(sigmethods);
    }

   /* ============================================================
    * Step 2: 為我們生成的類中的所有欄位和方法組裝FieldInfo和MethodInfo結構。
    */
    //編譯成class的相關內容
    try {
        methods.add(generateConstructor());

        for (List<ProxyMethod> sigmethods : proxyMethods.values()) {
            for (ProxyMethod pm : sigmethods) {
                fields.add(new FieldInfo(pm.methodFieldName,
                        "Ljava/lang/reflect/Method;", ACC_PRIVATE
                                | ACC_STATIC));

                methods.add(pm.generateMethod());
            }
        }

        methods.add(generateStaticInitializer());

    } catch (IOException e) {
        throw new InternalError("unexpected I/O Exception");
    }

    if (methods.size() > 65535) {
        throw new IllegalArgumentException("method limit exceeded");
    }
    if (fields.size() > 65535) {
        throw new IllegalArgumentException("field limit exceeded");
    }

    /* ============================================================
    * Step 3: 將組織好的class檔案寫入到檔案中
    */
    //在開始編寫最終類檔案之前,請確保為以下項保留了常量池索引
    cp.getClass(dotToSlash(className));
    cp.getClass(superclassName);
    for (int i = 0; i < interfaces.length; i++) {
        cp.getClass(dotToSlash(interfaces[i].getName()));
    }

    //設定為只讀模式,在此之後不允許新增新的常量池,因為我們將要編寫一個final常量池表。
    cp.setReadOnly();

    ByteArrayOutputStream bout = new ByteArrayOutputStream();
    DataOutputStream dout = new DataOutputStream(bout);

    try {
        //以下是class檔案的結構,想深入瞭解的話可以看深入Java虛擬機器
        // u4 magic;
        dout.writeInt(0xCAFEBABE);
        // u2 minor_version;
        dout.writeShort(CLASSFILE_MINOR_VERSION);
        // u2 major_version;
        dout.writeShort(CLASSFILE_MAJOR_VERSION);

        cp.write(dout); // (write constant pool)

        // u2 access_flags;
        dout.writeShort(ACC_PUBLIC | ACC_FINAL | ACC_SUPER);
        // u2 this_class;
        dout.writeShort(cp.getClass(dotToSlash(className)));
        // u2 super_class;
        dout.writeShort(cp.getClass(superclassName));

        // u2 interfaces_count;
        dout.writeShort(interfaces.length);
        // u2 interfaces[interfaces_count];
        for (int i = 0; i < interfaces.length; i++) {
            dout.writeShort(cp.getClass(dotToSlash(interfaces[i].getName())));
        }

        // u2 fields_count;
        dout.writeShort(fields.size());
        // field_info fields[fields_count];
        for (FieldInfo f : fields) {
            f.write(dout);
        }

        // u2 methods_count;
        dout.writeShort(methods.size());
        // method_info methods[methods_count];
        for (MethodInfo m : methods) {
            m.write(dout);
        }

        // u2 attributes_count;
        dout.writeShort(0); // (no ClassFile attributes for proxy classes)

    } catch (IOException e) {
        throw new InternalError("unexpected I/O Exception");
    }

    return bout.toByteArray();
}
複製程式碼

檢視生成的Proxy代理類
到這裡,我們就基本解析完了Java Proxy在動態代理中的作用了。不過大家可能會對動態代理生成出來的代理類具體結構有疑問。為了更好地瞭解Proxy代理類的結構(順便加深印象),我們不妨通過FileOutputStream 來將generateProxyClass建立的二進位制生成相應的class檔案

    public static void main(String[] args) {
        String name = "ProductServiceProxy";
        byte[] data = sun.misc.ProxyGenerator.generateProxyClass(name,
                new Class[] { ProductService.class });
        try {
            FileOutputStream out = new FileOutputStream(name + ".class");
            out.write(data);
            out.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
複製程式碼

執行後在專案根目錄會找到一個ProductServiceProxy.class檔案,我們通過反編譯開啟

import com.example.javabase.proxyDemo.ProductService;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;

public final class ProductServiceProxy
  extends Proxy
  implements ProductService
{
  private static Method m1;
  private static Method m2;
  private static Method m3;
  private static Method m0;
  
  public ProductServiceProxy(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 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 void addProduct(String paramString)
  {
    try
    {
      this.h.invoke(this, m3, new Object[] { paramString });
      return;
    }
    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") });
      m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);
      m3 = Class.forName("com.example.javabase.proxyDemo.ProductService").getMethod("addProduct", new Class[] { Class.forName("java.lang.String") });
      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());
    }
  }
}
複製程式碼

從上面我們可以很清楚的看到,代理類的方法呼叫最後還是通過InvocationHandler.invoke反射呼叫到了被代理類的方法。代理的大概結構包括4部分:

  • 靜態欄位:被代理的介面所有方法都有一個對應的靜態方法變數;
  • 建構函式:從這裡傳入我們InvocationHandler邏輯;
  • 具體每個代理方法:邏輯都差不多就是 h.invoke,主要是呼叫我們定義好的invocatinoHandler邏輯,觸發目標物件target上對應的方法;
  • 靜態塊:主要是通過反射初始化靜態方法變數;

同時,因為所有代理類都繼承了Proxy類,所以JDK動態代理只能對介面進行代理,Java的繼承機制註定了這些動態代理類們無法實現對class的動態代理。

延伸

自己動手寫一個動態代理

相關文章