1. 介绍

首先,我们来认识一下什么是反射。其实API文档中对反射有详细的说明,我们去了解一下。在java.lang.reflect包中,官方对反射的解释如下图所示

1668575265599

翻译成人话就是:反射技术,指的是加载类的字节码到内存,并以编程的方法解刨出类中的各个成分(成员变量、方法、构造器等)。

  • 反射有啥用呢?

举一个我们见过的例子:平时我们用IDEA开发程序时,用对象调用方法,IDEA会有代码提示,idea会将这个对象能调用的方法都给你列举出来,供你选择,如果下图所示

1668576426355

问题是IDEA怎么知道这个对象有这些方法可以调用呢? 原因是对象能调用的方法全都来自于类,IDEA通过反射技术就可以获取到类中有哪些方法,并且把方法的名称以提示框的形式显示出来,所以你能看到这些提示了。

  • 反射具体学什么?

因为反射获取的是类的信息,那么反射的第一步首先获取到类才行。

由于Java的设计原则是万物皆对象,获取到的类其实也是以对象的形式体现的,叫字节码对象,用Class类来表示。获取到字节码对象之后,再通过字节码对象就可以获取到类的组成成分了,这些组成成分其实也是对象,其中每一个成员变量用Field类的对象来表示每一个成员方法用Method类的对象来表示每一个构造器用Constructor类的对象来表示

如下图所示:

image-20230219102017792

2. 获取类对象

  • 获取类对象的三种方式
    • 类名.class
    • 实例对象.getClass()
    • Class.forName("类的全限定名")
  • 注意: 下面代码得到的类对象都是同一个,地址一样

1668575796295

3. 反射获取构造方法及使用

3.1. Class类获取构造方法对象的方法

  • 方法介绍

    方法名 说明
    Constructor\<?>[] getConstructors() 返回所有公共构造方法对象的数组
    Constructor\<?>[] getDeclaredConstructors() 返回所有构造方法对象的数组
    Constructor<T> getConstructor(Class\<?>... parameterTypes) 返回单个公共构造方法对象
    Constructor<T> getDeclaredConstructor(Class\<?>... parameterTypes) 返回单个构造方法对象
  • 示例代码

package link.xiaomo.test3;

import java.lang.reflect.Constructor;

public class Demo01 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchMethodException {
        Class<?> clz = Class.forName("link.xiaomo.test3.Student");

        //method01(clz);
        //method02(clz);
        //method03(clz);

        method04(clz);

    }

    //获取单个的私有或者公有的构造 根据参数获取
    private static void method04(Class<?> clz) throws NoSuchMethodException {
        //private link.xiaomo.test3.Student(java.lang.String)
        Constructor<?> c1 = clz.getDeclaredConstructor(String.class);
        //public link.xiaomo.test3.Student(java.lang.String,int)
        System.out.println(c1);
    }

    //获取单个的公有的构造 根据参数获取
    private static void method03(Class<?> clz) throws NoSuchMethodException {
        //获取单个的公有的构造 根据参数获取
        Constructor<?> c = clz.getConstructor(String.class, int.class);
        //public link.xiaomo.test3.Student(java.lang.String,int)
        System.out.println(c);
    }

    //获取所有的(包括私有的)构造方法
    private static void method02(Class<?> clz) {
        //private link.xiaomo.test3.Student(java.lang.String)
        //public link.xiaomo.test3.Student()
        //public link.xiaomo.test3.Student(java.lang.String,int)
        Constructor<?>[] declaredC = clz.getDeclaredConstructors();
        for (Constructor<?> c : declaredC) {
            System.out.println(c);
        }
    }

    //获取所有公共构造方法
    private static void method01(Class<?> clz) {
        //获取所有公共构造方法
        Constructor<?>[] constructors = clz.getConstructors();
        //public link.xiaomo.test3.Student()
        //public link.xiaomo.test3.Student(java.lang.String,int)
        for (Constructor<?> c : constructors) {
            System.out.println(c);
        }
    }
}

3.2. 基本数据类型的class

  • 我们前面提到的所有例子都是针对引用类型的,那基本数据类型要怎么获取class对象呢?

比如我们想获取int的class对象的话,使用的就是int.class

int.class对应的Class对象是JVM合成出来的,并不是从Class文件加载出来的。注意:int.class跟Integer.class所指向的不是同一个Class对象。
int.class double.class float.class void.class
JVM的实现中,在JVM初始化的时候就会把原始类型void对应的Class对象创建出来。这些Class对象的创建不依赖任何外部信息(例如说需要从Class文件加载的信息),不需要经历类加载过程,而纯粹是JVM的实现细节。

Java的int类型是原始类型,是值类型而不是引用类型(或者说“对象”)。使用它并不会触发任何类加载动作 ,不会调用任何构造器。它就是个简单的值,直接存储在局部变量/字段中。

3.3. Constructor类用于创建对象的方法

  • 方法介绍

    方法名 说明
    T newInstance(Object...initargs) 根据指定的构造方法创建对象
    setAccessible(boolean flag) 设置为true,表示取消访问检查

