java反射机制

======================================================
注：本文源代码点此下载
======================================================

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 implements java.io.serializable,

#003 java.lang.reflect.genericdeclaration,

#004 java.lang.reflect.type,

#005 java.lang.reflect.annotatedelement {

#006private class() {}

#007public string tostring() {

#008return ( 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//(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;

}

图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 []

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

#008system.out.println("package "+p.getname()+";");

执行结果(例):

package java.util;

图5-1:找出class 隶属的package。其中的c将继续沿用于以下各程序片段。

#001 ff = c.getdeclaredfields();

#002 for (int i = 0; i [] tv;

#002 tv = c.gettypeparameters(); //warning: unchecked conversion

#003 for (int i = 0; i ");

#011 }

执行结果(例):

public abstract interface map

或 public class linkedlist

图5-4:找出parameterized types 的名称

#001 class supclass;

#002 supclass = c.getsuperclass();

#003 if (supclass != null) //如果有super class

#004system.out.print(" extends" +

#005 tname(supclass.getname(),classref));

执行结果(例):

public class linkedlist

extends abstractsequentiallist,

图5-5:找出base class。执行结果多出一个不该有的逗号于尾端。此非本处重点,为简化计,不多做处理。

#001 class cc[];

#002 class ctmp;

#003 //找出所有被实现的interfaces

#004 cc = c.getinterfaces();

#005 if (cc.length != 0)

#006system.out.print(", \r\n" + " implements "); //关键词

#007 for (class cite : cc) //jdk1.5 新式循环写法

#008system.out.print(tname(cite.getname(), null)+", ");

执行结果(例):

public class linkedlist

extends abstractsequentiallist,

implements list, queue, cloneable, serializable,

图5-6:找出implemented interfaces。执行结果多出一个不该有的逗号于尾端。此非本处重点,为简化计,不多做处理。

#001 cc = c.getdeclaredclasses(); //找出inner classes

#002 for (class cite : cc)

#003system.out.println(tname(cite.getname(), null));

#004

#005 ctmp = c.getdeclaringclass(); //找出outer classes

#006 if (ctmp != null)

#007system.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 )

public java.util.linkedlist()

图5-8b:找出所有constructors。本例在for 循环内使用togenericstring(),省事。

#001 method mm[];

#002 mm = c.getdeclaredmethods();

#003 for (int i = 0; i??

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 //执行测试程序

本文来自csdn博客,转载请标明出处:http://blog.youkuaiyun.com/njchenyi/archive/2007/05/22/1620939.aspx

======================================================
在最后，我邀请大家参加新浪APP，就是新浪免费送大家的一个空间，支持PHP+MySql，免费二级域名，免费域名绑定 这个是我邀请的地址，您通过这个链接注册即为我的好友，并获赠云豆500个，价值5元哦！短网址是http://t.cn/SXOiLh我创建的小站每天访客已经达到2000+了，每天挂广告赚50+元哦，呵呵，饭钱不愁了，\(^o^)/