Java 反射

1.概述

1.1 什么是反射

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

1.2 为什么要使用反射

正常的要实例化一个对象并调用sayHello方法

ClassA objA = new ClassA();
objA.sayHello();

通过反射去实例化一个对象并调用sayHello方法

Class objA = Class.forName("com.spring.fanshe.Human");
Method method = objA.getMethod("sayHello");
method.invoke(objA.newInstance);

在source阶段实际上二者并无任何区别，反射也没有体现出任何的优势，那么任何一个java开发人员必然会问为什么要使用反射？

反射的重点在于runtime阶段的获取类信息和调用类方法，那么当你的编码过程中有“部分信息是source阶段不清晰，需要在runtime阶段动态临时加载”这种场景，反射就可以派上用场了

我们考虑几个编码场景：

1. 编码阶段不知道需要实例化的类名是哪个，需要在runtime从配置文件中加载：

Class clazz = class.forName("xxx.xxx.xxx")
clazz.newInstance();

1. 在runtime阶段，需要临时访问类的某个私有属性

ClassA objA = new ClassA();
Field xxx = objA.getClass().getDeclaredField("xxx")
xxx.setAccessible(true);

所以，反射的优点在于“有些编码需求在source阶段无法实现，只能在runtime阶段通过反射实现”，而非“source阶段正常编码方式能解决的，反射的方式能解决的更好”，所以比较反射和正常编码方式的优劣是没有意义的，反射解决的是正常编码无法解决的编码场景，如果正常编码方式可以解决的，强行使用反射反而是毫无意义的，编码不是为了show技巧。

2. Class类的介绍

• Class类的实例表示正在运行的Java应用程序中的类和接口，也就是JVM中有N多的实例，每个类都有该Class对象(包括基本数据类型)
• Class类没有公共构造方法，Class对象是在加载类时由jvm以及通过调用类加载器中的defineClass方法自动构造的。也就是这不需要我们自己去处理创建，JVM已经帮我们创建好了。

如果我们应用反射来在运行时得到类的信息，根据类的那些信息做一些特定的操作，那么，首先毫无疑问的就是得到类的信息，在JDK中提供Class对象来保存类的信息，所以，反射的第一步就是得到Class对象。在JDK中提供了三种方式得到Class对象

这三种方式请看如下代码：

public static void main(String[] args) {

        //第一种方式获取Class对象
        Student stu1 = new Student();//这一new 产生一个Student对象，一个Class对象。
        Class stuClass = stu1.getClass();//获取Class对象
        System.out.println(stuClass.getName());


        //第二种方式获取Class对象
        Class stuClass2 = Student.class;
        System.out.println(stuClass == stuClass2);//判断第一种方式获取的Class对象和第二种方式获取的是否是同一个


        //第三种方式获取Class对象
        try {
            Class stuClass3 = Class.forName("com.spring.fanshe.Student");//注意此字符串必须是真实路径，就是带包名的类路径，包名.类名
            System.out.println(stuClass3 == stuClass2);//判断三种方式是否获取的是同一个Class对象
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }

}

运行结果：

调用了公有、无参构造方法执行了。。。
com.spring.fanshe.Student
true
true

注意：在运行期间，一个类，只有一个Class对象产生
上面得到Class对象的方式中，常用第三种，第一种对象都有了还要反射干什么，第二种需要导入类的包，依赖太强，不导包就抛编译错误。一般都用第三种，一个字符串可以传入也可以写在配置文件中等多种方法。

3. 反射的使用

3.1 通过反射获取构造方法并使用

首先我们声明一个Student类方便我们进行介绍：

public class Student {

    //（默认的构造方法）
    Student(String str){
        System.out.println("(默认)的构造方法 s = " + str);
    }

    //无参构造方法
    public Student(){
        System.out.println("调用了公有、无参构造方法执行了。。。");
    }

    //有一个参数的构造方法
    public Student(char name){
        System.out.println("姓名：" + name);
    }

