Java 動態代理機制分析及擴充套件

developerworks發表於2015-09-24
Java套件

引言

Java 動態代理機制的出現，使得 Java 開發人員不用手工編寫代理類，只要簡單地指定一組介面及委託類物件，便能動態地獲得代理類。代理類會負責將所有的方法呼叫分派到委託物件上反射執行，在分派執行的過程中，開發人員還可以按需調整委託類物件及其功能，這是一套非常靈活有彈性的代理框架。通過閱讀本文，讀者將會對 Java 動態代理機制有更加深入的理解。本文首先從 Java 動態代理的執行機制和特點出發，對其程式碼進行了分析，推演了動態生成類的內部實現。

代理：設計模式

代理是一種常用的設計模式，其目的就是為其他物件提供一個代理以控制對某個物件的訪問。代理類負責為委託類預處理訊息，過濾訊息並轉發訊息，以及進行訊息被委託類執行後的後續處理。

圖 1. 代理模式

Java 動態代理機制分析及擴充套件，第 1 部分

為了保持行為的一致性，代理類和委託類通常會實現相同的介面，所以在訪問者看來兩者沒有絲毫的區別。通過代理類這中間一層，能有效控制對委託類物件的直接訪問，也可以很好地隱藏和保護委託類物件，同時也為實施不同控制策略預留了空間，從而在設計上獲得了更大的靈活性。Java 動態代理機制以巧妙的方式近乎完美地實踐了代理模式的設計理念。

相關的類和介面

要了解 Java 動態代理的機制，首先需要了解以下相關的類或介面：

  • java.lang.reflect.Proxy：這是 Java 動態代理機制的主類，它提供了一組靜態方法來為一組介面動態地生成代理類及其物件。
清單 1. Proxy 的靜態方法
// 方法 1: 該方法用於獲取指定代理物件所關聯的呼叫處理器
static InvocationHandler getInvocationHandler(Object proxy) 

// 方法 2：該方法用於獲取關聯於指定類裝載器和一組介面的動態代理類的類物件
static Class getProxyClass(ClassLoader loader, Class[] interfaces) 

// 方法 3：該方法用於判斷指定類物件是否是一個動態代理類
static boolean isProxyClass(Class cl) 

// 方法 4：該方法用於為指定類裝載器、一組介面及呼叫處理器生成動態代理類例項
static Object newProxyInstance(ClassLoader loader, Class[] interfaces, 
    InvocationHandler h)
  • java.lang.reflect.InvocationHandler：這是呼叫處理器介面，它自定義了一個 invoke 方法，用於集中處理在動態代理類物件上的方法呼叫，通常在該方法中實現對委託類的代理訪問。
清單 2. InvocationHandler 的核心方法
// 該方法負責集中處理動態代理類上的所有方法呼叫。第一個引數既是代理類例項，第二個引數是被呼叫的方法物件
// 第三個方法是呼叫引數。呼叫處理器根據這三個引數進行預處理或分派到委託類例項上發射執行
Object invoke(Object proxy, Method method, Object[] args)

每次生成動態代理類物件時都需要指定一個實現了該介面的呼叫處理器物件（參見 Proxy 靜態方法 4 的第三個引數）。

  • java.lang.ClassLoader：這是類裝載器類，負責將類的位元組碼裝載到 Java 虛擬機器（JVM）中併為其定義類物件，然後該類才能被使用。Proxy 靜態方法生成動態代理類同樣需要通過類裝載器來進行裝載才能使用，它與普通類的唯一區別就是其位元組碼是由 JVM 在執行時動態生成的而非預存在於任何一個 .class 檔案中。每次生成動態代理類物件時都需要指定一個類裝載器物件（參見 Proxy 靜態方法 4 的第一個引數）

代理機制及其特點

