Java設計模式之代理模式_動力節點Java學院整理

引言

Java 動態代理機制的出現，使得 Java 開發人員不用手工編寫代理類，只要簡單地指定一組接口及委托類對象，便能動態地獲得代理類。代理類會負責將所有的方法調用分派到委托對象上反射執行，在分派執行的過程中，開發人員還可以按需調整委托類對象及其功能，這是一套非常靈活有彈性的代理框架。通過閱讀本文，讀者將會對 Java 動態代理機制有更加深入的理解。本文首先從 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. 動態代理類的繼承圖

由圖可見，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 動態代理就是佐例。