3.4. 代码实现

    public static void main(String[] args) throws ClassNotFoundException, NoSuchMethodException, IllegalAccessException, InvocationTargetException, InstantiationException {
        Class c1 = Class.forName("link.xiaomo.test3.Student");

        //获取公有的指定参数的构造方法
        Constructor constructor1 = c1.getConstructor();
        System.out.println(constructor1);
        //用构造方法的newInstance 来创建对象
        Student s1 = (Student) constructor1.newInstance();
        System.out.println(s1);

        System.out.println("--------------------------------------------");
        //获取公有的指定参数的构造方法 参数类型 是String和int
        Constructor constructor2 = c1.getConstructor(String.class, int.class);
        System.out.println(constructor2);
        //用构造方法的newInstance 来创建对象,传入参数"张三", 18
        Student s2 = (Student) constructor2.newInstance("张三", 18);
        System.out.println(s2);

        //获取私有的指定的构造方法  参数类型是String
        System.out.println("--------------------------------------------");
        Constructor constructor3 = c1.getDeclaredConstructor(String.class);
        System.out.println(constructor3);
        //设置私有构造为可以访问的  暴力反射
        constructor3.setAccessible(true);
        //用构造方法的newInstance 来创建对象,传入参数 lisi
        Student s3 = (Student) constructor3.newInstance("lisi");
        System.out.println(s3);

        System.out.println("--------------直接用类newInstance 被淘汰的方式-----------------------");
        Student s4 = (Student) c1.newInstance();//直接用类对象.newInstance 被淘汰的方式
        System.out.println(s4);
    }

3.5. 小结

  • 获取class对象

    三种方式: Class.forName(“全类名”), 类名.class, 对象名.getClass()

  • 获取里面的构造方法对象

    getConstructor (Class<?>... parameterTypes)
    getDeclaredConstructor (Class<?>... parameterTypes)

  • 如果是public的,直接创建对象

    newInstance(Object... initargs)

  • 如果是非public的,需要临时取消检查,然后再创建对象

    setAccessible(boolean) 暴力反射

4. 反射获取成员变量并使用

4.1. Class类获取成员变量对象的方法

  • 方法分类

    方法名 说明
    Field[] getFields() 返回所有公共成员变量对象的数组
    Field[] getDeclaredFields() 返回所有成员变量对象的数组
    Field getField(String name) 返回单个公共成员变量对象
    Field getDeclaredField(String name) 返回单个成员变量对象

4.2. Student代码

public class Student {

    public String name;

    public int age;

    public String gender;

    private int money = 300;

    @Override
    public String toString() {
        return "Student{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", gender='" + gender + '\'' +
                ", money=" + money +
                '}';
    }
}

4.3. 测试代码

Class c1 = Class.forName("link.xiaomo.test4.Student");

//返回所有公共成员变量对象的数组
Field[] fs1 = c1.getFields();
for (Field f : fs1) {
    System.out.println(f);
}
System.out.println("-----------------------------------");
//返回所有成员变量(包含公共的和私有的)对象的数组
Field[] fs2 = c1.getDeclaredFields();
for (Field f : fs2) {
    System.out.println(f);
}

//获取公共的 指定的变量名字的的对象
Field fieldName = c1.getField("name");
System.out.println(fieldName);

//获取公共的 指定的变量名字的的对象
Field fieldage = c1.getField("age");
System.out.println(fieldage);

//获取公共的 指定的变量名字的的对象
Field fieldgender = c1.getField("gender");
System.out.println(fieldgender);

//获取私有的 指定的变量名字的对象
Field fieldmoney = c1.getDeclaredField("money");
System.out.println(fieldmoney);

4.4. Field类用于给成员变量赋值的方法

  • 方法介绍

    方法名 说明
    void set(Object obj, Object value) 赋值
    Object get(Object obj) 获取值

4.5. 代码实现

  • 私有的依然要 调用setAccessible(true) 才可以设置和获取
package link.xiaomo.test4;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;

public class Demo02 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException, IllegalAccessException, InvocationTargetException, InstantiationException {
        //获取Student的类对象
        Class<?> clz = Class.forName("link.xiaomo.test4.Student");

        //获取构造方法
        Constructor<?> constructor = clz.getConstructor();

        //创建一个学生对象
        Object o = constructor.newInstance();

        //获取name属性的Field对象
        Field fName = clz.getField("name");

        //获取money属性的Field对象
        Field fMoney = clz.getDeclaredField("money");

        //给name赋值  参1是要赋值的对象 参2是具体的值
        fName.set(o, "zs");
        System.out.println(o);

        //给money赋值
        fMoney.setAccessible(true);//设置私有变量可以访问
        fMoney.set(o, 200);//给money赋值
        System.out.println(o);

        //获取值
        System.out.println(fName.get(o));
        System.out.println(fMoney.get(o));

    }
}