首先讓我們來了解一下如何使用 Java 動態代理。具體有如下四步驟：

  1. 通過實現 InvocationHandler 介面建立自己的呼叫處理器；
  2. 通過為 Proxy 類指定 ClassLoader 物件和一組 interface 來建立動態代理類；
  3. 通過反射機制獲得動態代理類的建構函式，其唯一引數型別是呼叫處理器介面型別；
  4. 通過建構函式建立動態代理類例項，構造時呼叫處理器物件作為引數被傳入。
清單 3. 動態代理物件建立過程
// InvocationHandlerImpl 實現了 InvocationHandler 介面，並能實現方法呼叫從代理類到委託類的分派轉發
// 其內部通常包含指向委託類例項的引用，用於真正執行分派轉發過來的方法呼叫
InvocationHandler handler = new InvocationHandlerImpl(..); 

// 通過 Proxy 為包括 Interface 介面在內的一組介面動態建立代理類的類物件
Class clazz = Proxy.getProxyClass(classLoader, new Class[] { Interface.class, ... }); 

// 通過反射從生成的類物件獲得建構函式物件
Constructor constructor = clazz.getConstructor(new Class[] { InvocationHandler.class }); 

// 通過建構函式物件建立動態代理類例項
Interface Proxy = (Interface)constructor.newInstance(new Object[] { handler });

實際使用過程更加簡單，因為 Proxy 的靜態方法 newProxyInstance 已經為我們封裝了步驟 2 到步驟 4 的過程，所以簡化後的過程如下

清單 4. 簡化的動態代理物件建立過程
// InvocationHandlerImpl 實現了 InvocationHandler 介面，並能實現方法呼叫從代理類到委託類的分派轉發
InvocationHandler handler = new InvocationHandlerImpl(..); 

// 通過 Proxy 直接建立動態代理類例項
Interface proxy = (Interface)Proxy.newProxyInstance( classLoader, 
	 new Class[] { Interface.class }, 
	 handler );

接下來讓我們來了解一下 Java 動態代理機制的一些特點。

首先是動態生成的代理類本身的一些特點。1）包：如果所代理的介面都是 public 的，那麼它將被定義在頂層包（即包路徑為空），如果所代理的介面中有非 public 的介面（因為介面不能被定義為 protect 或 private，所以除 public 之外就是預設的 package 訪問級別），那麼它將被定義在該介面所在包（假設代理了 com.ibm.developerworks 包中的某非 public 介面 A，那麼新生成的代理類所在的包就是 com.ibm.developerworks），這樣設計的目的是為了最大程度的保證動態代理類不會因為包管理的問題而無法被成功定義並訪問；2）類修飾符：該代理類具有 final 和 public 修飾符，意味著它可以被所有的類訪問，但是不能被再度繼承；3）類名：格式是“$ProxyN”，其中 N 是一個逐一遞增的阿拉伯數字，代表 Proxy 類第 N 次生成的動態代理類，值得注意的一點是，並不是每次呼叫 Proxy 的靜態方法建立動態代理類都會使得 N 值增加，原因是如果對同一組介面（包括介面排列的順序相同）試圖重複建立動態代理類，它會很聰明地返回先前已經建立好的代理類的類物件，而不會再嘗試去建立一個全新的代理類，這樣可以節省不必要的程式碼重複生成，提高了代理類的建立效率。4）類繼承關係：該類的繼承關係如圖：

圖 2. 動態代理類的繼承圖

Java 動態代理機制分析及擴充套件，第 1 部分

由圖可見，Proxy 類是它的父類，這個規則適用於所有由 Proxy 建立的動態代理類。而且該類還實現了其所代理的一組介面，這就是為什麼它能夠被安全地型別轉換到其所代理的某介面的根本原因。

