JAVA反射機制

JAVA反射機制是在運行狀態中，對於任意一個實體類，都能夠知道這個類的所有屬性和方法；對於任意一個對象，都能夠調用它的任意方法和屬性；這種動態獲取信息以及動態調用對象方法的功能稱為java語言的反射機制。

JAVA反射（放射）機制：“程式運行時，允許改變程式結構或變數類型，這種語言稱為動態語言”。從這個觀點看，Perl，Python，Ruby是動態語言，C++，Java，C#不是動態語言。但是JAVA有著一個非常突出的動態相關機制：Reflection，用在Java身上指的是我們可以於運行時載入、探知、使用編譯期間完全未知的classes。換句話說，Java程式可以載入一個運行時才得知名稱的class，獲悉其完整構造（但不包括methods定義），並生成其對象實體、或對其fields設值、或喚起其methods。

基本介紹

• 中文名：JAVA反射機制
• 外文名：JAVA Reflection
• 所屬語言：JAVA
• 屬性：靜態語言

功能

Java反射機制主要提供了以下功能： 在運行時判斷任意一個對象所屬的類；在運行時構造任意一個類的對象；在運行時判斷任意一個類所具有的成員變數和方法；在運行時調用任意一個對象的方法；生成動態代理。

有時候我們說某個語言具有很強的動態性，有時候我們會區分動態和靜態的不同技術與作法。我們朗朗上口動態綁定（dynamic binding）、動態連結（dynamic linking）、動態載入（dynamic loading）等。然而“動態”一詞其實沒有絕對而普遍適用的嚴格定義，有時候甚至像面向對象當初被導入編程領域一樣，一人一把號，各吹各的調。

一般而言，開發者社群說到動態語言，大致認同的一個定義是：“程式運行時，允許改變程式結構或變數類型，這種語言稱為動態語言”。從這個觀點看，Perl，Python，Ruby是動態語言，C++，Java，C#不是動態語言。

儘管在這樣的定義與分類下Java不是動態語言，它卻有著一個非常突出的動態相關機制：Reflection。這個字的意思是“反射、映象、倒影”，用在Java身上指的是我們可以於運行時載入、探知、使用編譯期間完全未知的classes。換句話說，Java程式可以載入一個運行時才得知名稱的class，獲悉其完整構造（但不包括methods定義），並生成其對象實體、或對其fields設值、或喚起其methods。這種“看透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

眾所周知Java有個Object 類，是所有Java 類的繼承根源，其內聲明了數個應該在所有Java 類中被改寫的方法：hashCode()、equals()、clone()、toString()、getClass()等。其中getClass()返回一個Class 對象。

Class 類十分特殊。它和一般類一樣繼承自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 對象。如果您想藉由“修改Java標準庫源碼”來觀察Class 對象的實際生成時機（例如在Class的constructor內添加一個println()），這樣是行不通的！因為Class並沒有public constructor。

Class是Reflection故事起源。針對任何您想探勘的類，唯有先為它產生一個Class 對象，接下來才能經由後者喚起為數十多個的Reflection APIs。這些APIs將在稍後的探險活動中一一亮相。

public final class Class<T> implements Serializable,         java.lang.reflect.GenericDeclaration,        java.lang.reflect.Type,        java.lang.reflect.AnnotatedElement {     private Class() {}     public String toString() {         return ( isInterface() ? "interface " : (isPrimitive() ? "" : "class "))                      + getName();}

上述為Class class片段。注意它的private Class() {}，意指不允許任何人經由編程方式產生Class object。是的，其object 只能由JVM 產生。

取得途徑

Java允許我們從多種管道為一個class生成對應的Class object。圖2是一份整理。

Class object 誕生管道

示例：

1)運用getClass()

註：每個class 都有此函式

String str = "abc";

Class c1 = str.getClass();

2)運用Class.getSuperclass()

Button b = new Button();

Class c1 = b.getClass();

Class c2 = c1.getSuperclass();

3)運用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 (".class");

4)運用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各區塊信息”的程式示例及執行結果，它們都取自本文示例程式的對應片段。

packagejava.util; //(1)

import java.lang.*; //(2)

public class LinkedList<E> //(3)(4)(5)

extendsAbstractSequentialList<E> //(6)

implements List<E>, Queue<E>,

Cloneable, .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）。

API

圖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()

Method[]

(11) fields

欄位（成員變數）

getDeclaredFields()

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.getType().getName(), classRef);

