Java 语言的反射机制
在Java运行时环境中,对于任意一个类,可以知道这个类有哪些属性和方法。对于任意一个对象,可以调用它的任意一个方法。
这种动态获取类的信息以及动态调用对象的方法的功能来自于Java 语言的反射(Reflection)机制。
Java 反射机制主要提供了以下功能
在运行时判断任意一个对象所属的类。
在运行时构造任意一个类的对象。
在运行时判断任意一个类所具有的成员变量和方法。
在运行时调用任意一个对象的方法
Reflection 是Java被视为动态(或准动态)语言的一个关键性质。这个机制允许程序在运行时透过Reflection APIs取得任何一个已知名称的class的内部信息,包括其modifiers(诸如public, static 等等)、superclass(例如Object)、实现之interfaces(例如Serializable),也包括fields和methods的所有信息,并可于运行时改变fields内容或调用methods。
一般而言,开发者社群说到动态语言,大致认同的一个定义是:“程序运行时,允许改变程序结构或变量类型,这种语言称为动态语言”。从这个观点看,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 API 简介
在JDK中,主要由以下类来实现Java反射机制,这些类都位于java.lang.reflect包中
Class类:代表一个类。
Field 类:代表类的成员变量(成员变量也称为类的属性)。
Method类:代表类的方法。
Constructor 类:代表类的构造方法。
Array类:提供了动态创建数组,以及访问数组的元素的静态方法
例程DumpMethods类演示了Reflection API的基本作用,它读取命令行参数指定的类名,然后打印这个类所具有的方法信息:
清单1:DumpMethods.java
import java.lang.reflect.Method; public class DumpMethods { public static void main(String args[]) throws Exception { // 加载并初始化命令行参数指定的类 Class<?> classType = Class.forName(args[0]); // 获得类的所有方法 Method methods[] = classType.getDeclaredMethods(); for (int i = 0; i < methods.length; i++) { System.out.println(methods[i].toString()); } } }
例程ReflectTester 类进一步演示了Reflection API的基本使用方法。ReflectTester类有一个copy(Object object)方法,这个方法能够创建一个和参数object 同样类型的对象,然后把object对象中的所有属性拷贝到新建的对象中,并将它返回。这个例子只能复制简单的JavaBean,假定JavaBean 的每个属性都有public 类型的getXXX()和setXXX()方法。
清单2:ReflectTester.java
import java.lang.reflect.Field; import java.lang.reflect.Method; public class ReflectTester { public Object copy(Object object) throws Exception { // 获得对象的类型 Class<?> classType = object.getClass(); System.out.println("Class:" + classType.getName()); // 通过默认构造方法创建一个新的对象 Object objectCopy = classType.getConstructor(new Class[] {}).newInstance(new Object[] {}); // 获得对象的所有属性 Field fields[] = classType.getDeclaredFields(); for (int i = 0; i < fields.length; i++) { Field field = fields[i]; // 属性名称 String fieldName = field.getName(); // 得到属性名称的第一个字母并转成大小 String firstLetter = fieldName.substring(0, 1).toUpperCase(); // 获得和属性对应的getXXX()方法的名字:get+属性名称的第一个字母并转成大小+属性名去掉第一个字母, // 如属性名称为name,则:get+N+ame String getMethodName = "get" + firstLetter + fieldName.substring(1); // 获得和属性对应的setXXX()方法的名字 String setMethodName = "set" + firstLetter + fieldName.substring(1); // 获得和属性对应的getXXX()方法 Method getMethod = classType.getMethod(getMethodName, new Class[] {}); // 获得和属性对应的setXXX()方法,传入参数为参数的类型 Method setMethod = classType.getMethod(setMethodName, new Class[] { field.getType() }); // 调用原对象的getXXX()方法 Object value = getMethod.invoke(object, new Object[] {}); System.out.println(fieldName + ":" + value); // 调用拷贝对象的setXXX()方法 setMethod.invoke(objectCopy, new Object[] { value }); } return objectCopy; } public static void main(String[] args) throws Exception { Customer customer = new Customer("Tom", 21); customer.setId(new Long(1)); Customer customerCopy = (Customer) new ReflectTester().copy(customer); System.out.println("Copy information:" + customerCopy.getId() + " " + customerCopy.getName() + " " + customerCopy.getAge()); } } class Customer { private Long id; private String name; private int age; public Customer() { } public Customer(String name, int age) { this.name = name; this.age = age; } public Long getId() { return id; } public void setId(Long id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } }
输出结果为:
Class:com.coderdream.reflection.Customer id:1 name:Tom age:21 Copy information:1 Tom 21
ReflectTester 类的copy(Object object)方法依次执行以下步骤
(1)获得对象的类型:
Class classType=object.getClass();
System.out.println("Class:"+classType.getName());
在java.lang.Object 类中定义了getClass()方法,因此对于任意一个Java对象,都可以通过此方法获得对象的类型。Class类是Reflection API 中的核心类,它有以下方法
getName():获得类的完整名字。
getFields():获得类的public类型的属性。
getDeclaredFields():获得类的所有属性。
getMethods():获得类的public类型的方法。
getDeclaredMethods():获得类的所有方法。
getMethod(String name, Class[] parameterTypes):获得类的特定方法,name参数指定方法的名字,parameterTypes 参数指定方法的参数类型。
getConstructors():获得类的public类型的构造方法。
getConstructor(Class[] parameterTypes):获得类的特定构造方法,parameterTypes 参数指定构造方法的参数类型。
newInstance():通过类的不带参数的构造方法创建这个类的一个对象。
(2)通过默认构造方法创建一个新对象:
Object objectCopy=classType.getConstructor(new Class[]{}).newInstance(new Object[]{});
以上代码先调用Class类的getConstructor()方法获得一个Constructor 对象,它代表默认的构造方法,然后调用Constructor对象的newInstance()方法构造一个实例。
(3)获得对象的所有属性:
Field fields[]=classType.getDeclaredFields();
Class 类的getDeclaredFields()方法返回类的所有属性,包括public、protected、默认和private访问级别的属性
(4)获得每个属性相应的getXXX()和setXXX()方法,然后执行这些方法,把原来对象的属性拷贝到新的对象中。
在例程InvokeTester类的main()方法中,运用反射机制调用一个InvokeTester对象的add()和echo()方法
add()方法的两个参数为int 类型,获得表示add()方法的Method对象的代码如下:
Method addMethod=classType.getMethod("add",new Class[]{int.class,int.class});
Method类的invoke(Object obj,Object args[])方法接收的参数必须为对象,如果参数为基本类型数据,必须转换为相应的包装类型的对象。invoke()方法的返回值总是对象,如果实际被调用的方法的返回类型是基本类型数据,那么invoke()方法会把它转换为相应的包装类型的对象,再将其返回
在本例中,尽管InvokeTester 类的add()方法的两个参数以及返回值都是int类型,调用add Method 对象的invoke()方法时,只能传递Integer 类型的参数,并且invoke()方法的返回类型也是Integer 类型,Integer 类是int 基本类型的包装类:
Object result=addMethod.invoke(invokeTester,
new Object[]{new Integer(100),new Integer(200)});
清单3:InvokeTester.java
import java.lang.reflect.Method; public class InvokeTester { public int add(int param1, int param2) { return param1 + param2; } public String echo(String msg) { return "echo: " + msg; } public static void main(String[] args) throws Exception { Class<?> classType = InvokeTester.class; Object invokeTester = classType.newInstance(); // Object invokeTester = classType.getConstructor(new Class[]{}).newInstance(new Object[]{}); // 调用InvokeTester对象的add()方法 Method addMethod = classType.getMethod("add", new Class[] { int.class, int.class }); Object result = addMethod.invoke(invokeTester, new Object[] { new Integer(100), new Integer(200) }); System.out.println((Integer) result); // 调用InvokeTester对象的echo()方法 Method echoMethod = classType.getMethod("echo", new Class[] { String.class }); result = echoMethod.invoke(invokeTester, new Object[] { "Hello" }); System.out.println((String) result); } }
java.lang.Array 类提供了动态创建和访问数组元素的各种静态方法。例程 ArrayTester1 类的main()方法创建了一个长度为10 的字符串数组,接着把索引位置为5 的元素设为“hello”,然后再读取索引位置为5 的元素的值。
清单5:ArrayTester1.java
import java.lang.reflect.Array; public class ArrayTester1 { public static void main(String[] args) throws Exception { Class<?> classType = Class.forName("java.lang.String"); // 创建一个长度10的字符串数组 Object array = Array.newInstance(classType, 10); // 把索引位置为5的元素设为“hello” Array.set(array, 5, "hello"); // 获得索引位置为5的元素的值 String s = (String)Array.get(array, 5); System.out.println(s); } }
例程ArrayTester2 类的main()方法创建了一个 5 x 10 x 15 的整型数组,并把索引位置为[3][5][10] 的元素的值为设37。
清单6:ArrayTester2.java
import java.lang.reflect.Array; public class ArrayTester2 { public static void main(String[] args) throws Exception { // 创建一个三维数组 int[] dims = new int[] { 5, 10, 15 }; Object array = Array.newInstance(Integer.TYPE, dims); Object arrayObj = Array.get(array, 3); Class<?> cls = arrayObj.getClass().getComponentType(); System.out.println(cls); arrayObj = Array.get(arrayObj, 5); Array.setInt(arrayObj, 10, 37); int[][][] arrayCast = (int[][][])array; System.out.println(arrayCast[3][5][10]); } }
Class类
众所周知Java有个Object 类,是所有Java 类的继承根源,其内声明了数个应该在所有Java 类中被改写的方法(methods):hashCode()、equals()、clone()、toString()、getClass()等,其中getClass()返回一个Class 类的对象。
Class 类十分特殊。它和一般Java类一样继承自Object,其实体用以表达Java程序运行时的类(classes)和接口(interfaces),也用来表达枚举(enum)、数组(array)、primitive Java types(boolean, byte, char, short, int, long, float, double)以及关键词void。当一个类被加载,或当类加载器(class loader)的defineClass()被JVM调用,JVM 便自动产生一个Class 对象(object)。如果您想借由“修改Java标准库源码”来观察Class object的实际生成时机(例如在Class的constructor内添加一个println()),不能够!因为Class并没有公共构造函数(public constructor)。
Class类是反射(Reflection)的起源。针对任何您想探勘的类(class),唯有先为它产生一个Class对象(object),接下来才能经由后者唤起为数十多个的Reflection APIs。
“Class” 对象(object)的取得途径
Java允许我们从多种途径为一个class生成对应的Class object:
清单7:GetClassDemo.java
import java.awt.Button; public class GetClassDemo { public static void main(String[] args) throws Exception { GetClassDemo.f1(); GetClassDemo.f2(); GetClassDemo.f3(); GetClassDemo.f4(); } /** * 通过getClass()和getSuperclass()方法 */ public static void f1() { Button b = new Button(); Class<?> c1 = b.getClass(); System.out.println(c1); Class<?> c2 = c1.getSuperclass(); System.out.println(c2); Class<?> c3 = c2.getSuperclass(); System.out.println(c3); Class<?> c4 = c3.getSuperclass(); System.out.println(c4); System.out.println("------------------------------------------------"); } /** * 通过Class.forName()方法 * @throws Exception */ public static void f2() throws Exception { Class<?> c1 = Class.forName("java.lang.String"); System.out.println(c1); Class<?> c2 = Class.forName("java.awt.Button"); System.out.println(c2); Class<?> c3 = Class.forName("java.util.LinkedList$Entry"); System.out.println(c3); // 报空指针异常 // Class<?> c4 = Class.forName("I"); // System.out.println(c4); Class<?> c5 = Class.forName("[I"); System.out.println(c5); System.out.println("------------------------------------------------"); } /** * 通过 .class 属性 * @throws Exception */ public static void f3() throws Exception { Class<?> c1 = String.class; System.out.println(c1); Class<?> c2 = java.awt.Button.class; System.out.println(c2); Class<?> c3 = int.class; System.out.println(c3); Class<?> c4 = int[].class; System.out.println(c4); System.out.println("------------------------------------------------"); } /** * 通过 .TYPE 属性 * @throws Exception */ public static void f4() throws Exception { Class<?> c1 = Boolean.TYPE; System.out.println(c1); Class<?> c2 = Byte.TYPE; System.out.println(c2); Class<?> c3 = Character.TYPE; System.out.println(c3); Class<?> c4 = Short.TYPE; System.out.println(c4); Class<?> c5 = Integer.TYPE; System.out.println(c5); Class<?> c6 = Long.TYPE; System.out.println(c6); Class<?> c7 = Float.TYPE; System.out.println(c7); Class<?> c8 = Double.TYPE; System.out.println(c8); Class<?> c9 = Void.TYPE; System.out.println(c9); } }
输出结果:
class java.awt.Button class java.awt.Component class java.lang.Object null ------------------------------------------------ class java.lang.String class java.awt.Button class java.util.LinkedList$Entry class [I ------------------------------------------------ class java.lang.String class java.awt.Button int class [I ------------------------------------------------ boolean byte char short int long float double void
运行时生成对象实例(instances)
欲生成对象实体,在Reflection 动态机制中有两种作法,一个针对“无参数的构造函数”,一个针对“带参数构造函数”。
情况1:类存在不带参数的构造函数
直接使用newInstance()方法
情况2:类不存在不带参数的构造函数
先生成Constructor对象,传入参数类型数组,然后调用此对象的newInstance()方法,同时传入实际参数。
首先准备一个Class[]做为构造函数的参数类型(本例指定为一个double和一个int),然后以此为自变量调用getConstructor(),获得一个专属构造函数对象(Constructor ),接下来再准备一个Object[] 做为构造函数的实参值(本例指定3.14159和125),调用上述专属构造函数对象的newInstance()。
清单8:NewInstance.java
import java.lang.reflect.Constructor; public class NewInstance { double d; int i; public NewInstance(double d, int i) { super(); this.d = d; this.i = i; } public static void main(String[] args) throws Exception { // 通过传入参数完整类名得到Class对象 Class<?> c = Class.forName("com.coderdream.reflection.NewInstance"); // 构造类型对象数组 Class<?>[] pTypes = new Class[]{double.class,int.class}; // 传入参数,得到Constructor对象 Constructor<?> ctor = c.getConstructor(pTypes); // 构造实际参数数组 Object[] arg = new Object[] {3.14159, 125}; // 得到对象实例 Object obj = ctor.newInstance(arg); System.out.println(obj.getClass()); } }
输出结果:
class com.coderdream.reflection.NewInstance
运行时调用方法(methods)
这个动作和上述调用“带参数之构造函数”相当类似。首先准备一个Class[]做为参数类型(本例指定其中一个是String,另一个是Hashtable),然后以此为自变量调用getMethod(),获得特定的Method object。接下来准备一个Object[]放置自变量,然后调用上述所得之特定Method object的invoke()。
为什么获得Method object时不需指定回返类型?
因为方法重载(method overloading)机制要求signature必须唯一,而回返类型并非signature的一个成份。换句话说,只要指定了method名称和参数列,就一定指出了一个独一无二的方法(method)。
运行时变更属性(fields)内容
与先前两个动作相比,“变更属性(field)内容”轻松多了,因为它不需要参数和自变量。首先调用Class的getField()并指定field名称。获得特定的Field object之后便可直接调用Field的get()和set(),
清单9:RuntimeInvoke.java
import java.lang.reflect.Field; import java.lang.reflect.Method; import java.util.Hashtable; public class RuntimeInvoke { public double d; public String func(String s, Hashtable<?, ?> ht) { System.out.println("func invoked"); return s; } /** * 通过反射得到方法 * @throws Exception */ public static void f1() throws Exception { Class<?> c = Class.forName("com.coderdream.reflection.RuntimeInvoke"); Class<?>[] ptypes = new Class[2]; ptypes[0] = Class.forName("java.lang.String"); ptypes[1] = Class.forName("java.util.Hashtable"); Method m = c.getMethod("func", ptypes); RuntimeInvoke obj = new RuntimeInvoke(); Object[] arg = new Object[2]; arg[0] = new String("Hello, world"); arg[1] = null; Object r = m.invoke(obj, arg); String rval = (String) r; System.out.println(rval); System.out.println("------------------------------------------------"); } /** * 通过反射得到属性 * @throws Exception */ public static void f2() throws Exception { Class<?> c = Class.forName("com.coderdream.reflection.RuntimeInvoke"); Field f = c.getField("d"); RuntimeInvoke obj = new RuntimeInvoke(); System.out.println("d= " + (Double) f.get(obj)); f.set(obj, 12.34); System.out.println("d= " + obj.d); } /** * @param args * @throws Exception */ public static void main(String[] args) throws Exception { RuntimeInvoke.f1(); RuntimeInvoke.f2(); } }
输出结果:
func invoked Hello, world ------------------------------------------------ d= 0.0 d= 12.34
== 比较内存地址
equals 比较内容
从Object层次来说,==与equals是相同的,都是比较内存地址,也就是说,都是比较两个引用是否指向同一个对象,是则返回true,否则返回false。
很多类都重写(overwrite)了equals方法,最典型的是String类。