#大標=Java反射機制 #副標= Java Reflection #作者=文/侯捷 # ============= 程式1 Class class片段。注意它的private empty ctor,意指不允許任何人經由編程方式產生Class object。是的,其object只能由JVM產生。 #001 public final #002 class Class 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 } ... ================ #中標="Class" object的取得途徑 Java允許我們從多種管道為一個class生成對應的Class object。表1是一份整理。 ================= 表1 Java允許多種管道生成Class object。 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; ================ #中標=Java classes組成分析 首先容我以程式2的java.util.LinkedList為例,將Java class的定義大卸八塊,每一塊分別對應表2所示的Reflection API。程式3則是「獲得class各區塊資訊」的程式示例及執行結果,它們都取自本文示例程式的對應片段。 ============= 程式2 將一個Java class大卸八塊,每塊相應於一個或一組Reflection APIs(表2)。 package java.util; //(1) import java.lang.*; //(2) public class LinkedList //(3)(4)(5) extends AbstractSequentialList //(6) implements List, Queue, Cloneable, java.io.Serializable //(7) { private static class Entry { … } //(8) public LinkedList() { … } //(9) public LinkedList(Collection c) { … } public E getFirst() { … } //(10) public E getLast() { … } private transient Entry header = …; //(11) private transient int size = 0; } ================ #中標=Java classes各成份所對應的Reflection APIs 程式2的各個Java class成份,分別對應於表2的Reflection API,其中出現的Package, Method, Constructor, Field等等classes,都定義於java.lang.reflect。 ================= 表2 Java class大卸八塊後(如程式2),每一塊所對應的Reflection API。本表並非Reflection APIs的全部。 Java class內部模塊(參見程式2) Java class內部模塊說明 相應之Reflection API. 多半為Class methods. 傳回值型別 (return type) (1) package class隸屬哪個package getPackage() Package (2) import class匯入哪些classes 無直接對應之API。 解決辦法見程式3-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 [] (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[] ================ #中標=Java Reflection API運用示例 程式3示範表2提過的每一個Reflection API,及其執行結果。程式中出現的tName()是個輔助函式,可將其第一引數所代表的「Java class完整路徑字串」剝除路徑部分,留下class名稱,儲存到第二引數所代表的一個hashtable去並傳回(如果第二引數為null,就不儲存而只是傳回)。 ============= 程式3-1 找出class隸屬的package。其中的c將繼續沿用於以下各程式片段。 #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; ================ ============= 程式3-2 找出匯入的classes,動作細節詳見內文說明。 #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; ================ ============= 程式3-3 找出class或interface的名稱,及其屬性(modifiers)。 #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 ================ ============= 程式3-4 找出parameterized types的名稱。 #001 TypeVariable[] 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 或 public class LinkedList ================ ================ 程式3-5 找出base class。執行結果多出一個不該有的逗號於尾端。此非本處重點,為簡化計,不多做處理。 #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 extends AbstractSequentialList, ================ ============= 程式3-6 找出implemented interfaces。執行結果多出一個不該有的逗號於尾端。此非本處重點,為簡化計,不多做處理。 #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 extends AbstractSequentialList, implements List, Queue, Cloneable, Serializable, ================ ============= 程式3-7 / 找出inner classes和outer class。 #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 ================ ============= 程式3-8a 找出所有constructors。 #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() ================ ============= 程式3-8b 找出所有constructors。本例在for迴圈內使用toGenericString(),省事。 #004 System.out.println(cn[i].toGenericString()); 執行結果(例): public java.util.LinkedList(java.util.Collection) public java.util.LinkedList() ================ ============= 程式3-9a 找出所有methods。 #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() ================ ================ 程式3-9b 找出所有methods。本例在for迴圈內使用toGenericString(),省事。 #004 System.out.println(mm[i].toGenericString()); public E java.util.LinkedList.get(int) public int java.util.LinkedList.size() ================ ============= 程式3-10a 找出所有fields。 #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; ================ ============= 程式3-10b / 找出所有fields。本例在for迴圈內使用toGenericString(),省事。 #004 System.out.println("G: " + ff[i].toGenericString()); private transient java.util.LinkedList.java.util.LinkedList$Entry �t java.util.LinkedList.header private transient int java.util.LinkedList.size ================ ============= 程式4 動態生成「Class object所對應之class」的物件實體;無引數。 #001 Class c = Class.forName("DynTest"); #002 Object obj = null; #003 obj = c.newInstance(); //不帶引數 #004 System.out.println(obj); ================ ============= 程式5 動態生成「Class object對應之class」的物件實體;引數以Object[]表示。 #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); ================ ============= 程式6 動態喚起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 } ================ ============= 程式7 動態變更field內容。 #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 } ================ ============= 程式8 一個可在DOS Box中使用的批次檔(batch file),用以自動化java.lang.Class的修改動作。Pkzipc(.exe)是個命令列壓縮工具,add和path都是其命令。 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 //執行測試程式 ================ ============= 相關資源 以下是視野所及與本文主題相關的更多討論。這些資訊可以彌補因文章篇幅限制而帶來的不足,或帶給你更多視野。 * "Take an in-depth look at the Java Reflection API -- Learn about the new Java 1.1 tools for finding out information about classes", by Chuck McManis。此篇文章所附程式碼是本文示例程式的主要依據(本文示例程式示範了更多Reflection APIs,並採用JDK1.5新式的for-loop寫法)。 * "Take a look inside Java classes -- Learn to deduce properties of a Java class from inside a Java program", by Chuck McManis。 * "The basics of Java class loaders -- The fundamentals of this key component of the Java architecture", by Chuck McManis。 * 《The Java Tutorial Continued》, Sun microsystems. Lesson58-61, "Reflection". ================