Java反射机制

JAVA反射机制是在运行状态中，对于任意一个类，都能够知道这个类的所有属性和方法；对于任意一个对象，都能够调用它的任意一个方法和属性；这种动态获取的信息以及动态调用对象的方法的功能称为Java语言的反射机制。

JavaBean 是 reflection 的实际应用之一，它能让一些工具可视化的操作软件组件。这些工具通过 reflection 动态的载入并取得 Java 组件(类) 的属性。

1.我们先来看一个简单的例子：

考虑下面这个简单的例子，让我们看看 reflection 是如何工作的。

1
2
3
4
5
6
7
8
9
10
11
12
13
import java.lang.reflect.Method;

public class DumpMethods {
    public static void main(String[] args) throws Exception{
        Class<?> ClassType = Class.forName("java.lang.String");
       
        Method[] methods = ClassType.getDeclaredMethods();
       
        for(Method method : methods){
            System.out.println(method);
        }
    }
}

输出结果为：

1
2
3
4
5
6
7
8
9
10
11
12
13
public int java.lang.String.hashCode()
public int java.lang.String.compareTo(java.lang.Object)
public int java.lang.String.compareTo(java.lang.String)
public int java.lang.String.indexOf(java.lang.String,int)
static int java.lang.String.indexOf(char[],int,int,char[],int,int,int)
public int java.lang.String.indexOf(java.lang.String)
public int java.lang.String.indexOf(int)
public int java.lang.String.indexOf(int,int)
public boolean java.lang.String.equals(java.lang.Object)
public java.lang.String java.lang.String.toString()
public char java.lang.String.charAt(int)
private static void java.lang.String.checkBounds(byte[],int,int)
.........

这样就列出了java.lang.String 类的各方法名以及它们的限制符和返回类型。

这个程序使用 Class.forName 载入指定的类，然后调用 getDeclaredMethods 来获取这个类中定义了的方法列表。java.lang.reflect.Methods 是用来描述某个类中单个方法的一个类。

2.开始使用 Reflection

用于 reflection 的类，如 Method，可以在 java.lang.relfect 包中找到。使用这些类的时候必须要遵循三个步骤：第一步是获得你想操作的类的 java.lang.Class 对象。在运行中的 Java 程序中，用 java.lang.Class 类来描述类和接口等。

下面就是获得一个 Class 对象的方法之一：

Class c = Class.forName(“java.lang.String”);

这条语句得到一个 String 类的类对象。还有另一种方法，如下面的语句：

Class c = int.class; 或者 Class c = Integer.TYPE;

它们可获得基本类型的类信息。其中后一种方法中访问的是基本类型的封装类 (如 Integer) 中预先定义好的 TYPE 字段。

或者类名.getClass();

第二步是调用诸如 getDeclaredMethods 的方法，以取得该类中定义的所有方法的列表。

一旦取得这个信息，就可以进行第三步了——使用 reflection API 来操作这些信息，如下面这段代码：

Class c = Class.forName(“java.lang.String”);

Method m[] = c.getDeclaredMethods();

System.out.println(m[0].toString());

3.得到类的方法相关信息

找出一个类中定义了些什么方法，这是一个非常有价值也非常基础的 reflection 用法。下面的代码就实现了这一用法：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
import java.lang.reflect.Method;

public class Method1 {
    private int fution(Object obj, int num) throws NullPointerException {
        if (obj == null)
            throw new NullPointerException();
        return num;
    }

