java反射机制

Reflection是Java 程序开发语言的特征之一，它允许运行中的 Java 程序对自身进行检查，或者说"自审"，并能直接操作程序的内部属性。例如，使用它能获得 Java 类中各成员的名称并显示出来。 Java 的这一能力在实际应用中也许用得不是很多，但是在其它的程序设计语言中根本就不存在这一特性。例如，Pascal、C 或者 C++ 中就没有办法在程序中获得函数定义相关的信息。

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

1. 一个简单的例子

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

1. import java.lang.reflect.*; 
3. public class DumpMethods { 
4.    public static void main(String args[]) { 
5.       try { 
6.            Class c = Class.forName("java.util.Stack"); 
8.            Method m[] = c.getDeclaredMethods(); 
9.             
10.            for (int i = 0; i < m.length; i++) 
11.                System.out.println(m[i].toString()); 
12.       } 
13.       catch (Throwable e){ 
14.             System.err.println(e); 
15.       } 
16.    } 
17. }

它的结果输出为：

1. public synchronized java.lang.Object java.util.Stack.pop()
2. public java.lang.Object java.util.Stack.push(java.lang.Object)
3. public boolean java.util.Stack.empty()
4. public synchronized java.lang.Object java.util.Stack.peek()
5. public synchronized int java.util.Stack.search(java.lang.Object)

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

这个程序使用 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 字段。

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

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

1. Class c = Class.forName("java.lang.String"); 
3. Method m[] = c.getDeclaredMethods(); 
5. System.out.println(m[0].toString()); 

它将以文本方式打印出 String 中定义的第一个方法的原型。

在下面的例子中，这三个步骤将为使用 reflection 处理特殊应用程序提供例证。

模拟 instanceof 操作符

得到类信息之后，通常下一个步骤就是解决关于 Class 对象的一些基本的问题。例如，Class.isInstance 方法可以用于模拟 instanceof 操作符：

1. class S { 
2. }  
4. public class IsInstance { 
5.    public static void main(String args[]) { 
6.       try { 
7.            Class cls = Class.forName("S"); 
8.            boolean b1 = cls.isInstance(new Integer(37)); 
9.            System.out.println(b1); 
10.            boolean b2 = cls.isInstance(new S()); 
11.            System.out.println(b2); 
12.       } 
13.       catch (Throwable e) { 
14.            System.err.println(e); 
15.       } 
16.    } 
17. }

在这个例子中创建了一个S 类的 Class 对象，然后检查一些对象是否是S的实例。Integer(37) 不是，但 new S()是。

3.找出类的方法

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

1. import java.lang.reflect.*;  
3. public class Method1 { 
4.    private int f1(Object p, int x) throws NullPointerException { 
6.    if (p == null) 
7.       throw new NullPointerException(); 
8.    return x; 
9. }  
11.    public static void main(String args[]) { 
12.        try { 
13.            Class cls = Class.forName("Method1"); 
14.            Method methlist[] = cls.getDeclaredMethods(); 
16.            for (int i = 0; i < methlist.length; i++) { 
17.                Method m = methlist[i]; 
18.                System.out.println("name = " + m.getName()); 
19.                System.out.println("decl class = " + m.getDeclaringClass()); 
20.                Class pvec[] = m.getParameterTypes(); 
22.                for (int j = 0; j < pvec.length; j++) 
23.                    System.out.println("param #" + j + " " + pvec[j]); 
25.                Class evec[] = m.getExceptionTypes(); 
27.                for (int j = 0; j < evec.length; j++) 
28.                    System.out.println("exc #" + j + " " + evec[j]); 
30.                System.out.println("return type = " + m.getReturnType()); 
31.                System.out.println("-----"); 
32.            } 
33.        } 
34.        catch (Throwable e) { 
35.            System.err.println(e); 
36.        } 
37.    } 
38. }  

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

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

输出的结果如下：

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

4.获取构造器信息

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

