【反射】Java小白也能手写的简易版框架

1. 概要

在日常实习开发中，反射基本其实是用不太到的。但是如果你想学习有些框架的底层原理或者自己写框架，那就需要学习反射了。考虑到反射相当抽象，所以本篇博客会先让整体介绍一下反射，然后逐步介绍他的基本使用，最后带着大家写一个入门案例，来帮助大家更好的理解反射。
什么是反射？？反射技术，指的是加载类的字节码到内存，并以编程的方法解刨出类中的各个成分（成员变量、方法、构造器等）。
一个我们常见的例子：平时我们用IDEA开发程序时，用对象调用方法，IDEA会有代码提示，idea会将这个对象能调用的方法都给你列举出来，供你选择，如果下图所示

问题是IDEA怎么知道这个对象有这些方法可以调用呢? 原因是对象能调用的方法全都来自于类，IDEA通过反射技术就可以获取到类中有哪些方法，并且把方法的名称以提示框的形式显示出来，所以你能看到这些提示了。那记事本写代码为什么没有提示呢? 因为技术本软件没有利用反射技术开发这种代码提示的功能。

2. 反射的基本使用

因为反射获取的是类的信息，那么反射的第一步首先获取到类才行。由于Java的设计原则是万物皆对象，获取到的类其实也是以对象的形式体现的，叫字节码对象，用Class类来表示。获取到字节码对象之后，再通过字节码对象就可以获取到类的组成成分了，这些组成成分其实也是对象，其中每一个成员变量用Field类的对象来表示、每一个成员方法用Method类的对象来表示，每一个构造器用Constructor类的对象来表示。如下图所示

2.1 获取类的字节码

反射的第一步：是将字节码加载到内存，我们需要获取到的字节码对象。

public class Test1Class{
    public static void main(String[] args){
        Class c1 = Student.class;
        System.out.println(c1.getName()); //获取全类名
        System.out.println(c1.getSimpleName()); //获取简单类名
        
        Class c2 = Class.forName("com.itheima.d2_reflect.Student");
        System.out.println(c1 == c2); //true
        
        Student s = new Student();
        Class c3 = s.getClass();
        System.out.println(c2 == c3); //true
    }
}

2.2 反射获取构造器

获取构造器，需要用到Class类提供的几个方法，如下图所示：

想要快速记住这个方法的区别，介绍这些方法的命名规律，按照规律来记就很方便了。

get:获取
Declared: 有这个单词表示可以获取任意一个，没有这个单词表示只能获取一个public修饰的
Constructor: 构造方法的意思
后缀s: 表示可以获取多个，没有后缀s只能获取一个

假设现在有一个Cat类，里面有几个构造方法，代码如下

public class Cat{
    private String name;
    private int age;
    
    public Cat(){
        
    }
    
    private Cat(String name, int age){
        
    }
}

接下来，我们写一个测试方法，来测试获取类中所有的构造器

public class Test2Constructor(){
    @Test
    public void testGetConstructors(){
        //1、反射第一步：必须先得到这个类的Class对象
        Class c = Cat.class;
        
        //2、获取类的全部构造器
        Constructor[] constructors = c.getDeclaredConstructors();
        //3、遍历数组中的每一个构造器对象。
        for(Constructor constructor: constructors){
            System.out.println(constructor.getName()+"---> 参数个数："+constructor.getParameterCount());
        }
    }
}

运行测试方法打印结果如下

刚才演示的是获取Cat类中所有的构造器，接下来，我们演示单个构造器试一试

public class Test2Constructor{
    @Test
    public void testGetConstructor(){
        //1、反射第一步：必须先得到这个类的Class对象
        Class c = Cat.class;
        
        //2、获取类public修饰的空参数构造器
        Constructor constructor1 = c.getConstructor();
        System.out.println(constructor1.getName()+"---> 参数个数："+constructor1.getParameterCount());
        
        //3、获取private修饰的有两个参数的构造器，第一个参数String类型，第二个参数int类型
        Constructor constructor2 = 
            c.getDeclaredConstructor(String.class,int.class);
        
        System.out.println(constructor2.getName()+"---> 参数个数："+constructor2.getParameterCount());

    }
}

打印结果如下

2.3 反射获取构造器的作用

获取到构造器后，有什么作用呢？

其实构造器的作用：初始化对象并返回。

这里我们需要用到如下的两个方法，注意：这两个方法时属于Constructor的，需要用Constructor对象来调用。

由于构造器是private修饰的，先需要调用setAccessible(true) 表示禁止检查访问控制，然后再调用newInstance(实参列表) 就可以执行构造器，完成对象的初始化了。

代码如下：为了看到构造器真的执行， 故意在两个构造器中分别加了两个打印语句

代码的执行结果如下图所示：

2.4 反射获取成员变量及其使用

在Class类中提供了获取成员变量的方法，如下图所示。

这些方法的记忆规则，如下

get:获取
Declared: 有这个单词表示可以获取任意一个，没有这个单词表示只能获取一个public修饰的
Field: 成员变量的意思
后缀s: 表示可以获取多个，没有后缀s只能获取一个

假设有一个Cat类它有若干个成员变量，用Class类提供 的方法将成员变量的对象获取出来。

执行完上面的代码之后，我们可以看到控制台上打印输出了，每一个成员变量的名称和它的类型。

获取到成员变量的对象之后该如何使用呢？
在Filed类中提供给给成员变量赋值和获取值的方法，如下图所示。