    //有多个参数的构造方法
    public Student(String name ,int age){
        System.out.println("姓名："+name+"年龄："+ age);
    }

    //受保护的构造方法
    protected Student(boolean n){
        System.out.println("受保护的构造方法 n = " + n);
    }

    //私有构造方法
    private Student(int age){
        System.out.println("私有的构造方法   年龄："+ age);
    }
}

测试类

通过Class对象可以获取某个类中的：构造方法、成员变量、成员方法；并访问成员；

/* 
 * 通过Class对象可以获取某个类中的：构造方法、成员变量、成员方法；并访问成员； 
 *  
 * 1.获取构造方法： 
 *      1).批量的方法： 
 *          public Constructor[] getConstructors()：所有"公有的"构造方法 
            public Constructor[] getDeclaredConstructors()：获取所有的构造方法(包括私有、受保护、默认、公有) 
      
 *      2).获取单个的方法，并调用： 
 *          public Constructor getConstructor(Class... parameterTypes):获取单个的"公有的"构造方法： 
 *          public Constructor getDeclaredConstructor(Class... parameterTypes):获取"某个构造方法"可以是私有的，或受保护、默认、公有； 
 *       
 *          调用构造方法： 
 *          Constructor-->newInstance(Object... initargs) 
 */  
public class Constructors {
    public static void main(String[] args) throws Exception {
        //1.加载Class对象
        Class clazz = Class.forName("com.spring.fanshe.Student");


        System.out.println("**********************所有公有构造方法*********************************");
        Constructor[] conArray = clazz.getConstructors();
        for(Constructor c : conArray){
            System.out.println(c);
        }


        System.out.println("************所有的构造方法(包括：私有、受保护、默认、公有)***************");
        conArray = clazz.getDeclaredConstructors();
        for(Constructor c : conArray){
            System.out.println(c);
        }

        System.out.println("*****************获取公有、无参的构造方法*******************************");
        Constructor con = clazz.getConstructor();
        System.out.println("con = " + con);
        //调用构造方法
        Object obj = con.newInstance();
        System.out.println("obj = " + obj);

        System.out.println("******************获取私有构造方法，并调用*******************************");
        con = clazz.getDeclaredConstructor(int.class);
        System.out.println(con);
        //调用构造方法
        con.setAccessible(true);//暴力访问(忽略掉访问修饰符)
        obj = con.newInstance(25);
    }
}

运行结果如下：

**********************所有公有构造方法*********************************
public com.spring.fanshe.Student(java.lang.String,int)
public com.spring.fanshe.Student(char)
public com.spring.fanshe.Student()
************所有的构造方法(包括：私有、受保护、默认、公有)***************
private com.spring.fanshe.Student(int)
protected com.spring.fanshe.Student(boolean)
public com.spring.fanshe.Student(java.lang.String,int)
public com.spring.fanshe.Student(char)
public com.spring.fanshe.Student()
com.spring.fanshe.Student(java.lang.String)
*****************获取公有、无参的构造方法*******************************
con = public com.spring.fanshe.Student()
调用了公有、无参构造方法执行了。。。
obj = com.spring.fanshe.Student@60e53b93
******************获取私有构造方法，并调用*******************************
private com.spring.fanshe.Student(int)
私有的构造方法   年龄：25

3.2 获取成员变量并调用

声明一个Person类，定义了各种类型和修饰符的成员变量

public class Person {

    public String name;
    protected int age;
    char sex;
    private String phoneNum;

    @Override
    public String toString() {
        return "Person [name=" + name + ", age=" + age + ", sex=" + sex
                + ", phoneNum=" + phoneNum + "]";
    }
}

测试类