接下來讓我們瞭解一下代理類例項的一些特點。每個例項都會關聯一個呼叫處理器物件，可以通過 Proxy 提供的靜態方法 getInvocationHandler 去獲得代理類例項的呼叫處理器物件。在代理類例項上呼叫其代理的介面中所宣告的方法時，這些方法最終都會由呼叫處理器的 invoke 方法執行，此外，值得注意的是，代理類的根類 java.lang.Object 中有三個方法也同樣會被分派到呼叫處理器的 invoke 方法執行，它們是 hashCode，equals 和 toString，可能的原因有：一是因為這些方法為 public 且非 final 型別，能夠被代理類覆蓋；二是因為這些方法往往呈現出一個類的某種特徵屬性，具有一定的區分度，所以為了保證代理類與委託類對外的一致性，這三個方法也應該被分派到委託類執行。當代理的一組介面有重複宣告的方法且該方法被呼叫時，代理類總是從排在最前面的介面中獲取方法物件並分派給呼叫處理器，而無論代理類例項是否正在以該介面（或繼承於該介面的某子介面）的形式被外部引用，因為在代理類內部無法區分其當前的被引用型別。

接著來了解一下被代理的一組介面有哪些特點。首先，要注意不能有重複的介面，以避免動態代理類程式碼生成時的編譯錯誤。其次，這些介面對於類裝載器必須可見，否則類裝載器將無法連結它們，將會導致類定義失敗。再次，需被代理的所有非 public 的介面必須在同一個包中，否則代理類生成也會失敗。最後，介面的數目不能超過 65535，這是 JVM 設定的限制。

最後再來了解一下異常處理方面的特點。從呼叫處理器介面宣告的方法中可以看到理論上它能夠丟擲任何型別的異常，因為所有的異常都繼承於 Throwable 介面，但事實是否如此呢？答案是否定的，原因是我們必須遵守一個繼承原則：即子類覆蓋父類或實現父介面的方法時，丟擲的異常必須在原方法支援的異常列表之內。所以雖然呼叫處理器理論上講能夠，但實際上往往受限制，除非父介面中的方法支援拋 Throwable 異常。那麼如果在 invoke 方法中的確產生了介面方法宣告中不支援的異常，那將如何呢？放心，Java 動態代理類已經為我們設計好了解決方法：它將會丟擲 UndeclaredThrowableException 異常。這個異常是一個 RuntimeException 型別，所以不會引起編譯錯誤。通過該異常的 getCause 方法，還可以獲得原來那個不受支援的異常物件，以便於錯誤診斷。

程式碼是最好的老師

機制和特點都介紹過了，接下來讓我們通過原始碼來了解一下 Proxy 到底是如何實現的。

首先記住 Proxy 的幾個重要的靜態變數：

清單 5. Proxy 的重要靜態變數
// 對映表：用於維護類裝載器物件到其對應的代理類快取
private static Map loaderToCache = new WeakHashMap(); 

// 標記：用於標記一個動態代理類正在被建立中
private static Object pendingGenerationMarker = new Object(); 

// 同步表：記錄已經被建立的動態代理類型別，主要被方法 isProxyClass 進行相關的判斷
private static Map proxyClasses = Collections.synchronizedMap(new WeakHashMap()); 

// 關聯的呼叫處理器引用
protected InvocationHandler h;

然後，來看一下 Proxy 的構造方法：

清單 6. Proxy 構造方法
// 由於 Proxy 內部從不直接呼叫建構函式，所以 private 型別意味著禁止任何呼叫
private Proxy() {} 

// 由於 Proxy 內部從不直接呼叫建構函式，所以 protected 意味著只有子類可以呼叫
protected Proxy(InvocationHandler h) {this.h = h;}

接著，可以快速瀏覽一下 newProxyInstance 方法，因為其相當簡單：