再次强调一下设置值、获取值的方法时Filed类的需要用Filed类的对象来调用，而且不管是设置值、还是获取值，都需要依赖于该变量所属的对象。代码如下

执行代码，控制台会有如下的打印

2.5 反射获取成员方法

Java中反射包中，每一个成员方法用Method对象来表示，通过Class类提供的方法可以获取类中的成员方法对象。如下下图所示

假设有一个Cat类，在Cat类中红有若干个成员方法

public class Cat{
    private String name;
    private int age;
    private void run(){
        System.out.println("(>^ω^<)喵跑得贼快~~");
    }

    public void eat(){
        System.out.println("(>^ω^<)喵爱吃猫粮~");
    }

    private String eat(String name){
        return "(>^ω^<)喵爱吃:"+name;
    }
    public Cat(){
        System.out.println("无参构造执行了~~~~");
    }

    private Cat(String name, int age){
        System.out.println("有参构造执行了~~~~");
        this.name=name;
        this.age=age;
    }

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

接下来，通过反射获取Cat类中所有的成员方法，每一个成员方法都是一个Method对象

public class Test3Method{
    public static void main(String[] args){
        //1、反射第一步：先获取到Class对象
        Class c = Cat.class;
        
        //2、获取类中的全部成员方法
        Method[] methods = c.getDeclaredMethods();
        
        //3、遍历这个数组中的每一个方法对象
        for(Method method : methods){
            System.out.println(method.getName()+"-->"+method.getParameterCount()+"-->"+method.getReturnType());
        }
    }
}

执行上面的代码，运行结果如下图所示：打印输出每一个成员方法的名称、参数格式、返回值类型

也能获取单个指定的成员方法，如下图所示

获取到成员方法之后，有什么作用呢？

在Method类中提供了方法，可以将方法自己执行起来。

把run()方法和eat(String name)方法执行起来。看分割线之下的代码

public class Test3Method{
    public static void main(String[] args){
        //1、反射第一步：先获取到Class对象
        Class c = Cat.class;
        
        //2、获取类中的全部成员方法
        Method[] methods = c.getDecalaredMethods();
        
        //3、遍历这个数组中的每一个方法对象
        for(Method method : methods){
            System.out.println(method.getName()+"-->"+method.getParameterCount()+"-->"+method.getReturnType());
        }
        
        System.out.println("-----------------------");
        //4、获取private修饰的run方法，得到Method对象
        Method run = c.getDecalaredMethod("run");
        //执行run方法,在执行前需要取消权限检查
        Cat cat = new Cat();
        run.setAccessible(true);
        Object rs1 = run.invoke(cat);
        System.out.println(rs1)
        
        //5、获取private 修饰的eat(String name)方法，得到Method对象
        Method eat = c.getDeclaredMethod("eat",String.class);
        eat.setAccessible(true);
        Object rs2 = eat.invoke(cat,"鱼儿");
        System.out.println(rs2)
    }
}

3. 基于反射手写简易版框架

接下来，我们就写一个简易的框架，简单窥探一下反射的应用。反射其实是非常强大的，这个案例也仅仅值小试牛刀。

需求：对于任意一个对象，该框架都可以把对象的字段名和对应的值，保存到文件当中去

分析一下该怎么做

1.先写好两个类，一个Student类和Teacher类
2.写一个ObjectFrame类代表框本架
在ObjectFrame类中定义一个saveObject(Object obj)方法，用于将任意对象存到文件中去
参数：Object obj: 就表示要存入文件中的对象

3.编写方法内部的代码，往文件中存储对象的属性名和属性值
1)参数obj对象中有哪些属性，属性名是什么实现值是什么，中有对象自己最清楚。
2)接着就通过反射获取类的成员变量信息了（变量名、变量值）
3)把变量名和变量值写到文件中去

写一个ObjectFrame表示自己设计的框架，代码如下图所示

public class ObjectFrame {
    public static void saveObject(Object obj) throws FileNotFoundException, IllegalAccessException {
    	//注意参数true表示追加
        PrintStream ps=new PrintStream(new FileOutputStream("E:\\test\\data.txt",true));
        Class c = obj.getClass(); //获取字节码
        ps.println("---------"+c.getSimpleName()+"---------");

        Field[] fields = c.getDeclaredFields(); //获取所有成员变量
        //3)把变量名和变量值写到文件中去
        for(Field field : fields){
        //取消访问权限限制
            field.setAccessible(true);
            String name = field.getName();
            Object value = field.get(obj)+"";
            ps.println(name+"="+value);
            System.out.println(name+"="+value);
        }
        ps.close();
    }
}

使用自己设计的框架，往文件中写入Student对象的信息和Teacher对象的信息。

先准备好Student类和Teacher类

public class Student{
    private String name;
    private int age;
    private char sex;
    private double height;
    private String hobby;
}

public class Cat{
    private String name;
    private double salary;
}

创建一个测试类，在测试中类创建一个Student对象，创建一个Teacher对象，用ObjectFrame的方法把这两个对象所有的属性名和属性值写到文件中去。

public class Application {
    public static void main(String[] args) throws FileNotFoundException, IllegalAccessException {
        Student s1 = new Student("坤坤",22, '男', 185.3, "唱、跳、rap、篮球");
        Cat s2 = new Cat("老王",999.9);
        ObjectFrame.saveObject(s1);
        ObjectFrame.saveObject(s2);
    }
}

打开data.txt文件，内容如下图所示，就说明我们这个框架的功能已经实现了