/* 
 * 获取成员变量并调用： 
 *  
 * 1.批量的 
 *      1).Field[] getFields():获取所有的"公有字段" 
 *      2).Field[] getDeclaredFields():获取所有字段，包括：私有、受保护、默认、公有； 
 * 2.获取单个的： 
 *      1).public Field getField(String fieldName):获取某个"公有的"字段； 
 *      2).public Field getDeclaredField(String fieldName):获取某个字段(可以是私有的) 
 *  
 *   设置字段的值： 
 *      Field --> public void set(Object obj,Object value): 
 *                  参数说明： 
 *                  1.obj:要设置的字段所在的对象； 
 *                  2.value:要为字段设置的值； 
 *  
 */  
 
public static void main(String[] args) throws Exception {
        //1.获取Class对象  
        Class personClass = Class.forName("com.spring.fanshe.Person");
        //2.获取字段  
        System.out.println("************获取所有公有的字段********************");
        Field[] fieldArray = personClass.getFields();
        for(Field f : fieldArray){
            System.out.println(f);
        }
        System.out.println("************获取所有的字段(包括私有、受保护、默认的)********************");
        fieldArray = personClass.getDeclaredFields();
        for(Field f : fieldArray){
            System.out.println(f);
        }
        System.out.println("*************获取公有字段**并调用***********************************");
        Field f = personClass.getField("name");
        System.out.println(f);
        //获取一个对象  
        Object obj = personClass.getConstructor().newInstance();//产生Person对象--》Person person = new Person();  
        //为字段设置值  
        f.set(obj, "刘德华");//为Person对象中的name属性赋值--》person.name = "刘德华"  
        //验证  
        Person person = (Person)obj;
        System.out.println("验证姓名：" + person.name);


        System.out.println("**************获取私有字段****并调用********************************");
        f = personClass.getDeclaredField("phoneNum");
        System.out.println(f);
        f.setAccessible(true);//暴力反射，解除私有限定  
        f.set(obj, "18888889999");
        System.out.println("验证电话：" + person);

    }

运行结果如下：

************获取所有公有的字段********************
public java.lang.String com.spring.fanshe.Person.name
************获取所有的字段(包括私有、受保护、默认的)********************
public java.lang.String com.spring.fanshe.Person.name
protected int com.spring.fanshe.Person.age
char com.spring.fanshe.Person.sex
private java.lang.String com.spring.fanshe.Person.phoneNum
*************获取公有字段**并调用***********************************
public java.lang.String com.spring.fanshe.Person.name
验证姓名：刘德华
**************获取私有字段****并调用********************************
private java.lang.String com.spring.fanshe.Person.phoneNum
验证电话：Person [name=刘德华, age=0, sex= , phoneNum=18888889999]

3.3 获取成员方法并调用

我们创建一个Human类，定义了3种成员方法，不同参数列表和不同的访问修饰符

public class Human {

    public void show1(String s){
        System.out.println("调用了：公有的，String参数的show1(): s = " + s);
    }
    protected void show2(){
        System.out.println("调用了：受保护的，无参的show2()");
    }
    void show3(){
        System.out.println("调用了：默认的，无参的show3()");
    }
    private String show4(int age){
        System.out.println("调用了，私有的，并且有返回值的，int参数的show4(): age = " + age);
        return "abcd";
    }
}

测试类：

/* 
 * 获取成员方法并调用： 
 *  
 * 1.批量的： 
 *      public Method[] getMethods():获取所有"公有方法"；（包含了父类的方法也包含Object类） 
 *      public Method[] getDeclaredMethods():获取所有的成员方法，包括私有的(不包括继承的) 
 * 2.获取单个的： 
 *      public Method getMethod(String name,Class<?>... parameterTypes): 
 *                  参数： 
 *                      name : 方法名； 
 *                      Class ... : 形参的Class类型对象 
 *      public Method getDeclaredMethod(String name,Class<?>... parameterTypes) 
 *  
 *   调用方法： 
 *      Method --> public Object invoke(Object obj,Object... args): 
 *                  参数说明： 
 *                  obj : 要调用方法的对象； 
 *                  args:调用方式时所传递的实参； 
 */  
 
 