    public static void main(String args[]) {
        try {
            Class cls = Class.forName("Method1");
            Method methlist[] = cls.getDeclaredMethods();
            for (int i = 0; i < methlist.length; i++) {
                Method m = methlist[i];
                System.out.println("name = " + m.getName());
                System.out.println("decl class = " + m.getDeclaringClass());
                Class pvec[] = m.getParameterTypes();
                for (int j = 0; j < pvec.length; j++)
                    System.out.println("param #" + j + " " + pvec[j]);
                Class evec[] = m.getExceptionTypes();
                for (int j = 0; j < evec.length; j++)
                    System.out.println("exc #" + j + " " + evec[j]);
                System.out.println("return type = " + m.getReturnType());
                System.out.println("-----");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

这个程序首先取得 Method1 类的描述，然后调用 getDeclaredMethods 来获取一系列的 Method 对象，它们分别描述了定义在类中的每一个方法，包括 public 方法、protected 方法、package 方法和 private 方法等。如果你在程序中使用 getMethods 来代替 getDeclaredMethods，你还能获得继承来的各个方法的信息。

取得了 Method 对象列表之后，要显示这些方法的参数类型、异常类型和返回值类型等就不难了。这些类型是基本类型还是类类型，都可以由描述类的对象按顺序给出。

输出的结果如下：

1
2
3
4
5
6
7
8
9
10
11
12
name = fution
decl class = class Method1
param #0 class java.lang.Object
param #1 int
exc #0 class java.lang.NullPointerException
return type = int
-----
name = main
decl class = class Method1
param #0 class [Ljava.lang.String;
return type = void
-----

4.获取构造器信息

获取类构造器的用法与上述获取方法的用法类似，如：

Class cls = Class.forName(“Constructor1”);

Constructor ctorlist[] = cls.getDeclaredConstructors();

然后就可以取到和构造器相关的信息了。
对于构造器，则不能像执行方法那样进行，因为执行一个构造器就意味着创建了一个新的对象 (准确的说，创建一个对象的过程包括分配内存和构造对象)。所以，与上例最相似的例子如下：

1
2
　　　Class<?> ClassType = object.getClass();
　　　Object objectCopy = ClassType.getConstructor(new Class[]{}).newInstance(new Object[]{});

上面是不带参数的构造方法生成对象方式，带参数的我们可以动态的传入参数。

1
2
　　　Constructor cons = ClassType.getConstructor(new Class[]{String.class,int.class});     
　　　Object obj = cons.newInstance(new Object[]{"hello",3});

根据指定的参数类型找到相应的构造函数并执行它，以创建一个新的对象实例。使用这种方法可以在程序运行时动态地创建对象，而不是在编译的时候创建对象，这一点非常有价值。
5.获取类的字段(域)

找出一个类中定义了哪些数据字段也是可能的，下面的代码就在干这个事情：

Class cls = Class.forName(“Field1”);

Field fieldlist[] = cls.getDeclaredFields();

获取字段的时候也可以只取得在当前类中申明了的字段信息 (getDeclaredFields)，或者也可以取得父类中定义的字段 (getFields) 。
若要访问peivate属性，要调用field.setAccessible(true);压制java的访问控制检查。

6.根据方法的名称来执行方法

文本到这里，所举的例子无一例外都与如何获取类的信息有关。我们也可以用 reflection 来做一些其它的事情，比如执行一个指定了名称的方法。下面的示例演示了这一操作：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
import java.lang.reflect.Method;

public class Method2 {
       public int add(int a, int b) {
          return a + b;
       }
       public static void main(String args[]) {
          try {
               Class cls = Class.forName("Method2");
               Class partypes[] = new Class[2];
               partypes[0] = Integer.TYPE;
               partypes[1] = Integer.TYPE;
           
               Method meth = cls.getMethod("add", partypes);
               Method2 methobj = new Method2();
               Object arglist[] = new Object[2];
               arglist[0] = new Integer(37);
               arglist[1] = new Integer(47);
               Object retobj = meth.invoke(methobj, arglist);
               Integer retval = (Integer) retobj;
               System.out.println(retval.intValue());
          }
          catch (Exception e) {
               e.printStackTrace();
          }
       }
    }

假如一个程序在执行的某处的时候才知道需要执行某个方法，这个方法的名称是在程序的运行过程中指定的 (例如，JavaBean 开发环境中就会做这样的事)，那么上面的程序演示了如何做到。

上例中，getMethod用于查找一个具有两个整型参数且名为 add 的方法。找到该方法并创建了相应的Method 对象之后，在正确的对象实例中执行它。执行该方法的时候，需要提供一个参数列表，这在上例中是分别包装了整数 37 和 47 的两个 Integer 对象。执行方法的返回的同样是一个 Integer 对象，它封装了返回值 84。
若要访问peivate方法，要调用method.setAccessible(true);压制java的访问控制检查。

7.改变字段(域)的值

reflection 的还有一个用处就是改变对象数据字段的值。reflection 可以从正在运行的程序中根据名称找到对象的字段并改变它，下面的例子可以说明这一点：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
public class Field2 {
   public double d;  
   public static void main(String args[]) {
      try {
           Class cls = Class.forName("Field2");
           Field fld = cls.getField("d");
           Field2 f2 = new Field2();
           System.out.println("d = " + f2.d);
           fld.setDouble(f2, 12.34);
           System.out.println("d = " + f2.d);
      }
      catch (Throwable e) {
           System.err.println(e);
      }
   }
}

这个例子中，字段 d 的值被变为了 12.34。

8.使用数组

本文介绍的 reflection 的最后一种用法是创建的操作数组。数组在 Java 语言中是一种特殊的类类型，一个数组的引用可以赋给 Object 引用。观察下面的例子看看数组是怎么工作的：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import java.lang.reflect.Array;

public class ArrayTester1 {
    public static void main(String[] args) throws Exception{
        Class<?> ClassType = Class.forName("java.lang.String");
       
        Object array = Array.newInstance(ClassType, 10);
       
        Array.set(array, 5, "hello");
       
        String str = (String)Array.get(array, 5);
       
        System.out.println(str);
    }
}

例中创建了 10 个单位长度的 String 数组，为第 5 个位置的字符串赋了值，最后将这个字符串从数组中取得并打印了出来。

下面这段代码提供了一个更复杂的例子：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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<?> ClassType = arrayObj.getClass().getComponentType();
//     
//      System.out.println(ClassType);
       
        arrayObj = Array.get(arrayObj, 5);
       
        Array.setInt(arrayObj, 10, 37);
       
        int[][][] arrayCast = (int[][][])array;
       
        System.out.println(arrayCast[3][5][10]);
    }
}

例中创建了一个 5 x 10 x 15 的整型数组，并为处于 [3][5][10] 的元素赋了值为 37。注意，多维数组实际上就是数组的数组，例如，第一个 Array.get 之后，arrobj 是一个 10 x 15 的数组。进而取得其中的一个元素，即长度为 15 的数组，并使用 Array.setInt 为它的第 10 个元素赋值。

注意创建数组时的类型是动态的，在编译时并不知道其类型。

 

除非注明，饮水思源博客文章均为原创，转载请以链接形式标明本文地址

本文地址：http://www.alonemonkey.com/java-reflect.html

本文链接：http://www.alonemonkey.com/java-reflect.html