很少需要直接使用反射工具;之所以在語言中提供它們,僅僅是為了支持其他Java特性,比如對象序列化(第10章介紹)、Java Beans以及RMI(本章後面介紹)。但是,我們許多時候仍然需要動態提取與一個類有關的資料。其中特別有用的工具便是一個類方法提取器。正如前面指出的那樣,若檢視類定義源碼或者聯機文檔,只能看到在那個類定義中被定義或覆蓋的方法,基礎類那裡還有大量資料拿不到。幸運的是,“反射”做到了這一點,可用它寫一個簡單的工具,令其自動展示整個接口。下面便是具體的程序:
//: ShowMethods.java
// Using Java 1.1 reflection to show all the
// methods of a class, even if the methods are
// defined in the base class.
import java.lang.reflect.*;
public class ShowMethods {
static final String usage =
"usage: \n" +
"ShowMethods qualified.class.name\n" +
"To show all methods in class or: \n" +
"ShowMethods qualified.class.name word\n" +
"To search for methods involving 'word'";
public static void main(String[] args) {
if(args.length < 1) {
System.out.println(usage);
System.exit(0);
}
try {
Class c = Class.forName(args[0]);
Method[] m = c.getMethods();
Constructor[] ctor = c.getConstructors();
if(args.length == 1) {
for (int i = 0; i < m.length; i++)
System.out.println(m[i].toString());
for (int i = 0; i < ctor.length; i++)
System.out.println(ctor[i].toString());
}
else {
for (int i = 0; i < m.length; i++)
if(m[i].toString()
.indexOf(args[1])!= -1)
System.out.println(m[i].toString());
for (int i = 0; i < ctor.length; i++)
if(ctor[i].toString()
.indexOf(args[1])!= -1)
System.out.println(ctor[i].toString());
}
} catch (ClassNotFoundException e) {
System.out.println("No such class: " + e);
}
}
} ///:~
Class方法getMethods()和getConstructors()可以分別返回Method和Constructor的一個數組。每個類都提供了進一步的方法,可解析出它們所代表的方法的名字、參數以及返回值。但也可以象這樣一樣只使用toString(),生成一個含有完整方法簽名的字串。代碼剩余的部分只是用於提取命令行信息,判斷特定的簽名是否與我們的目標字串相符(使用indexOf()),並打印出結果。
這裡便用到了“反射”技術,因為由Class.forName()產生的結果不能在編譯期間獲知,所以所有方法簽名信息都會在運行期間提取。若研究一下聯機文檔中關於“反射”(Reflection)的那部分文字,就會發現它已提供了足夠多的支持,可對一個編譯期完全未知的對象進行實際的設置以及發出方法調用。同樣地,這也屬於幾乎完全不用我們操心的一個步驟——Java自己會利用這種支持,所以程序設計環境能夠控制Java Beans——但它無論如何都是非常有趣的。
一個有趣的試驗是運行java ShowMehods ShowMethods。這樣做可得到一個列表,其中包括一個public默認構建器,盡管我們在代碼中看見並沒有定義一個構建器。我們看到的是由編譯器自動合成的那一個構建器。如果隨之將ShowMethods設為一個非public類(即換成“友好”類),合成的默認構建器便不會在輸出結果中出現。合成的默認構建器會自動獲得與類一樣的訪問權限。
ShowMethods的輸出仍然有些“不爽”。例如,下面是通過調用java ShowMethods java.lang.String得到的輸出結果的一部分:
public boolean java.lang.String.startsWith(java.lang.String,int) public boolean java.lang.String.startsWith(java.lang.String) public boolean java.lang.String.endsWith(java.lang.String)
若能去掉象java.lang這樣的限定詞,結果顯然會更令人滿意。有鑒於此,可引入上一章介紹的StreamTokenizer類,解決這個問題:
//: ShowMethodsClean.java
// ShowMethods with the qualifiers stripped
// to make the results easier to read
import java.lang.reflect.*;
import java.io.*;
public class ShowMethodsClean {
static final String usage =
"usage: \n" +
"ShowMethodsClean qualified.class.name\n" +
"To show all methods in class or: \n" +
"ShowMethodsClean qualif.class.name word\n" +
"To search for methods involving 'word'";
public static void main(String[] args) {
if(args.length < 1) {
System.out.println(usage);
System.exit(0);
}
try {
Class c = Class.forName(args[0]);
Method[] m = c.getMethods();
Constructor[] ctor = c.getConstructors();
// Convert to an array of cleaned Strings:
String[] n =
new String[m.length + ctor.length];
for(int i = 0; i < m.length; i++) {
String s = m[i].toString();
n[i] = StripQualifiers.strip(s);
}
for(int i = 0; i < ctor.length; i++) {
String s = ctor[i].toString();
n[i + m.length] =
StripQualifiers.strip(s);
}
if(args.length == 1)
for (int i = 0; i < n.length; i++)
System.out.println(n[i]);
else
for (int i = 0; i < n.length; i++)
if(n[i].indexOf(args[1])!= -1)
System.out.println(n[i]);
} catch (ClassNotFoundException e) {
System.out.println("No such class: " + e);
}
}
}
class StripQualifiers {
private StreamTokenizer st;
public StripQualifiers(String qualified) {
st = new StreamTokenizer(
new StringReader(qualified));
st.ordinaryChar(' '); // Keep the spaces
}
public String getNext() {
String s = null;
try {
if(st.nextToken() !=
StreamTokenizer.TT_EOF) {
switch(st.ttype) {
case StreamTokenizer.TT_EOL:
s = null;
break;
case StreamTokenizer.TT_NUMBER:
s = Double.toString(st.nval);
break;
case StreamTokenizer.TT_WORD:
s = new String(st.sval);
break;
default: // single character in ttype
s = String.valueOf((char)st.ttype);
}
}
} catch(IOException e) {
System.out.println(e);
}
return s;
}
public static String strip(String qualified) {
StripQualifiers sq =
new StripQualifiers(qualified);
String s = "", si;
while((si = sq.getNext()) != null) {
int lastDot = si.lastIndexOf('.');
if(lastDot != -1)
si = si.substring(lastDot + 1);
s += si;
}
return s;
}
} ///:~
ShowMethodsClean方法非常接近前一個ShowMethods,只是它取得了Method和Constructor數組,並將它們轉換成單個String數組。隨後,每個這樣的String對象都在StripQualifiers.Strip()裡“過”一遍,刪除所有方法限定詞。正如大家看到的那樣,此時用到了StreamTokenizer和String來完成這個工作。
假如記不得一個類是否有一個特定的方法,而且不想在聯機文檔裡逐步檢查類結構,或者不知道那個類是否能對某個對象(如Color對象)做某件事情,該工具便可節省大量編程時間。
第17章提供了這個程序的一個GUI版本,可在自己寫代碼的時候運行它,以便快速查找需要的東西。