public static void main(String[] args) throws Exception {
        //获取Class对象
        Class humClass = Class.forName("com.spring.fanshe.Human");


        System.out.println("***************获取所有的”公有“方法*******************");
        humClass.getMethods();
        Method[] methodArray = humClass.getMethods();
        for (Method m : methodArray) {
            System.out.println(m);
        }


        System.out.println("***************获取所有的方法，包括私有的*******************");
        methodArray = humClass.getDeclaredMethods();
        for (Method m : methodArray) {
            System.out.println(m);
        }


        System.out.println("***************获取公有的show1()方法*******************");
        Method m = humClass.getMethod("show1", String.class);
        System.out.println(m);
        //实例化一个humdent对象  
        Object obj = humClass.newInstance();
        m.invoke(obj, "刘德华");


        System.out.println("***************获取私有的show4()方法******************");
        m = humClass.getDeclaredMethod("show4", int.class);
        System.out.println(m);
        m.setAccessible(true);//解除私有限定  
        Object result = m.invoke(obj, 20);//需要两个参数，一个是要调用的对象（获取有反射），一个是实参  
        System.out.println("返回值：" + result);
    }

运行结果如下：

***************获取所有的”公有“方法*******************
public void com.spring.fanshe.Human.show1(java.lang.String)
public final void java.lang.Object.wait() throws java.lang.InterruptedException
public final void java.lang.Object.wait(long,int) throws java.lang.InterruptedException
public final native void java.lang.Object.wait(long) throws java.lang.InterruptedException
public boolean java.lang.Object.equals(java.lang.Object)
public java.lang.String java.lang.Object.toString()
public native int java.lang.Object.hashCode()
public final native java.lang.Class java.lang.Object.getClass()
public final native void java.lang.Object.notify()
public final native void java.lang.Object.notifyAll()
***************获取所有的方法，包括私有的*******************
public void com.spring.fanshe.Human.show1(java.lang.String)
private java.lang.String com.spring.fanshe.Human.show4(int)
void com.spring.fanshe.Human.show3()
protected void com.spring.fanshe.Human.show2()
***************获取公有的show1()方法*******************
public void com.spring.fanshe.Human.show1(java.lang.String)
调用了：公有的，String参数的show1(): s = 刘德华
***************获取私有的show4()方法******************
private java.lang.String com.spring.fanshe.Human.show4(int)
调用了，私有的，并且有返回值的，int参数的show4(): age = 20
返回值：abcd

3.4 通过反射运行配置文件内容

student类：

public class Book {  
    public void show(){  
        System.out.println("is show()");  
    }  
}

配置文件以txt文件为例子（1.txt）：

className = cn.fanshe.Student  
methodName = show

测试类：

/*
 * 我们利用反射和配置文件，可以使：应用程序更新时，对源码无需进行任何修改
 * 我们只需要将新类发送给客户端，并修改配置文件即可
 */
public class BookClass {

    public static void main(String[] args) throws Exception {
        //通过反射获取Class对象
        Class stuClass = Class.forName(getValue("className"));//"cn.fanshe.Student"
        //2获取show()方法
        Method m = stuClass.getMethod(getValue("methodName"));//show
        //3.调用show()方法
        m.invoke(stuClass.getConstructor().newInstance());

    }

    //此方法接收一个key，在配置文件中获取相应的value
    public static String getValue(String key) throws IOException {
        Properties pro = new Properties();//获取配置文件的对象
        FileReader in = new FileReader("F:\\project\\why-spring\\src\\main\\resources\\1.txt");//获取输入流
        pro.load(in);//将流加载到配置文件对象中
        in.close();
        return pro.getProperty(key);//返回根据key获取的value值
    }

}

看到这里有没有想起Spring中配置Bean的XML文件：

<bean id="student" class="com.spring.fanshe.Book" />