清單 7. Proxy 靜態方法 newProxyInstance
public static Object newProxyInstance(ClassLoader loader, 
            Class<?>[] interfaces, 
            InvocationHandler h) 
            throws IllegalArgumentException { 

    // 檢查 h 不為空，否則拋異常
    if (h == null) { 
        throw new NullPointerException(); 
    } 

    // 獲得與制定類裝載器和一組介面相關的代理類型別物件
    Class cl = getProxyClass(loader, interfaces); 

    // 通過反射獲取建構函式物件並生成代理類例項
    try { 
        Constructor cons = cl.getConstructor(constructorParams); 
        return (Object) cons.newInstance(new Object[] { h }); 
    } catch (NoSuchMethodException e) { throw new InternalError(e.toString()); 
    } catch (IllegalAccessException e) { throw new InternalError(e.toString()); 
    } catch (InstantiationException e) { throw new InternalError(e.toString()); 
    } catch (InvocationTargetException e) { throw new InternalError(e.toString()); 
    } 
}

由此可見，動態代理真正的關鍵是在 getProxyClass 方法，該方法負責為一組介面動態地生成代理類型別物件。在該方法內部，您將能看到 Proxy 內的各路英雄（靜態變數）悉數登場。有點迫不及待了麼？那就讓我們一起走進 Proxy 最最神祕的殿堂去欣賞一番吧。該方法總共可以分為四個步驟：

  1. 對這組介面進行一定程度的安全檢查，包括檢查介面類物件是否對類裝載器可見並且與類裝載器所能識別的介面類物件是完全相同的，還會檢查確保是 interface 型別而不是 class 型別。這個步驟通過一個迴圈來完成，檢查通過後將會得到一個包含所有介面名稱的字串陣列，記為 String[] interfaceNames。總體上這部分實現比較直觀，所以略去大部分程式碼，僅保留留如何判斷某類或介面是否對特定類裝載器可見的相關程式碼。
    清單 8. 通過 Class.forName 方法判介面的可見性
    try { 
    // 指定介面名字、類裝載器物件，同時制定 initializeBoolean 為 false 表示無須初始化類
    // 如果方法返回正常這表示可見，否則會丟擲 ClassNotFoundException 異常表示不可見
    interfaceClass = Class.forName(interfaceName, false, loader); 
} catch (ClassNotFoundException e) { 
}
  2. 從 loaderToCache 對映表中獲取以類裝載器物件為關鍵字所對應的快取表，如果不存在就建立一個新的快取表並更新到 loaderToCache。快取表是一個 HashMap 例項，正常情況下它將存放鍵值對（介面名字列表，動態生成的代理類的類物件引用）。當代理類正在被建立時它會臨時儲存（介面名字列表，pendingGenerationMarker）。標記 pendingGenerationMarke 的作用是通知後續的同類請求（介面陣列相同且組內介面排列順序也相同）代理類正在被建立，請保持等待直至建立完成。
    清單 9. 快取表的使用
    do { 
    // 以介面名字列表作為關鍵字獲得對應 cache 值
    Object value = cache.get(key); 
    if (value instanceof Reference) { 
        proxyClass = (Class) ((Reference) value).get(); 
    } 
    if (proxyClass != null) { 
        // 如果已經建立，直接返回
        return proxyClass; 
    } else if (value == pendingGenerationMarker) { 
        // 代理類正在被建立，保持等待
        try { 
            cache.wait(); 
        } catch (InterruptedException e) { 
        } 
        // 等待被喚醒，繼續迴圈並通過二次檢查以確保建立完成，否則重新等待
        continue; 
    } else { 
        // 標記代理類正在被建立
        cache.put(key, pendingGenerationMarker); 
        // break 跳出迴圈已進入建立過程
        break; 
} while (true);
  3. 動態建立代理類的類物件。首先是確定代理類所在的包，其原則如前所述，如果都為 public 介面，則包名為空字串表示頂層包；如果所有非 public 介面都在同一個包，則包名與這些介面的包名相同；如果有多個非 public 介面且不同包，則拋異常終止代理類的生成。確定了包後，就開始生成代理類的類名，同樣如前所述按格式“$ProxyN”生成。類名也確定了，接下來就是見證奇蹟的發生 —— 動態生成代理類：
    清單 10. 動態生成代理類
    // 動態地生成代理類的位元組碼陣列
byte[] proxyClassFile = ProxyGenerator.generateProxyClass( proxyName, interfaces); 
try { 
    // 動態地定義新生成的代理類
    proxyClass = defineClass0(loader, proxyName, proxyClassFile, 0, 
        proxyClassFile.length); 
} catch (ClassFormatError e) { 
    throw new IllegalArgumentException(e.toString()); 
} 

// 把生成的代理類的類物件記錄進 proxyClasses 表
proxyClasses.put(proxyClass, null);

    由此可見，所有的程式碼生成的工作都由神祕的 ProxyGenerator 所完成了，當你嘗試去探索這個類時，你所能獲得的資訊僅僅是它位於並未公開的 sun.misc 包，有若干常量、變數和方法以完成這個神奇的程式碼生成的過程，但是 sun 並沒有提供原始碼以供研讀。至於動態類的定義，則由 Proxy 的 native 靜態方法 defineClass0 執行。

  4. 程式碼生成過程進入結尾部分，根據結果更新快取表，如果成功則將代理類的類物件引用更新進快取表，否則清楚快取表中對應關鍵值，最後喚醒所有可能的正在等待的執行緒。

走完了以上四個步驟後，至此，所有的代理類生成細節都已介紹完畢，剩下的靜態方法如 getInvocationHandler 和 isProxyClass 就顯得如此的直觀，只需通過查詢相關變數就可以完成，所以對其的程式碼分析就省略了。

代理類實現推演

分析了 Proxy 類的原始碼，相信在讀者的腦海中會對 Java 動態代理機制形成一個更加清晰的理解，但是，當探索之旅在 sun.misc.ProxyGenerator 類處嘎然而止，所有的神祕都匯聚於此時，相信不少讀者也會對這個 ProxyGenerator 類產生有類似的疑惑：它到底做了什麼呢？它是如何生成動態代理類的程式碼的呢？誠然，這裡也無法給出確切的答案。還是讓我們帶著這些疑惑，一起開始探索之旅吧。

事物往往不像其看起來的複雜，需要的是我們能夠化繁為簡，這樣也許就能有更多撥雲見日的機會。拋開所有想象中的未知而複雜的神祕因素，如果讓我們用最簡單的方法去實現一個代理類，唯一的要求是同樣結合呼叫處理器實施方法的分派轉發，您的第一反應將是什麼呢？“聽起來似乎並不是很複雜”。的確，掐指算算所涉及的工作無非包括幾個反射呼叫，以及對原始型別資料的裝箱或拆箱過程，其他的似乎都已經水到渠成。非常地好，讓我們整理一下思緒，一起來完成一次完整的推演過程吧。

清單 11. 代理類中方法呼叫的分派轉發推演實現
// 假設需代理介面 Simulator 
public interface Simulator { 
    short simulate(int arg1, long arg2, String arg3) throws ExceptionA, ExceptionB;
} 

// 假設代理類為 SimulatorProxy, 其類宣告將如下
final public class SimulatorProxy implements Simulator { 

    // 呼叫處理器物件的引用
    protected InvocationHandler handler; 

    // 以呼叫處理器為引數的建構函式
    public SimulatorProxy(InvocationHandler handler){ 
        this.handler = handler; 
    } 

    // 實現介面方法 simulate 
    public short simulate(int arg1, long arg2, String arg3) 
        throws ExceptionA, ExceptionB {

        // 第一步是獲取 simulate 方法的 Method 物件
        java.lang.reflect.Method method = null; 
        try{ 
            method = Simulator.class.getMethod( 
                "simulate", 
                new Class[] {int.class, long.class, String.class} );
        } catch(Exception e) { 
            // 異常處理 1（略）
        } 

        // 第二步是呼叫 handler 的 invoke 方法分派轉發方法呼叫
        Object r = null; 
        try { 
            r = handler.invoke(this, 
                method, 
                // 對於原始型別引數需要進行裝箱操作
                new Object[] {new Integer(arg1), new Long(arg2), arg3});
        }catch(Throwable e) { 
            // 異常處理 2（略）
        } 
        // 第三步是返回結果（返回型別是原始型別則需要進行拆箱操作）
        return ((Short)r).shortValue();
    } 
}

模擬推演為了突出通用邏輯所以更多地關注正常流程，而淡化了錯誤處理，但在實際中錯誤處理同樣非常重要。從以上的推演中我們可以得出一個非常通用的結構化流程：第一步從代理介面獲取被呼叫的方法物件，第二步分派方法到呼叫處理器執行，第三步返回結果。在這之中，所有的資訊都是可以已知的，比如介面名、方法名、引數型別、返回型別以及所需的裝箱和拆箱操作，那麼既然我們手工編寫是如此，那又有什麼理由不相信 ProxyGenerator 不會做類似的實現呢？至少這是一種比較可能的實現。

接下來讓我們把注意力重新回到先前被淡化的錯誤處理上來。在異常處理 1 處，由於我們有理由確保所有的資訊如介面名、方法名和引數型別都準確無誤，所以這部分異常發生的概率基本為零，所以基本可以忽略。而異常處理 2 處，我們需要思考得更多一些。回想一下，介面方法可能宣告支援一個異常列表，而呼叫處理器 invoke 方法又可能丟擲與介面方法不支援的異常，再回想一下先前提及的 Java 動態代理的關於異常處理的特點，對於不支援的異常，必須拋 UndeclaredThrowableException 執行時異常。所以通過再次推演，我們可以得出一個更加清晰的異常處理 2 的情況：

清單 12. 細化的異常處理 2
Object r = null; 

try { 
    r = handler.invoke(this, 
        method, 
        new Object[] {new Integer(arg1), new Long(arg2), arg3}); 

} catch( ExceptionA e) { 

    // 介面方法支援 ExceptionA，可以丟擲
    throw e; 

} catch( ExceptionB e ) { 
    // 介面方法支援 ExceptionB，可以丟擲
    throw e; 

} catch(Throwable e) { 
    // 其他不支援的異常，一律拋 UndeclaredThrowableException 
    throw new UndeclaredThrowableException(e); 
}

這樣我們就完成了對動態代理類的推演實現。推演實現遵循了一個相對固定的模式，可以適用於任意定義的任何介面，而且程式碼生成所需的資訊都是可知的，那麼有理由相信即使是機器自動編寫的程式碼也有可能延續這樣的風格，至少可以保證這是可行的。

美中不足

誠然，Proxy 已經設計得非常優美，但是還是有一點點小小的遺憾之處，那就是它始終無法擺脫僅支援 interface 代理的桎梏，因為它的設計註定了這個遺憾。回想一下那些動態生成的代理類的繼承關係圖，它們已經註定有一個共同的父類叫 Proxy。Java 的繼承機制註定了這些動態代理類們無法實現對 class 的動態代理，原因是多繼承在 Java 中本質上就行不通。

有很多條理由，人們可以否定對 class 代理的必要性，但是同樣有一些理由，相信支援 class 動態代理會更美好。介面和類的劃分，本就不是很明顯，只是到了 Java 中才變得如此的細化。如果只從方法的宣告及是否被定義來考量，有一種兩者的混合體，它的名字叫抽象類。實現對抽象類的動態代理，相信也有其內在的價值。此外，還有一些歷史遺留的類，它們將因為沒有實現任何介面而從此與動態代理永世無緣。如此種種，不得不說是一個小小的遺憾。

但是，不完美並不等於不偉大，偉大是一種本質，Java 動態代理就是佐例。

相關文章