Java的反射机制学习笔记

     在Java运行时环境中，对于任意一个类，能否知道这个类有哪些属性和方法？对于任意一个对象，能否调用它的任意一个方法？答案是肯定的。

这种动态获取类的信息以及动态调用对象的方法的功能来自于Java语言的反射(Reflection)机制。

 

Java反射机制主要提供了以下功能

 

(1)在运行时判断任意一个对象所属的类

(2)在运行时构造任意一个类的对象

(3)在运行时判断任意一个类所具有的成员变量和方法

(4)在运行时调用任意一个对象的方法

 

      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。换句话说，获悉完整构造(但不包括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类：提供了动态创建数组，以及访问数组的元素的静态方法

 

eg.例程DumpMethods类演示了Reflection API的基本作用，它读取命令行参数指定的类名，然后打印这个类所具有的方法信息
-------------------------------------------------------------------------------------------------
package com.langsin.reflection;

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类型的getter和setter方法。
-------------------------------------------------------------------------------------------------
package com.langsin.reflection;

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();
   //获得和属性对应的getter方法的名字
   String getMethodName = "get" + firstLetter + fieldName.substring(1);
   //获得和属性对应的setter方法的名字
   String setMethodName = "set" + firstLetter + fieldName.substring(1);
   
   //获得和属性对应的getter方法
   Method getMethod = classType.getMethod(getMethodName, new Class[]{});
   //获得和属性对应的setter方法
   Method setMethod = classType.getMethod(setMethodName, new Class[]{field.getType()});
   
   //调用原对象的getter方法
   Object value = getMethod.invoke(object, new Object[]{});
   System.out.println(fieldName + ":" + value);
   //调用拷贝对象的setter方法
   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;
 }
}
-------------------------------------------------------------------------------------------------
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(Calss[] 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)获得每个属性相应的getter和setter方法，然后执行这行方法，把原来对象的属性拷贝到新的对象中

 

在例程InvokeTest类的main()方法中，运用反射机制调用一个InvokeTester对象的add()和echo()方法

-------------------------------------------------------------------------------------------------------------------
package com.langsin.reflection;

import java.lang.reflect.Method;

public class InvokeTester
{
 public int add(int param1, int param2)
 {
  return param1 + param2;
 }
 
 public String echo(String msg)
 {
  return "eho: " + msg;
 }
 
// public InvokeTester(String str)
// {
//  
// }
 
 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);
 }
}
-------------------------------------------------------------------------------------------------------------------

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类型，调用addMethod对象的invoke()方法时，只能传递Integer类型的参数，并且invoke()方法的返回类型也是Integer类型，Integer类是int基本类型的包装类：

Object result = addMethod.invoke(invokeTester,new Object[]{new Integer(100),new Integer(200)});

System.out.println((Integer)result); //result为Integer类型

java.lang.Array类提供了动态创建和访问数组元素的各种静态方法。

 

例程

ArrayTest1类的main()方法创建了一个长度为10的字符串数组，接着把索引位置为5的元素设为"hello"，然后再读取索引位置为5的元素的值
--------------------------------------------------------------------------------------------------------------------
package com.langsin.reflection;

import java.lang.reflect.Array;

public class ArrayTest1
{
 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×10×15的整形数组，并把索引位置为[3][5][10]的元素的值设为37

---------------------------------------------------------------------------------------------
package com.langsin.reflection;

import java.lang.reflect.Array;

public class ArrayTester2
{
 public static void main(String[] args)
 {
  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" class

 

众所周知Java有个Object class，是所有Java classes的继承根源，其内声明了数个应该在所有Java class中被改写的methods：hasCode()、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 constructorClass是Reflection起源。针对任何您想探勘的class，唯有先为它产生一个Class object，接下来才能经由后者唤起为数十多个的Reflection APIs"Class" object的取得途径

Java允许我们从多种途径为一个class生成对应的Class object运用getClass() 注：每个class都有此函数

eg.
String str = "abc";
Class cl = str.getClass();

运用Class.getSuperclass()

eg.
Button b = new Button();
Class c1 = b.getClass();
Class c2 = c1.getSuperclass();

运用static method Class.forName (最常被使用)

eg.
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语法

eg.
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语法

eg.
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

 

运行时生成instances欲生成对象实体，在Reflection动态机制中有两种作法，一个针对"无字变量construtor"，一个针对"带参数constructor"。如果欲调用的是"带参数constructor"就比较麻烦些，不再调用Class的newInstance()，而是调用Cponstructor的newInstance()。首先准备一个Class[]作为constructor的参数类型(本例指定为一个double和一个int)，然后以此为自变量调用getConstructor()，获得一个专属constructor。接下来再准备一个Object[]作为constructor实参值(本例指定3.14159和125)，调用上述专属constructor的newInstance()。

 

eg1.
Class c = Class.forName("DynTest");
Object obj = null;
obj = c.newInstance(); //不带自变量
System.out.println(obj);

动态生成"Class object所对应之class"的对象实体；无自变量。

 

eg2.
Class c = Class.forName("DynTest");
Class[] pTypes = new Class[]{double.class,int.class};
Constructor ctor = c.getConstructor(pTypes); //指定parameter list，便可获得特定之tor

Object obj = null;
Object[] arg = new Object[]{3.14159,125};
System.out.println(obj);

动态生成"Class object对应之class"的对象实体；自变量以object[]表示。

运行时调用methods

这个动作和上述调用"带参数之constructor"相当类似。首先准备一个Class[]作为参数类型(本例指定其中一个是String，另一个是Hashtable)，然后以此为自变量调用getMethod()，获得特定的Method object。接下来准备一个Object[]放置自变量，然后调用上述所得之特定Method object的invoke()。
为什么获得Method object时不需指定返回类型？

public String func(String s, Hashtable ht)
{
 ........
 System.out.println("func invoked");
 return s;
}
public static void main(String args[])
{
 Class c = Class.forName("Test");
 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);
 Test obj = new Test();
 Object args[] = new Object[2];
 arg[0] = new String("Hello,world");
 arg[1] = null;
 Object r = m.invoke(obj,arg);
 Integer rval = (String)r;
 System.out.println(rval);
}

运行时变更fields内容与先前连个动作相比，"变更field内容"轻松多了，因为它不需要参数和自变量。首先调用Class的getField()并指定field名称。获得特定的Field object之后便可直接调用Field的get()和set()。

 

public class Test
{
 public double d;
 public static void main(String args[])
 {
  Class c = Class.forName("Test");
  Field f = c.getField("d"); //指定field名称
  Test obj = new Test();
  System.out.println("d= " + (Double)f.get(obj));
  f.set(obj,12.34);
  System.out.println("d= " + obj.d);
 }
}