3.5 通过反射越过泛型检查

如下面方法所示，

public static void main(String[] args) throws Exception{
        ArrayList<String> strList = new ArrayList<>();
        strList.add("aaa");
        strList.add("bbb");
        
        //在声明泛型为String的类型的ArrayList中添加int类型
        strList.add(100);

        

        //遍历集合
        for(Object obj : strList){
            System.out.println(obj);
        }
    }

运行结果:

Error:(16, 16) java: 对于add(int), 找不到合适的方法
    方法 java.util.Collection.add(java.lang.String)不适用
      (参数不匹配; int无法转换为java.lang.String)

但是通过反射我们就可以绕过泛型检查，将int类型的值100添加到泛型为String的ArrayList 中，如下代码所示：

    public static void main(String[] args) throws Exception{
        ArrayList<String> strList = new ArrayList<>();
        strList.add("aaa");
        strList.add("bbb");
//        strList.add(100);
        //获取ArrayList的Class对象，反向的调用add()方法，添加数据
        Class listClass = strList.getClass(); //得到 strList 对象的字节码 对象
        //获取add()方法
        Method m = listClass.getMethod("add", Object.class);
        //调用add()方法
        m.invoke(strList, 100);

        //遍历集合
        for(Object obj : strList){
            System.out.println(obj);
        }
    }

运行结果：

aaa
bbb
100

4. 反射的应用

在Spring的配置文件中，经常看到如下配置：

<bean id="courseDao" class="com.qcjy.learning.Dao.impl.CourseDaoImpl"></bean>

那么通过这样配置，Spring是怎么帮我们实例化对象，并且放到容器中去了了？对，就是通过反射！！！
下面是Spring通过配置进行实例化对象，并放到容器中的伪代码：

//解析<bean .../>元素的id属性得到该字符串值为“courseDao”  
String idStr = "courseDao";  
//解析<bean .../>元素的class属性得到该字符串值为“com.qcjy.learning.Dao.impl.CourseDaoImpl”  
String classStr = "com.qcjy.learning.Dao.impl.CourseDaoImpl";  
//利用反射知识，通过classStr获取Class类对象  
Class<?> cls = Class.forName(classStr);  
//实例化对象  
Object obj = cls.newInstance();  
//container表示Spring容器  
container.put(idStr, obj);

通过解析xml文件，获取到id属性和class属性里面的内容，利用反射原理获取到配置里面类的实例对象，存入到Spring的bean容器中。

当一个类里面需要应用另一类的对象时，Spring的配置如下所示：

<bean id="courseService" class="com.qcjy.learning.service.impl.CourseServiceImpl">  
     <!-- 控制调用setCourseDao()方法，将容器中的courseDao bean作为传入参数 -->  
     <property name="courseDao" ref="courseDao"></property>  
</bean>

我们继续用伪代码的形式来模拟实现一下Spring底层处理原理：

//解析<property .../>元素的name属性得到该字符串值为“courseDao”  
String nameStr = "courseDao";  
//解析<property .../>元素的ref属性得到该字符串值为“courseDao”  
String refStr = "courseDao";  
//生成将要调用setter方法名  
String setterName = "set" + nameStr.substring(0, 1).toUpperCase()  
        + nameStr.substring(1);  
//获取spring容器中名为refStr的Bean，该Bean将会作为传入参数  
Object paramBean = container.get(refStr);  
//获取setter方法的Method类，此处的cls是刚才反射代码得到的Class对象  
Method setter = cls.getMethod(setterName, paramBean.getClass());  
//调用invoke()方法，此处的obj是刚才反射代码得到的Object对象  
setter.invoke(obj, paramBean);

通过上面对Spring底层原理的分析，可以发现，其实并不难，用到的都是反射机制，通过反射实例化对象，存入到Spring的bean容器中。

只要在代码或配置文件中看到类的完整路径（包.类），其底层原理基本上使用的就是Java的反射机制。