#004

#005 cn = c.getDeclaredConstructors();

#006 for (int i = 0; i < cn.length; i++) {

#007 Class cx[] = cn.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.getReturnType().getName(), classRef);

#015 Class cx[] = mm.getParameterTypes();

#016 for (int j = 0; j < cx.length; j++)

#017 x = tName(cx[j].getName(), classRef);

#018 }

#019 classRef.remove(c.getName()); //不必記錄自己（不需import 自己）

執行結果（例）：

importjava.util.ListIterator;

import java.lang.Object;

importjava.util.LinkedList$Entry;

importjava.util.Collection;

import ObjectOutputStream;

import .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.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-5：找出base class。執行結果多出一個不該有的逗號於尾端。此非本處重點，為簡化計，不多做處理。

#001 Class cc[];

#002 Class ctmp;

#003 //找出所有被實現的interfaces

#004 cc = c.getInterfaces();

#005 if (cc.length != 0)

#006 System.out.print(", " + " implements "); //關鍵字

#007 for (Class cite : cc) //JDK1.5 新式循環寫法

#008 System.out.print(tName(cite.getName(), null)+", ");

執行結果（例）：

public class LinkedList<E>

extendsAbstractSequentialList,

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

圖5-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.getModifiers();

#005 System.out.print(" " + Modifier.toString(md) + " " +

#006 cn.getName());

#007 Class cx[] = cn.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 }

執行結果（例）：

publicjava.util.LinkedList(Collection)

publicjava.util.LinkedList()

圖5-8a：找出所有constructors

#004 System.out.println(cn.toGenericString());

執行結果（例）：

publicjava.util.LinkedList(java.util.Collection<? extends E>)

publicjava.util.LinkedList()

圖5-8b：找出所有constructors

#001 Method mm[];

#002 mm = c.getDeclaredMethods();

#003 for (int i = 0; i < mm.length; i++) {

#004 int md = mm.getModifiers();

#005 System.out.print(" "+Modifier.toString(md)+" "+

#006 tName(mm.getReturnType().getName(), null)+" "+

#007 mm.getName());

#008 Class cx[] = mm.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.toGenericString());

public Ejava.util.LinkedList.get(int)

public intjava.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.getModifiers();

#005 System.out.println(" "+Modifier.toString(md)+" "+

#006 tName(ff.getType().getName(), null) +" "+

#007 ff.getName()+";");

#008 }

執行結果（例）：

private transient LinkedList$Entry header;

private transient int size;

圖5-10a：找出所有fields

#004 System.out.println("G: " + ff.toGenericString());

private transientjava.util.LinkedList.java.util.LinkedList$Entry<E> ??

java.util.LinkedList.header

private transient intjava.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標準庫源碼”來測知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。

關於Java

詹姆斯·戈士林博士以“Java技術之父”聞名於世。他是Java技術的創始人， 作為Sun研究院院士，他親手設計了Java語言，完成了Java技術的原始編譯器和虛擬機。在他的帶領下，Java現已成為網際網路的標準編程模式以及分散式企業級套用的事實標準，其跨平台的技術優勢為網路計算帶來了劃時代的變革。目前，戈士林博士積極致力於軟體開發工具的研究，以使軟體開發工具的功能更強大，更容易為開發人員所使用，確保套用、服務開發的迅速完成。

Java技術是Sun公司在1995年5月正式推出的。二十多年來，Java已從程式語言發展成為全球第一大通用開發平台。Java技術已為計算機行業主要公司所採納，同時也被越來越多的國際技術標準化組織所接受。1999年，Sun推出了以Java 2平台為核心的J2EE、J2SE和J2ME三大平台。隨著三大平台的迅速推進，在世界上形成了一股巨大的Java套用浪潮。同時，Java技術還引發了一場無法停止的大變革，為整個Java社團帶來了巨大的潮水般的商業機會。

Java技術及其套用將有更大的發展。據IDC預計，自2001年起的其後5年內，採用Java的IT產品的價值將翻番，在2006年將達到4.53億美元，年增長率為14.9%。截止到2003年5月，註冊Java Developer Connection (JDC)的Java開發商超過300萬人，對JRE(Java運行環境)的下載達7,200萬次。Sun在JavaOne 2003大會上確定的目標是，在3～5年內使Java技術開發商從今天的300萬發展到1,000萬，以支持Java技術這一全球領先技術平台的顯赫地位。