1. import java.lang.reflect.*;
3. public class Constructor1 { 
4.    public Constructor1() { 
5.    }  
7.    protected Constructor1(int i, double d) { 
8.    }  
10.    public static void main(String args[]) { 
11.       try { 
12.            Class cls = Class.forName("Constructor1"); 
13.            Constructor ctorlist[] = cls.getDeclaredConstructors(); 
15.            for (int i = 0; i < ctorlist.length; i++) { 
16.               Constructor ct = ctorlist[i]; 
17.               System.out.println("name = " + ct.getName()); 
18.               System.out.println("decl class = " + ct.getDeclaringClass()); 
19.               Class pvec[] = ct.getParameterTypes(); 
21.               for (int j = 0; j < pvec.length; j++) 
22.                  System.out.println("param #" + j + " " + pvec[j]); 
24.               Class evec[] = ct.getExceptionTypes(); 
26.               for (int j = 0; j < evec.length; j++) 
27.                  System.out.println("exc #" + j + " " + evec[j]); 
29.               System.out.println("-----"); 
30.            } 
31.       } 
32.       catch (Throwable e) { 
33.            System.err.println(e); 
34.       } 
35.    } 
36. } 

这个例子中没能获得返回类型的相关信息，那是因为构造器没有返回类型。

这个程序运行的结果是：

1. name = Constructor1
2. decl class = class Constructor1
3. param #0 int
4. param #1 double
5. -----
6. name = Constructor1
7. decl class = class Constructor1
8. -----

5.获取类的字段(域)

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

1. import java.lang.reflect.*;  
3. public class Field1 { 
4.    private double d; 
5.    public static final int i = 37; 
6.    String s = "testing";  
8.    public static void main(String args[]) { 
9.       try { 
10.            Class cls = Class.forName("Field1"); 
11.            Field fieldlist[] = cls.getDeclaredFields(); 
13.            for (int i = 0; i < fieldlist.length; i++) { 
14.               Field fld = fieldlist[i]; 
15.               System.out.println("name = " + fld.getName()); 
16.               System.out.println("decl class = " + fld.getDeclaringClass()); 
17.               System.out.println("type = " + fld.getType()); 
18.               int mod = fld.getModifiers(); 
19.               System.out.println("modifiers = " + Modifier.toString(mod)); 
20.               System.out.println("-----"); 
21.            } 
22.       } 
23.       catch (Throwable e) { 
24.            System.err.println(e); 
25.       } 
26.    } 
27. }  

这个例子和前面那个例子非常相似。例中使用了一个新东西 Modifier，它也是一个 reflection 类，用来描述字段成员的修饰语，如“private int”。这些修饰语自身由整数描述，而且使用 Modifier.toString 来返回以“官方”顺序排列的字符串描述 (如“static”在“final”之前)。这个程序的输出是：

1. name = d
2. decl class = class Field1
3. type = double
4. modifiers = private
5. -----
6. name = i
7. decl class = class Field1
8. type = int
9. modifiers = public static final
10. -----
11. name = s
12. decl class = class Field1
13. type = class java.lang.String
14. modifiers = 
15. -----

和获取方法的情况一下，获取字段的时候也可以只取得在当前类中申明了的字段信息 (getDeclaredFields)，或者也可以取得父类中定义的字段 (getFields) 。

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

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

1. import java.lang.reflect.*; 
3. public class Method2 { 
4.    public int add(int a, int b) { 
5.       return a + b; 
6.    } 
8.    public static void main(String args[]) { 
9.       try { 
10.            Class cls = Class.forName("Method2"); 
12.            Class partypes[] = new Class[2]; 
13.            partypes[0] = Integer.TYPE; 
14.            partypes[1] = Integer.TYPE; 
15.        
16.            Method meth = cls.getMethod("add", partypes); 
18.            Method2 methobj = new Method2(); 
19.            Object arglist[] = new Object[2]; 
20.            arglist[0] = new Integer(37); 
21.            arglist[1] = new Integer(47); 
23.            Object retobj = meth.invoke(methobj, arglist); 
24.            Integer retval = (Integer) retobj; 
25.            System.out.println(retval.intValue()); 
26.       } 
27.       catch (Throwable e) { 
28.            System.err.println(e); 
29.       } 
30.    } 
31. }

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

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

7.创建新的对象

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

