摘要
Reflection 是Java被視為動態(或準動態)語言的一個關鍵性質。這個機制允許程序在運行時透過Reflection APIs取得任何一個已知名稱的class的內部信息,包括其modifiers(諸如public, static 等等)、superclass(例Object)、實現之interfaces(例如Cloneable),也包括fields和methods的所有信息,并可于運行時改變fields內容或喚起methods。本文借由實例,大面積示范Reflection APIs。
關于本文:
讀者基礎:具備Java 語言基礎。
本文適用工具:JDK1.5
關鍵詞:
Introspection(內省、內觀)Reflection(反射)
有時候我們說某個語言具有很強的動態性,有時候我們會區分動態和靜態的不同技術與作法。我們朗朗上口動態綁定(dynamic binding)、動態鏈接(dynamic linking)、動態加載(dynamic loading)等。然而“動態”一詞其實沒有絕對而普遍適用的嚴格定義,有時候甚至像對象導向當初被導入編程領域一樣,一人一把號,各吹各的調。
一般而言,開發者社群說到動態語言,大致認同的一個定義是:“程序運行時,允許改變程序結構或變量類型,這種語言稱為動態語言”。從這個觀點看,Perl,Python,Ruby是動態語言,C++,Java,C#不是動態語言。
盡管在這樣的定義與分類下Java不是動態語言,它卻有著一個非常突出的動態相關機制:Reflection。這個字的意思是“反射、映象、倒影”,用在Java身上指的是我們可以于運行時加載、探知、使用編譯期間完全未知的classes。換句話說,Java程序可以加載一個運行時才得知名稱的class,獲悉其完整構造(但不包括methods定義),并生成其對象實體、或對其fields設值、或喚起其methods1。這種“看透class”的能力(the ability of the program to examine itself)被稱為introspection(內省、內觀、反省)。Reflection和introspection是常被并提的兩個術語。
Java如何能夠做出上述的動態特性呢?這是一個深遠話題,本文對此只簡單介紹一些概念。整個篇幅最主要還是介紹Reflection APIs,也就是讓讀者知道如何探索class的結構、如何對某個“運行時才獲知名稱的class”生成一份實體、為其fields設值、調用其methods。本文將談到java.lang.Class,以及java.lang.reflect中的Method、Field、Constructor等等classes。
“Class”class
眾所周知Java有個Object class,是所有Java classes的繼承根源,其內聲明了數個應該在所有Java class中被改寫的methods:hashCode()、equals()、clone()、toString()、getClass()等。其中getClass()返回一個Class object。
Class class十分特殊。它和一般classes一樣繼承自Object,其實體用以表達Java程序運行時的classes和interfaces,也用來表達enum、array、primitive Java types(boolean, byte, char, short, int, long, float, double)以及關鍵詞void。當一個class被加載,或當加載器(class loader)的defineClass()被JVM調用,JVM 便自動產生一個Class object。如果您想借由“修改Java標準庫源碼”來觀察Class object的實際生成時機(例如在Class的constructor內添加一個println()),不能夠!因為Class并沒有public constructor(見圖1)。本文最后我會撥一小塊篇幅順帶談談Java標準庫源碼的改動辦法。
Class是Reflection故事起源。針對任何您想探勘的class,唯有先為它產生一個Class object,接下來才能經由后者喚起為數十多個的Reflection APIs。這些APIs將在稍后的探險活動中一一亮相。
#001 public final
#002 class Class<T> implements java.io.Serializable,
#003 java.lang.reflect.GenericDeclaration,
#004 java.lang.reflect.Type,
#005 java.lang.reflect.AnnotatedElement {
#006 private Class() {}
#007 public String toString() {
#008 return ( isInterface() ? "interface " :
#009 (isPrimitive() ? "" : "class "))
#010 + getName();
#011 }
...
列表1:Class class片段。注意它的private empty ctor,意指不允許任何人經由編程方式產生Class object。是的,其object 只能由JVM 產生。
“Class” object的取得途徑
Java允許我們從多種管道為一個class生成對應的Class object。圖2是一份整理。
Class object 誕生管道
|
示例
|
運用getClass()
注:每個class 都有此函數
|
String str = "abc";
Class c1 = str.getClass();
|
運用
Class.getSuperclass()2
|
Button b = new Button();
Class c1 = b.getClass();
Class c2 = c1.getSuperclass();
|
運用static method
Class.forName()
(最常被使用)
|
Class c1 = Class.forName ("java.lang.String");
Class c2 = Class.forName ("java.awt.Button");
Class c3 = Class.forName ("java.util.LinkedList$Entry");
Class c4 = Class.forName ("I");
Class c5 = Class.forName ("[I");
|
運用
.class 語法
|
Class c1 = String.class;
Class c2 = java.awt.Button.class;
Class c3 = Main.InnerClass.class;
Class c4 = int.class;
Class c5 = int[].class;
|
運用
primitive wrapper classes
的TYPE 語法
|
Class c1 = Boolean.TYPE;
Class c2 = Byte.TYPE;
Class c3 = Character.TYPE;
Class c4 = Short.TYPE;
Class c5 = Integer.TYPE;
Class c6 = Long.TYPE;
Class c7 = Float.TYPE;
Class c8 = Double.TYPE;
Class c9 = Void.TYPE;
|
表2:Java 允許多種管道生成Class object。
Java classes 組成分析
首先容我以圖3的java.util.LinkedList為例,將Java class的定義大卸八塊,每一塊分別對應圖4所示的Reflection API。圖5則是“獲得class各區塊信息”的程序示例及執行結果,它們都取自本文示例程序的對應片段。
package java.util; //(1)
import java.lang.*; //(2)
public class LinkedList<E> //(3)(4)(5)
extends AbstractSequentialList<E> //(6)
implements List<E>, Queue<E>,
Cloneable, java.io.Serializable //(7)
{
private static class Entry<E> { … }//(8)
public LinkedList() { … } //(9)
public LinkedList(Collection<? extends E> c) { … }
public E getFirst() { … } //(10)
public E getLast() { … }
private transient Entry<E> header = …; //(11)
private transient int size = 0;
}
列表3:將一個Java class 大卸八塊,每塊相應于一個或一組Reflection APIs(表4)。
Java classes 各成份所對應的Reflection APIs
圖3的各個Java class成份,分別對應于圖4的Reflection API,其中出現的Package、Method、Constructor、Field等等classes,都定義于java.lang.reflect。
Java class 內部模塊(參見圖3)
|
Java class 內部模塊說明
|
相應之Reflection API,多半為Class methods。
|
返回值類型(return type)
|
(1) package
|
class隸屬哪個package
|
getPackage()
|
Package
|
(2) import
|
class導入哪些classes
|
無直接對應之API。
解決辦法見圖5-2。
|
|
(3) modifier
|
class(或methods, fields)的屬性
|
int getModifiers()
Modifier.toString(int)
Modifier.isInterface(int)
|
int
String
bool
|
(4) class name or interface name
|
class/interface
|
名稱getName()
|
String
|
(5) type parameters
|
參數化類型的名稱
|
getTypeParameters()
|
TypeVariable <Class>[]
|
(6) base class
|
base class(只可能一個)
|
getSuperClass()
|
Class
|
(7) implemented interfaces
|
實現有哪些interfaces
|
getInterfaces()
|
Class[]
|
(8) inner classes
|
內部classes
|
getDeclaredClasses()
|
Class[]
|
(8') outer class
|
如果我們觀察的class 本身是inner classes,那么相對它就會有個outer class。
|
getDeclaringClass()
|
Class
|
(9) constructors
|
構造函數getDeclaredConstructors()
|
不論 public 或private 或其它access level,皆可獲得。另有功能近似之取得函數。
|
Constructor[]
|
(10) methods
|
操作函數getDeclaredMethods()
|
不論 public 或private 或其它access level,皆可獲得。另有功能近似之取得函數。
|
Method[]
|
(11) fields
|
字段(成員變量)
|
getDeclaredFields()不論 public 或private 或其它access level,皆可獲得。另有功能近似之取得函數。
|
Field[]
|
表4:Java class大卸八塊后(如圖3),每一塊所對應的Reflection API。本表并非
Reflection APIs 的全部。
Java Reflection API 運用示例
圖5示范圖4提過的每一個Reflection API,及其執行結果。程序中出現的tName()是個輔助函數,可將其第一自變量所代表的“Java class完整路徑字符串”剝除路徑部分,留下class名稱,儲存到第二自變量所代表的一個hashtable去并返回(如果第二自變量為null,就不儲存而只是返回)。
#001 Class c = null;
#002 c = Class.forName(args[0]);
#003
#004 Package p;
#005 p = c.getPackage();
#006
#007 if (p != null)
#008 System.out.println("package "+p.getName()+";");
執行結果(例):
package java.util;
列表5-1:找出class 隸屬的package。其中的c將繼續沿用于以下各程序片段。
#001 ff = c.getDeclaredFields();
#002 for (int i = 0; i < ff.length; i++)
#003 x = tName(ff[i].getType().getName(), classRef);
#004
#005 cn = c.getDeclaredConstructors();
#006 for (int i = 0; i < cn.length; i++) {
#007 Class cx[] = cn[i].getParameterTypes();
#008 for (int j = 0; j < cx.length; j++)
#009 x = tName(cx[j].getName(), classRef);
#010 }
#011
#012 mm = c.getDeclaredMethods();
#013 for (int i = 0; i < mm.length; i++) {
#014 x = tName(mm[i].getReturnType().getName(), classRef);
#015 Class cx[] = mm[i].getParameterTypes();
#016 for (int j = 0; j < cx.length; j++)
#017 x = tName(cx[j].getName(), classRef);
#018 }
#019 classRef.remove(c.getName()); //不必記錄自己(不需import 自己)
執行結果(例):
import java.util.ListIterator;
import java.lang.Object;
import java.util.LinkedList$Entry;
import java.util.Collection;
import java.io.ObjectOutputStream;
import java.io.ObjectInputStream
列表5-2:找出導入的classes,動作細節詳見內文說明。
#001 int mod = c.getModifiers();
#002 System.out.print(Modifier.toString(mod)); //整個modifier
#003
#004 if (Modifier.isInterface(mod))
#005 System.out.print(" "); //關鍵詞 "interface" 已含于modifier
#006 else
#007 System.out.print(" class "); //關鍵詞 "class"
#008 System.out.print(tName(c.getName(), null)); //class 名稱
執行結果(例):
public class LinkedList
列表5-3:找出class或interface 的名稱,及其屬性(modifiers)。
#001 TypeVariable<Class>[] tv;
#002 tv = c.getTypeParameters(); //warning: unchecked conversion
#003 for (int i = 0; i < tv.length; i++) {
#004 x = tName(tv[i].getName(), null); //例如 E,K,V...
#005 if (i == 0) //第一個
#006 System.out.print("<" + x);
#007 else //非第一個
#008 System.out.print("," + x);
#009 if (i == tv.length-1) //最后一個
#010 System.out.println(">");
#011 }
執行結果(例):
public abstract interface Map<K,V>
或 public class LinkedList<E>
列表5-4:找出parameterized types 的名稱
#001 Class supClass;
#002 supClass = c.getSuperclass();
#003 if (supClass != null) //如果有super class
#004 System.out.print(" extends" +
#005 tName(supClass.getName(),classRef));
執行結果(例):
public class LinkedList<E>
extends AbstractSequentialList,
列表-5:找出base class。執行結果多出一個不該有的逗號于尾端。此非本處重點,為簡化計,不多做處理。
#001 Class cc[];
#002 Class ctmp;
#003 //找出所有被實現的interfaces
#004 cc = c.getInterfaces();
#005 if (cc.length != 0)
#006 System.out.print(", \r\n" + " implements "); //關鍵詞
#007 for (Class cite : cc) //JDK1.5 新式循環寫法
#008 System.out.print(tName(cite.getName(), null)+", ");
執行結果(例):
public class LinkedList<E>
extends AbstractSequentialList,
implements List, Queue, Cloneable, Serializable,
列表5-6:找出implemented interfaces。執行結果多出一個不該有的逗號于尾端。此非本處重點,為簡化計,不多做處理。
#001 cc = c.getDeclaredClasses(); //找出inner classes
#002 for (Class cite : cc)
#003 System.out.println(tName(cite.getName(), null));
#004
#005 ctmp = c.getDeclaringClass(); //找出outer classes
#006 if (ctmp != null)
#007 System.out.println(ctmp.getName());
執行結果(例):
LinkedList$Entry
LinkedList$ListItr
列表-7:找出inner classes 和outer class
#001 Constructor cn[];
#002 cn = c.getDeclaredConstructors();
#003 for (int i = 0; i < cn.length; i++) {
#004 int md = cn[i].getModifiers();
#005 System.out.print(" " + Modifier.toString(md) + " " +
#006 cn[i].getName());
#007 Class cx[] = cn[i].getParameterTypes();
#008 System.out.print("(");
#009 for (int j = 0; j < cx.length; j++) {
#010 System.out.print(tName(cx[j].getName(), null));
#011 if (j < (cx.length - 1)) System.out.print(", ");
#012 }
#013 System.out.print(")");
#014 }
執行結果(例):
public java.util.LinkedList(Collection)
public java.util.LinkedList()
列表5-8a:找出所有constructors
#004 System.out.println(cn[i].toGenericString());
執行結果(例):
public java.util.LinkedList(java.util.Collection<? extends E>)
public java.util.LinkedList()
列表5-8b:找出所有constructors。本例在for 循環內使用toGenericString(),省事。
#001 Method mm[];
#002 mm = c.getDeclaredMethods();
#003 for (int i = 0; i < mm.length; i++) {
#004 int md = mm[i].getModifiers();
#005 System.out.print(" "+Modifier.toString(md)+" "+
#006 tName(mm[i].getReturnType().getName(), null)+" "+
#007 mm[i].getName());
#008 Class cx[] = mm[i].getParameterTypes();
#009 System.out.print("(");
#010 for (int j = 0; j < cx.length; j++) {
#011 System.out.print(tName(cx[j].getName(), null));
#012 if (j < (cx.length - 1)) System.out.print(", ");
#013 }
#014 System.out.print(")");
#015 }
執行結果(例):
public Object get(int)
public int size()
列表5-9a:找出所有methods
#004 System.out.println(mm[i].toGenericString());
public E java.util.LinkedList.get(int)
public int java.util.LinkedList.size()
列表5-9b:找出所有methods。本例在for 循環內使用toGenericString(),省事。
#001 Field ff[];
#002 ff = c.getDeclaredFields();
#003 for (int i = 0; i < ff.length; i++) {
#004 int md = ff[i].getModifiers();
#005 System.out.println(" "+Modifier.toString(md)+" "+
#006 tName(ff[i].getType().getName(), null) +" "+
#007 ff[i].getName()+";");
#008 }
執行結果(例):
private transient LinkedList$Entry header;
private transient int size;
列表5-10a:找出所有fields
#004 System.out.println("G: " + ff[i].toGenericString());
private transient java.util.LinkedList.java.util.LinkedList$Entry<E> ??
java.util.LinkedList.header
private transient int java.util.LinkedList.size
列表5-10b:找出所有fields。本例在for 循環內使用toGenericString(),省事。
找出class參用(導入)的所有classes
沒有直接可用的Reflection API可以為我們找出某個class參用的所有其它classes。要獲得這項信息,必須做苦工,一步一腳印逐一記錄。我們必須觀察所有fields的類型、所有methods(包括constructors)的參數類型和回返類型,剔除重復,留下唯一。這正是為什么圖5-2程序代碼要為tName()指定一個hashtable(而非一個null)做為第二自變量的緣故:hashtable可為我們儲存元素(本例為字符串),又保證不重復。
本文討論至此,幾乎可以還原一個class的原貌(唯有methods 和ctors的定義無法取得)。接下來討論Reflection 的另三個動態性質:(1) 運行時生成instances,(2) 執
行期喚起methods,(3) 運行時改動fields。
運行時生成instances
欲生成對象實體,在Reflection 動態機制中有兩種作法,一個針對“無自變量ctor”,
一個針對“帶參數ctor”。圖6是面對“無自變量ctor”的例子。如果欲調用的是“帶參數ctor“就比較麻煩些,圖7是個例子,其中不再調用Class的newInstance(),而是調用Constructor 的newInstance()。圖7首先準備一個Class[]做為ctor的參數類型(本例指定為一個double和一個int),然后以此為自變量調用getConstructor(),獲得一個專屬ctor。接下來再準備一個Object[] 做為ctor實參值(本例指定3.14159和125),調用上述專屬ctor的newInstance()。
#001 Class c = Class.forName("DynTest");
#002 Object obj = null;
#003 obj = c.newInstance(); //不帶自變量
#004 System.out.println(obj);
列表6:動態生成“Class object 所對應之class”的對象實體;無自變量。
#001 Class c = Class.forName("DynTest");
#002 Class[] pTypes = new Class[] { double.class, int.class };
#003 Constructor ctor = c.getConstructor(pTypes);
#004 //指定parameter list,便可獲得特定之ctor
#005
#006 Object obj = null;
#007 Object[] arg = new Object[] {3.14159, 125}; //自變量
#008 obj = ctor.newInstance(arg);
#009 System.out.println(obj);
圖7:動態生成“Class object 對應之class”的對象實體;自變量以Object[]表示。
運行時調用methods
這個動作和上述調用“帶參數之ctor”相當類似。首先準備一個Class[]做為ctor的參數類型(本例指定其中一個是String,另一個是Hashtable),然后以此為自變量調用getMethod(),獲得特定的Method object。接下來準備一個Object[]放置自變量,然后調用上述所得之特定Method object的invoke(),如圖8。知道為什么索取Method object時不需指定回返類型嗎?因為method overloading機制要求signature(署名式)必須唯一,而回返類型并非signature的一個成份。換句話說,只要指定了method名稱和參數列,就一定指出了一個獨一無二的method。
#001 public String func(String s, Hashtable ht)
#002 {
#003 …System.out.println("func invoked"); return s;
#004 }
#005 public static void main(String args[])
#006 {
#007 Class c = Class.forName("Test");
#008 Class ptypes[] = new Class[2];
#009 ptypes[0] = Class.forName("java.lang.String");
#010 ptypes[1] = Class.forName("java.util.Hashtable");
#011 Method m = c.getMethod("func",ptypes);
#012 Test obj = new Test();
#013 Object args[] = new Object[2];
#014 arg[0] = new String("Hello,world");
#015 arg[1] = null;
#016 Object r = m.invoke(obj, arg);
#017 Integer rval = (String)r;
#018 System.out.println(rval);
#019 }
圖8:動態喚起method
運行時變更fields內容
與先前兩個動作相比,“變更field內容”輕松多了,因為它不需要參數和自變量。首先調用Class的getField()并指定field名稱。獲得特定的Field object之后便可直接調用Field的get()和set(),如圖9。
#001 public class Test {
#002 public double d;
#003
#004 public static void main(String args[])
#005 {
#006 Class c = Class.forName("Test");
#007 Field f = c.getField("d"); //指定field 名稱
#008 Test obj = new Test();
#009 System.out.println("d= " + (Double)f.get(obj));
#010 f.set(obj, 12.34);
#011 System.out.println("d= " + obj.d);
#012 }
#013 }
列表9:動態變更field 內容
Java 源碼改動辦法
先前我曾提到,原本想借由“改動Java標準庫源碼”來測知Class object的生成,但由于其ctor原始設計為private,也就是說不可能透過這個管道生成Class object(而是由class loader負責生成),因此“在ctor中打印出某種信息”的企圖也就失去了意義。
這里我要談點題外話:如何修改Java標準庫源碼并讓它反應到我們的應用程序來。假設我想修改java.lang.Class,讓它在某些情況下打印某種信息。首先必須找出標準源碼!當你下載JDK 套件并安裝妥當,你會發現jdk150\src\java\lang 目錄(見圖10)之中有Class.java,這就是我們此次行動的標準源碼。備份后加以修改,編譯獲得Class.class。接下來準備將.class 搬移到jdk150\jre\lib\endorsed(見圖10)。
這是一個十分特別的目錄,class loader將優先從該處讀取內含classes的.jar文件——成功的條件是.jar內的classes壓縮路徑必須和Java標準庫的路徑完全相同。為此,我們可以將剛才做出的Class.class先搬到一個為此目的而刻意做出來的\java\lang目錄中,壓縮為foo.zip(任意命名,唯需夾帶路徑java\lang),再將這個foo.zip搬到jdk150\jre\lib\endorsed并改名為foo.jar。此后你的應用程序便會優先用上這里的java.lang.Class。整個過程可寫成一個批處理文件(batch file),如圖11,在DOS Box中使用。

圖10:JDK1.5 安裝后的目錄組織。其中的endorsed 是我新建。
del e:\java\lang\*.class //清理干凈
del c:\jdk150\jre\lib\endorsed\foo.jar //清理干凈
c:
cd c:\jdk150\src\java\lang
javac -Xlint:unchecked Class.java //編譯源碼
javac -Xlint:unchecked ClassLoader.java //編譯另一個源碼(如有必要)
move *.class e:\java\lang //搬移至刻意制造的目錄中
e:
cd e:\java\lang //以下壓縮至適當目錄
pkzipc -add -path=root c:\jdk150\jre\lib\endorsed\foo.jar *.class
cd e:\test //進入測試目錄
javac -Xlint:unchecked Test.java //編譯測試程序
java Test //執行測試程序
列表11:一個可在DOS Box中使用的批處理文件(batch file),用以自動化java.lang.Class
的修改動作。Pkzipc(.exe)是個命令列壓縮工具,add和path都是其命令。
更多信息
以下是視野所及與本文主題相關的更多討論。這些信息可以彌補因文章篇幅限制而帶來的不足,或帶給您更多視野。
l "Take an in-depth look at the Java Reflection API -- Learn about the new Java 1.1 tools forfinding out information about classes", by Chuck McManis。此篇文章所附程序代碼是本文示例程序的主要依據(本文示例程序示范了更多Reflection APIs,并采用JDK1.5 新式的for-loop 寫法)。
l "Take a look inside Java classes -- Learn to deduce properties of a Java class from inside aJava program", by Chuck McManis。
l "The basics of Java class loaders -- The fundamentals of this key component of the Javaarchitecture", by Chuck McManis。
l 《The Java Tutorial Continued》, Sun microsystems. Lesson58-61, "Reflection".
注1用過諸如MFC這類所謂 Application Framework的程序員也許知道,MFC有所謂的dynamic creation。但它并不等同于Java的動態加載或動態辨識;所有能夠在MFC程序中起作用的classes,都必須先在編譯期被編譯器“看見”。
注2如果操作對象是Object,Class.getSuperClass()會返回null。
凡是有該標志的文章,都是該blog博主Caoer(草兒)原創,凡是索引、收藏
、轉載請注明來處和原文作者。非常感謝。