Concept of Reflection in Java

What’s the reflection
Why use reflection
How to use reflection

What’s the reflection

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

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

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

Why use reflection

Functionality

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

在运行时判断任意一个对象所属的类。
在运行时构造任意一个类的对象。
在运行时判断任意一个类所具有的成员变量和方法。
在运行时调用任意一个对象的方法。

Reflection是Java被视为动态（或准动态）语言的一个关键性质。
这个机制允许程序在运行时透过Reflection APIs取得任何一个已知名称的class的内部信息。
包括其modifiers（诸如public、static等）、 superclass（例如Object）、实现了的 interfaces （例如Serializable）、也包括其fields和methods的所有信息，并可于运行时改变fields内容或调用methods。

Dynamic Language

动态语言的定义“程序运行时，允许改变程序结构或者变量类型，这种语言称为动态语言”。

从这个观点看，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是常被并提的两个术语。

How to use reflection

Java Reflection API

在JDK中，主要由以下类来实现Java反射机制，这些类（除了第一个）都位于java.lang.reflect包中
Class类：代表一个类，位于java.lang包下。
Field类：代表类的成员变量（成员变量也称为类的属性）。
Method类：代表类的方法。
Constructor类：代表类的构造方法。
Array类：提供了动态创建数组，以及访问数组的元素的静态方法。

Class Object

要想使用反射，首先需要获得待操作的类所对应的Class对象。
Java中，无论生成某个类的多少个对象，这些对象都会对应于同一个Class对象。
这个Class对象是由JVM生成的，通过它能够获悉整个类的结构。

Get the Object of Class

By Static Method

Class.forName("java.lang.String");

By .class Grammar

String.class;

By Object’s getClass() Method

1 2	String str = "aa"; Class<?> classType1 = str.getClass();

getClass()方法定义在Object类中，不是静态方法，需要通过对象来调用，并且它声明为final，表明不能被子类所覆写。
直接print所获得的Class对象classType会输出：class 完整类名
如果调用该Class对象的getName()方法，则输出完整类名，不加class。

Get the Fields from Object

类的每一个成员变量都对应一个Field对象，Class类提供了以下方法来获取类的成员变量对应的Field对象：

Field getDeclaredField(String name)：根据传入的变量名称返回此Class对象所表示的类或接口中声明的变量对应的Field对象。
Field[] getDeclaredFields()：返回一个Field类型的数组，包含此Class对象所表示的类或接口中声明的所有变量的Field对象。
Field getField(String name)：根据传入的变量名返回一个Field对象，注意与getDeclaredField(String name)不同的是，此方法返回的是public变量对应的Field对象。
Field[] getFields()：返回一个Field类型的数组，注意与Field[] getDeclaredFields()方法不同的是，此方法返回的是所有public变量对应的Field对象。

//首先，获得String类的Class对象
Class<?> classType = Class.forName("java.lang.String");
//获得String类中声明的所有成员变量的Field对象的数组
Field[] fields = classType.getDeclaredFields();
//获得String类中声明的public成员变量的Field对象的数组
Field[] publicFields = classType.getFields();

Get the Methods from Object

类中的每一个方法都对应一个Method对象，Class类提供了以下方法来获取类中的方法对应的Method对象：

Method getDeclaredMethod(String name, Class<?>… parameterTypes)：返回一个Method对象，参数name表示方法名，可变参数parameterTypes是一个Class对象的数组，代表方法的参数的Class类型；
Method[] getDeclaredMethods()：返回Method对象的一个数组，这些对象反映此Class对象所表示的类或接口声明的所有方法，包括公共、保护、默认访问和私有方法，但不包括继承的方法；
Method getMethod(String name, Class<?>… parameterTypes)：返回一个Method对象，注意和此Method对象对应的方法是公共(public)方法；
Method[] getMethods()：返回一个Method数组，这些对象反映此Class对象所表示的类或接口中声明的公共(public)方法（也包括父类或父接口中声明的public方法）。

//首先，获得类的Class对象
Class<?> classType = Class.forName("java.lang.reflect.Proxy");
//获得类中声明的所有方法的Method对象的数组，不包括继承的父类的方法
Method[] methods = classType.getDeclaredMethods();
//获得类中的public方法的Method对象的数组，也包括继承的父类的public方法
Method[] publicMethods = classType.getMethods();

Example

Invoke Method by Reflection

Java反射机制可以在运行时动态调用类中的方法，Java Reflection API提供了我们所需的方法来完成动态调用。要想调用类中的方法首先要创建一个对象，我们通过类的Class对象来创建它所代表的类的实例，通过Class对象我们还能获得类中声明的方法的Method对象，Method类提供了Invoke方法来调用此Method对象所表示的方法。反射机制调用方法代码示例如下：