1. import java.lang.reflect.*;  
3. public class Constructor2 { 
4.    public Constructor2() { 
5.    }  
7.    public Constructor2(int a, int b) { 
8.       System.out.println("a = " + a + " b = " + b); 
9.    }  
11.    public static void main(String args[]) { 
12.       try { 
13.            Class cls = Class.forName("Constructor2"); 
14.            Class partypes[] = new Class[2]; 
15.            partypes[0] = Integer.TYPE; 
16.            partypes[1] = Integer.TYPE; 
18.            Constructor ct = cls.getConstructor(partypes); 
19.            Object arglist[] = new Object[2]; 
20.            arglist[0] = new Integer(37); 
21.            arglist[1] = new Integer(47); 
22.            Object retobj = ct.newInstance(arglist); 
23.       } 
24.       catch (Throwable e) { 
25.            System.err.println(e); 
26.       } 
27.    } 
28. } 

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

8.改变字段(域)的值

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

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

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

9.使用数组

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

1. import java.lang.reflect.*;  
3. public class Array1 { 
4.    public static void main(String args[]) { 
5.       try { 
6.            Class cls = Class.forName("java.lang.String"); 
7.            Object arr = Array.newInstance(cls, 10); 
8.            Array.set(arr, 5, "this is a test"); 
9.            String s = (String) Array.get(arr, 5); 
10.            System.out.println(s); 
11.       } 
12.       catch (Throwable e) { 
13.            System.err.println(e); 
14.       } 
15.    } 
16. } 

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

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

1. import java.lang.reflect.*;  
3. public class Array2 { 
4.    public static void main(String args[]) { 
5.       int dims[] = new int[]{5, 10, 15}; 
6.       Object arr = Array.newInstance(Integer.TYPE, dims); 
7.       Object arrobj = Array.get(arr, 3); 
8.       Class cls = arrobj.getClass().getComponentType(); 
9.       System.out.println(cls); 
10.       arrobj = Array.get(arrobj, 5); 
11.       Array.setInt(arrobj, 10, 37); 
12.       int arrcast[][][] = (int[][][]) arr; 
13.       System.out.println(arrcast[3][5][10]); 
14.    } 
15. } 

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

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

有关反射的API ：

　　 java中有一个类很特殊，就是Class类，很多朋友在写程序的时候有用过比如Apple.class来查看类型信息，大家就可以把它理解为封装了类的信息，很多解释说Class类没有构造器，其实是有的，只不过它的构造方法是private的（构造函数还有private的？？有，这样是为了禁止开发者去自己创建Class类的实例）。我们可以看一下JDK中源码：

      

　　注释很明确的告诉了我们，这个类是有JVM来创建的，所以我们就不用麻烦了。如果我们拿到一个类的类型信息，就可以利用反射获取其各种成员以及方法了。（注：Class 从JDK1.5版本后就开始更多为泛型服务了）那么我们怎么拿到一个类型的信息呢？假设我们有一个Role类：

 

 1 package yui;
 2 
 3 /**
 4  * A base class having some attributes and methods
 5  * @author Octobershiner
 6  * @since 2012 3 17
 7  * 
 8  * */
10 public class Role {
11     
12     private String name;
13     private String type;
14     
15     // Constructors
16     public Role(){
17         System.out.println("Constructor Role() is invoking");
18     }
19     //私有构造器
20     private Role(String name){
21         this.name = name;
22         System.out.println("Constructor Role(String name) is invoking.");
23     }
24     
25     //get and set method
26     
27     public String getName() {
28         return name;
29     }
30     public void setName(String name) {
31         this.name = name;
32     }
33     public String getType() {
34         return type;
35     }
36     public void setType(String type) {
37         this.type = type;
38     }
39     
40     //override the toString method to show the class
41     @Override
42     public String toString(){
43         return "This is a role called "+this.name;
44     }
45     
46 }

　　在没有对象实例的时候，主要有两种办法。

        //获得类类型的两种方式
        Class cls1 = Role.class;
        Class cls2 = Class.forName("yui.Role");

　　注意第二种方式中，forName中的参数一定是完整的类名（包名+类名），并且这个方法需要捕获异常。现在得到cls1就可以创建一个Role类的实例了，利用Class的newInstance方法相当于调用类的默认的构造器

        Object o = cls1.newInstance(); //创建一个实例
        //Object o1 = new Role();   //与上面的方法等价

　　这样就创建了一个对象，缺点是我们只能利用默认构造函数，因为Class的newInstance是不接受参数的，后面会讲到可接受参数的newInstance，第二，如果类的构造函数是private的，比如Class，我们仍旧不能实例化其对象。

 

   获取类的构造器                                                                                                                                                                       

     