5. 反射获取成员方法并使用

5.1. Class类获取成员方法对象的方法

  • 方法分类

    方法名 说明
    Method[] getMethods() 返回所有公共成员方法对象的数组,包括继承的
    Method[] getDeclaredMethods() 返回所有成员方法对象的数组,不包括继承的
    Method getMethod(String name, Class\<?>... parameterTypes) 返回单个公共成员方法对象
    Method getDeclaredMethod(String name, Class\<?>... parameterTypes) 返回单个成员方法对象
  • 示例代码

public class Student {

    //私有的,无参无返回值
    private void show() {
        System.out.println("私有的show方法,无参无返回值");
    }

    //公共的,无参无返回值
    public void function1() {
        System.out.println("function1方法,无参无返回值");
    }

    //公共的,有参无返回值
    public void function2(String name) {
        System.out.println("function2方法,有参无返回值,参数为" + name);
    }

    //公共的,无参有返回值
    public String function3() {
        System.out.println("function3方法,无参有返回值");
        return "aaa";
    }

    //公共的,有参有返回值
    public String function4(String name) {
        System.out.println("function4方法,有参有返回值,参数为" + name);
        return "aaa";
    }
}
public class ReflectDemo1 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchMethodException {
        //method1();
        //method2();
        //method3();
        //method4();
        //method5();
    }

    private static void method1() throws ClassNotFoundException {
        //        Method[] getMethods():返回所有公共成员方法对象的数组,包括继承的
        //1.获取class对象
        Class clazz = Class.forName("link.xiaomo.test5.Student");
        //2.获取成员方法对象
        Method[] methods = clazz.getMethods();
        //3.遍历
        for (Method method : methods) {
            System.out.println(method);
        }
    }

    private static void method2() throws ClassNotFoundException {
        //        Method[] getDeclaredMethods():
//                                返回所有成员方法对象的数组,不包括继承的
        //1.获取class对象
        Class clazz = Class.forName("link.xiaomo.test5.Student");

        //2.获取Method对象
        Method[] methods = clazz.getDeclaredMethods();
        //3.遍历一下数组
        for (Method method : methods) {
            System.out.println(method);
        }
    }

    private static void method3() throws ClassNotFoundException, NoSuchMethodException {
        //        Method getMethod(String name, Class<?>... parameterTypes) :
//                                返回单个公共成员方法对象
        //1.获取class对象
        Class clazz = Class.forName("link.xiaomo.test5.Student");
        //2.获取成员方法function1
        Method method1 = clazz.getMethod("function1");
        //3.打印一下
        System.out.println(method1);
    }

    private static void method4() throws ClassNotFoundException, NoSuchMethodException {
        //1.获取class对象
        Class clazz = Class.forName("link.xiaomo.test5.Student");
        //2.获取一个有形参的方法function2
        Method method = clazz.getMethod("function2", String.class);
        //3.打印一下
        System.out.println(method);
    }

    private static void method5() throws ClassNotFoundException, NoSuchMethodException {
        //        Method getDeclaredMethod(String name, Class<?>... parameterTypes):
//                                返回单个成员方法对象
        //1.获取class对象
        Class clazz = Class.forName("link.xiaomo.test5.Student");
        //2.获取一个成员方法show
        Method method = clazz.getDeclaredMethod("show");
        //3.打印一下
        System.out.println(method);
    }
}

5.2. Method类用于执行方法的方法

  • 方法介绍

    方法名 说明
    Object invoke(Object obj, Object... args) 运行方法

    参数一: 用obj对象调用该方法

    参数二: 调用方法的传递的参数(如果没有就不写)

    返回值: 方法的返回值(如果没有就不写)

5.3. 代码实现

  • method3 是公共无参的
  • method4 是公共有参的
  • method5 是私有无参的,注意方法内,依然需要setAccessible(true); 取消私有方法的检查
public static void main(String[] args) throws ClassNotFoundException, NoSuchMethodException, IllegalAccessException, InvocationTargetException, InstantiationException {

    Class<?> clz = Class.forName("link.xiaomo.test5.Student");

    //创建一个实例对象
    Object o = clz.getConstructor().newInstance();

    Method mFunc1 = clz.getMethod("function1");
    Method mFunc2 = clz.getMethod("function2", String.class);
    Method mFunc3 = clz.getMethod("function3");
    Method mFunc4 = clz.getMethod("function4", String.class);

    Method mShow = clz.getDeclaredMethod("show");

    //无参无返回值方法调用
    mFunc1.invoke(o);
    //有参无返回值方法调用
    mFunc2.invoke(o, "aaa");
    //无参有返回值方法调用
    System.out.println(mFunc3.invoke(o));
    //有参有返回值方法调用
    System.out.println(mFunc4.invoke(o, "zzzz"));

    //mShow设置为私有可以访问
    mShow.setAccessible(true);
    //调用方法show
    mShow.invoke(o);
}
如人饮水,冷暖自知。
最后更新于 2023-08-05