public class InvokeTester  
{  
    public int add(int param1, int param2)  
    {  
        return param1 + param2;  
    }  
    public String echo(String message)  
    {  
        return "Hello: " + message;  
    }  
    public static void main(String[] args) throws Exception  
    {  
        // 以前的常规执行手段  
        InvokeTester tester = new InvokeTester();  
        System.out.println(tester.add(1, 2));  
        System.out.println(tester.echo("Tom"));  
        System.out.println("---------------------------");  
        // 通过反射的方式  
        // 第一步，获取Class对象  
        // 前面用的方法是：Class.forName()方法获取  
        // 这里用第二种方法，类名.class  
        Class<?> classType = InvokeTester.class;  
        // 生成新的对象：用newInstance()方法  
        Object invokeTester = classType.newInstance();  
        System.out.println(invokeTester instanceof InvokeTester); // 输出true  
        // 通过反射调用方法  
        // 首先需要获得与该方法对应的Method对象  
        Method addMethod = classType.getMethod("add", new Class[] { int.class,  
                int.class });  
        // 第一个参数是方法名，第二个参数是这个方法所需要的参数的Class对象的数组  
        // 调用目标方法  
        Object result = addMethod.invoke(invokeTester, new Object[] { 1, 2 });  
        System.out.println(result); // 此时result是Integer类型  
        //调用第二个方法  
        Method echoMethod = classType.getDeclaredMethod("echo", new Class[]{String.class});  
        Object result2 = echoMethod.invoke(invokeTester, new Object[]{"Tom"});  
        System.out.println(result2);  
    }  
}

Invoke Private Method by Reflection

我们知道正常情况下一个类的私有方法只允许这个类本身来调用，但使用反射机制能打破这种访问限制，让其他的类也能调用这个类的私有的方法。这种场景在实际开发中很少用到，Java也不提倡这种用法。代码示例如下：

public class Private {
    //定义一个私有方法
    private String sayHello(String name){
        return "hello, "+name;
    }
}
public class PrivateTest {
    public static void main(String[] args) throws Exception {
        //调用Private类的私有方法
        Private p = new Private();
        Class<?> classType = p.getClass();
        Method method = classType.getDeclaredMethod("sayHello", String.class);
        method.setAccessible(true);//取消Java访问检查,如果不设置此项则会报错
        String str = (String)method.invoke(p, "Tracy");
        System.out.println(str);//输出：hello, Tracy
    }
}

Method、Field、Constructor类有一个共同的父类AccessibleObject类，它提供了将反射的对象标记为在使用时取消默认Java语言访问控制检查的能力。在上面的代码中，我们在反射对象Method中设置accessible标志，它允许程序以某种通常禁止的方式来操作对象。

Manipulate Private Field by Reflection

与前面调用类的私有方法类似，通过反射我们还能操作类的私有变量，代码示例如下：

public class Private2 {
      //定义私有变量
      private String name = "zhangsan";
      public String getName(){
          return name;
      }
  }
 public class PrivateTest2 {
     public static void main(String[] args) throws Exception {
         //改变Private2类的私有变量的值
         Private2 p = new Private2();
         Class<?> classType = p.getClass();
         Field field = classType.getDeclaredField("name");
         field.setAccessible(true);//取消默认java访问控制检查，Field类的父类AccessibleObject类提供的方法
         field.set(p, "lisi");//Field类的set(Object obj, Object value)方法将指定对象上此Field对象表示的字段设置为指定的新值
         System.out.println(p.getName());//输出：lisi
    }
}

Generate an Object By Reflection

1 2	Class<?> classType = String.class; Object obj = classType.newInstance();

Construct without Parameter

Class<?> classType = Customer.class;
// 获得Constructor对象,此处获取第一个无参数的构造方法的
Constructor cons = classType.getConstructor(new Class[] {});
// 通过构造方法来生成一个对象
Object obj = cons.newInstance(new Object[] {});

Construct with Parameter

// Customer为一个自定义的类，有无参数的构造方法，也有一个带参数的构造方法，传入字符串和整型
Class<?> classType = Customer.class;
Constructor cons2 = classType.getConstructor(new Class[] {String.class, int.class});
Object obj2 = cons2.newInstance(new Object[] {"ZhangSan",20});

可以看出调用构造方法生成对象的方法和调用一般方法的类似，不同的是从Class对象获取Constructor对象时不需要指定名字，而获取Method对象时需要指定名字。

Summary

以上这些内容，介绍了Java反射机制的中涉及的主要的几个类以及这些类的基本用法，这些类中还有很多的方法，大家可以通过查看API进行了解，用法都很简单。Java反射机制在很多框架的底层实现中有用到，还有一种很重要的设计模式也用到了反射，那就是代理模式中的动态代理，了解了动态代理模式的思想对我们研究框架有很大帮助

动态代理的使用场景就更加广泛了。需要使用AOP中的方法拦截功能的地方都可以用到动态代理。Spring框架的AOP实现默认也使用动态代理。不过JDK中的动态代理只支持对接口的代理，不能对一个普通的Java类提供代理。不过这种实现在大部分的时候已经够用了。

Reference

[1]Java 反射机制
[2]Java反射机制深度剖析
[3]你一直弄不懂的Java反射机制
[4]Java深度历险（七）——Java反射与动态代理

Table of Contents