　　首先介绍一下Constructor类，这个类用来封装反射得到的构造器，Class有四个方法来获得Constructor对象

• public Constructor<?>[] getConstructors()      返回类中所有的public构造器集合，默认构造器的下标为0
• public Constructor<T> getConstructor(Class<?>... parameterTypes)   返回指定public构造器，参数为构造器参数类型集合
• public Constructor<?>[] getDeclaredConstructors()  返回类中所有的构造器，包括私有
• public Constructor<T> getDeclaredConstructor(Class<?>... parameterTypes) 返回任意指定的构造器

    从名字来看，还是很好懂的，带上Declared的都是获得所有的构造方法，包括私有，哈，这下我们就可以调用原本不允许调用的私有构造器了，看代码

 

 1         /**
 2          * 获取构造方法Constructor
 3          * getConstructor()  only for public 
 4          * getDeclaredConstructor()  global access all 
 5          * 
 6          * */
 7         
 8         //指定参数列表获取特定的方法
 9         Constructor con = cls1.getDeclaredConstructor(new Class[]{String.class});
10         con.setAccessible(true); //设置可访问的权限
11         Object obj = con.newInstance(new Object[]{"liyang"});
12         System.out.println(obj);  //打印一下这个对象的信息
13         
14 //获取所有的构造方法集合
15         Constructor con1[] = cls1.getDeclaredConstructors();
16         con1[1].setAccessible(true);
17         Object obj1 = con1[1].newInstance(new Object[]{"tom"});
18         System.out.println(obj1);

　　

　　解释一下：第一个是获得一个指定的方法，我们指定了参数是一个String类型，第二段我们获得了所有的构造方法集合，并选取了其中一个创建了新的对象。注意这里Constructor的newInstance方法就可以设置参数了，与文章前面的同样的方法形成了对比。

　　注意，以上的四个方法全部需要抛出异常，当我们获得私有的方法的时候，要用setAccessible设置一下可访问的权限，例子中没有演示获取共有方法，那个比较简单，就不做介绍了，其实掌握了上面两个，其他就好理解了。

 

获取类的成员变量                                                                                                                                                                    

     

　　 了解了构造器，其实你可以猜到成员变量的获取方法了，成员变量用Field类进行封装。

       主要的方法非常的类似：

• public Field getDeclaredField(String name)  获取任意指定名字的成员
• public Field[] getDeclaredFields()             获取所有的成员变量
• public Field getField(String name)           获取任意public成员变量
• public Field[] getFields()                          获取所有的public成员变量

  　 可以看出这些方法都是异曲同工的，好了直接看一下例子吧

 

1         /**
2          * 获取成员变量Field
3          * getField()
4          * getDeclaredField()
5          * */
6         Field mem = cls1.getDeclaredField("name");
7         mem.setAccessible(true);      
8         System.out.println("we get form field :"+mem.get(obj));
9          

　　

　　这是在访问私有变量，什么私有变量也可以访问？？是的。。。。

     

      获取类的方法                                                                                                                                                                      

     

　　 我觉得你已经可以帮我写这一段了，封装类的方法的类是Method.获取method也有四个方法，猜到了没？？

• public Method[] getMethods()    获取所有的共有方法的集合
• public Method getMethod(String name,Class<?>... parameterTypes) 获取指定公有方法 参数1：方法名 参数2：参数类型集合  
• public Method[] getDeclaredMethods()  获取所有的方法
• public Method getDeclaredMethod(String name,Class<?>... parameterTypes) 获取任意指定方法

       看下面的例子吧

   

1         /**
2          * 调用类的方法 Method
3          * getMethod()
4          * getDeclaredMethod()
5          * 
6          * */
7         Method f = cls1.getMethod("getName", null);
8         Object name = f.invoke(obj, null);
9         System.out.println("we invoke method : "+ name);

         

　　这个很简单吧，无参的时候我们只要传null就行了。

总结：                                                                                                                                                                                      

       以上就是反射机制的简单的使用，显然学过spring的朋友一定明白了，为什么可以通过配置文件就可以让我们获得指定的方法和变量，在我们创建对象的时候都是通过传进string实现的，就好像你需要什么，我们去为你生产，还有我们一直在用Object,这就说明java语言的动态特性，依赖性大大的降低了。