# Java基础 反射篇 反射是一个非常重要的知识点，在学习`Spring 框架`时，Bean的初始化用到了反射，在``破坏单例模式``时也用到了反射，在`获取标注的注解`时也会用到反射······ 当然了，反射在日常开发中，我们没碰到过多少，至少我没怎么用过。但面试是**造火箭**现场，可爱的面试官们又怎会轻易地放过我们呢？反射是开源框架中的一个重要设计理念，在源码分析中少不了它的身影，所以，今天我会尽量用浅显易懂的语言，让你去理解下面这几点： （1）反射的思想以及它的作用​ :point_right: **概念篇** （2）反射的基本使用及应用场景 :point_right: **应用篇** （3）使用反射能给我们编码时带来的优势以及存在的缺陷 :point_right: **分析篇** ## 反射的思想及作用 有反必有正，就像世间的阴和阳，计算机的0和1一样。天道有轮回，苍天...~~（净会在这瞎bibi）~~ 在学习反射之前，先来了解**正射**是什么。我们平常用的最多的 `new` 方式实例化对象的方式就是一种正射的体现。假如我需要实例化一个`HashMap`，代码就会是这样子。 ```java Map map = new HashMap<>(); map.put(1, 1); ``` 某一天发现，该段程序不适合用 HashMap 存储键值对，更倾向于用`LinkedHashMap`存储。重新编写代码后变成下面这个样子。 ```java Map map = new LinkedHashMap<>(); map.put(1, 1); ``` 假如又有一天，发现数据还是适合用 HashMap来存储，难道又要重新修改源码吗？ > 发现问题了吗？我们每次改变一种需求，都要去重新**修改源码**，然后对代码进行编译，打包，再到 JVM 上重启项目。这么些步骤下来，效率非常低。  对于这种**需求频繁变更但变更不大**的场景，频繁地更改源码肯定是一种不允许的操作，我们可以使用一个`开关`，判断什么时候使用哪一种数据结构。 ```java public Map getMap(String param) { Map map = null; if (param.equals("HashMap")) { map = new HashMap<>(); } else if (param.equals("LinkedHashMap")) { map = new LinkedHashMap<>(); } else if (param.equals("WeakHashMap")) { map = new WeakHashMap<>(); } return map; } ``` 通过传入参数`param`决定使用哪一种数据结构，可以在项目运行时，通过**动态传入参数**决定使用哪一个数据结构。 如果某一天还想用`TreeMap`，还是避免不了修改源码，重新编译执行的弊端。这个时候，**反射**就派上用场了。 在代码运行之前，我们**不确定**将来会使用哪一种数据结构，只有在程序**运行时才决定**使用哪一个数据类，而`反射`可以在**程序运行过程**中动态**获取类信息**和**调用类方法**。通过反射构造类实例，代码会演变成下面这样。 ```java public Map getMap(String className) { Class clazz = Class.forName(className); Consructor con = clazz.getConstructor(); return (Map) con.newInstance(); } ``` 无论使用什么 Map，只要实现了`Map接口`，就可以使用`全类名路径`传入到方法中，获得对应的 Map 实例。例如java.util.HashMap / java.util.LinkedHashMap····如果要创建其它类例如`WeakHashMap`，我也**不需要修改上面这段源码**。 我们来回顾一下如何从 `new` 一个对象引出使用`反射`的。 - 在不使用反射时，构造对象使用 new 方式实现，这种方式在**编译期**就可以把对象的类型确定下来。 - 如果需求发生变更，需要构造另一个对象，则需要修改源码，非常不优雅，所以我们通过使用`开关`，在程序运行时判断需要构造哪一个对象，在运行时可以**变更开关**来实例化不同的数据结构。 - 如果还有其它扩展的类有可能被使用，就会创建出**非常多的分支**，且在编码时不知道有什么其他的类被使用到，假如日后`Map`接口下多了一个集合类是`xxxHashMap`，还得创建分支，此时引出了反射：可以在`运行时`才确定使用哪一个数据类，在切换类时，无需重新修改源码、编译程序。 第一章总结： - 反射的**思想**：**在程序运行过程中确定和解析数据类的类型。** - 反射的**作用**：对于在`编译期`无法确定使用哪个数据类的场景，通过`反射`可以在程序运行时**构造出不同的数据类实例**。 ## 反射的基本使用 Java 反射的主要组成部分有4个： - `Class`：任何运行在内存中的所有类都是该 Class 类的实例对象，每个 Class 类对象内部都包含了本来的**所有信息**。记着一句话，通过反射干任何事，先找 Class 准没错！ - `Field`：描述一个类的**属性**，内部包含了该属性的所有信息，例如**数据类型，属性名，访问修饰符**······ - `Constructor`：描述一个类的**构造方法**，内部包含了构造方法的所有信息，例如**参数类型，参数名字，访问修饰符**······ - `Method`：描述一个类的**所有方法**（包括抽象方法），内部包含了该方法的所有信息，与`Constructor`类似，不同之处是 Method 拥有**返回值类型**信息，因为构造方法是没有返回值的。 我总结了一张脑图，放在了下面，如果用到了反射，离不开这核心的`4`个类，只有去了解它们内部提供了哪些信息，有什么作用，运用它们的时候才能**易如反掌**。  我们在学习反射的基本使用时，我会用一个`SmallPineapple`类作为模板进行说明，首先我们先来熟悉这个类的基本组成：**属性，构造函数和方法** ```java public class SmallPineapple { public String name; public int age; private double weight; // 体重只有自己知道 public SmallPineapple() {} public SmallPineapple(String name, int age) { this.name = name; this.age = age; } public void getInfo() { System.out.print("["+ name + " 的年龄是：" + age + "]"); } } ``` 反射中的用法有非常非常多，常见的功能有以下这几个： - 在运行时获取一个类的 **Class 对象** - 在运行时构造一个类的**实例化对象** - 在运行时获取一个类的所有信息：**变量、方法、构造器、注解** ### 获取类的 Class 对象 在 Java 中，每一个类都会有专属于自己的 Class 对象，当我们编写完`.java`文件后，使用`javac`编译后，就会产生一个字节码文件`.class`，在字节码文件中包含类的所有信息，如`属性`，`构造方法`，`方法`······当字节码文件被装载进虚拟机执行时，会在内存中生成 Class 对象，它包含了该类内部的所有信息，在程序运行时可以获取这些信息。 获取 Class 对象的方法有`3`种： - `类名.class`：这种获取方式只有在`编译`前已经声明了该类的类型才能获取到 Class 对象 ```java Class clazz = SmallPineapple.class; ``` - `实例.getClass()`：通过实例化对象获取该实例的 Class 对象 ```java SmallPineapple sp = new SmallPineapple(); Class clazz = sp.getClass(); ``` - `Class.forName(className)`：通过类的**全限定名**获取该类的 Class 对象 ```java Class clazz = Class.forName("com.bean.smallpineapple"); ``` 拿到 `Class`对象就可以对它为所欲为了：剥开它的皮（获取**类信息**）、指挥它做事（调用它的**方法**），看透它的一切（获取**属性**），总之它就没有隐私了。 不过在程序中，每个类的 Class 对象只有一个，也就是说你只有这一个`奴隶`。我们用上面三种方式测试，通过三种方式打印各个 `Class` 对象都是相同的。 ```java Class clazz1 = Class.forName("com.bean.SmallPineapple"); Class clazz2 = SmallPineapple.class; SmallPineapple instance = new SmallPineapple(); Class clazz3 = instance.getClass(); System.out.println("Class.forName() == SmallPineapple.class:" + (clazz1 == clazz2)); System.out.println("Class.forName() == instance.getClass():" + (clazz1 == clazz3)); System.out.println("instance.getClass() == SmallPineapple.class:" + (clazz2 == clazz3)); ```  > 内存中只有一个 Class 对象的原因要牵扯到 `JVM 类加载机制`的`双亲委派模型`，它保证了程序运行时，`加载类`时每个类在内存中仅会产生一个`Class对象`。在这里我不打算详细展开说明，可以简单地理解为 JVM 帮我们保证了**一个类在内存中至多存在一个 Class 对象**。 ### 构造类的实例化对象 通过反射构造一个类的实例方式有`2`种： - Class 对象调用`newInstance()`方法 ```java Class clazz = Class.forName("com.bean.SmallPineapple"); SmallPineapple smallPineapple = (SmallPineapple) clazz.newInstance(); smallPineapple.getInfo(); // [null 的年龄是：0] ``` 即使 SmallPineapple 已经显式定义了构造方法，通过 newInstance() 创建的实例中，所有属性值都是对应类型的`初始值`，因为 newInstance() 构造实例会**调用默认无参构造器**。 - Constructor 构造器调用`newInstance()`方法 ```java Class clazz = Class.forName("com.bean.SmallPineapple"); Constructor constructor = clazz.getConstructor(String.class, int.class); constructor.setAccessible(true); SmallPineapple smallPineapple2 = (SmallPineapple) constructor.newInstance("小菠萝", 21); smallPineapple2.getInfo(); // [小菠萝 的年龄是：21] ``` 通过 getConstructor(Object... paramTypes) 方法指定获取**指定参数类型**的 Constructor， Constructor 调用 newInstance(Object... paramValues) 时传入构造方法参数的值，同样可以构造一个实例，且内部属性已经被赋值。 通过`Class`对象调用 newInstance() 会走**默认无参构造方法**，如果想通过**显式构造方法**构造实例，需要提前从Class中调用`getConstructor()`方法获取对应的构造器，通过构造器去实例化对象。 > 这些 API 是在开发当中最常遇到的，当然还有非常多重载的方法，本文由于篇幅原因，且如果每个方法都一一讲解，我们也记不住，所以用到的时候去类里面查找就已经足够了。 ### 获取一个类的所有信息 **Class 对象中包含了该类的所有信息，在编译期我们能看到的信息就是该类的变量、方法、构造器，在运行时最常被获取的也是这些信息。**  ### 获取类中的变量（Field） - Field[] getFields()：获取类中所有被`public`修饰的所有变量 - Field getField(String name)：根据**变量名**获取类中的一个变量，该**变量必须被public修饰** - Field[] getDeclaredFields()：获取类中所有的变量，但**无法获取继承下来的变量** - Field getDeclaredField(String name)：根据姓名获取类中的某个变量，**无法获取继承下来的变量** ### 获取类中的方法（Method） - Method[] getMethods()：获取类中被`public`修饰的所有方法 - Method getMethod(String name, Class...> paramTypes)：根据**名字和参数类型**获取对应方法，该方法必须被`public`修饰 - Method[] getDeclaredMethods()：获取`所有`方法，但**无法获取继承下来的方法** - Method getDeclaredMethod(String name, Class...> paramTypes)：根据**名字和参数类型**获取对应方法，**无法获取继承下来的方法** ### 获取类的构造器（Constructor） - Constuctor[] getConstructors()：获取类中所有被`public`修饰的构造器 - Constructor getConstructor(Class...> paramTypes)：根据`参数类型`获取类中某个构造器，该构造器必须被`public`修饰 - Constructor[] getDeclaredConstructors()：获取类中所有构造器 - Constructor getDeclaredConstructor(class...> paramTypes)：根据`参数类型`获取对应的构造器 每种功能内部以 Declared 细分为`2`类： > 有`Declared`修饰的方法：可以获取该类内部包含的**所有**变量、方法和构造器，但是**无法获取继承下来的信息** > > 无`Declared`修饰的方法：可以获取该类中`public`修饰的变量、方法和构造器，可**获取继承下来的信息** 如果想获取类中**所有的（包括继承）**变量、方法和构造器，则需要同时调用`getXXXs()`和`getDeclaredXXXs()`两个方法，用`Set`集合存储它们获得的变量、构造器和方法，以防两个方法获取到相同的东西。 例如：要获取SmallPineapple获取类中**所有的变量**，代码应该是下面这样写。 ```java Class clazz = Class.forName("com.bean.SmallPineapple"); // 获取 public 属性，包括继承 Field[] fields1 = clazz.getFields(); // 获取所有属性，不包括继承 Field[] fields2 = clazz.getDeclaredFields(); // 将所有属性汇总到 set Set allFields = new HashSet<>(); allFields.addAll(Arrays.asList(fields1)); allFields.addAll(Arrays.asList(fields2)); ``` > 不知道你有没有发现一件**有趣的事情**，如果父类的属性用`protected`修饰，利用反射是**无法获取到**的。 > > protected 修饰符的作用范围：只允许`同一个包下`或者`子类`访问，可以继承到子类。 > > getFields() 只能获取到本类的`public`属性的变量值； > > getDeclaredFields() 只能获取到**本类的所有属性，不包括继承**的；无论如何都获取不到父类的 protected 属性修饰的变量，但是它的的确确存在于子类中。 ### 获取注解 **获取注解单独拧了出来，因为它并不是专属于 Class 对象的一种信息，每个变量，方法和构造器都可以被注解修饰，所以在反射中，Field，Constructor 和 Method 类对象都可以调用下面这些方法获取标注在它们之上的注解。** - Annotation[] getAnnotations()：获取该对象上的**所有注解** - Annotation getAnnotation(Class annotaionClass)：传入`注解类型`，获取该对象上的特定一个注解 - Annotation[] getDeclaredAnnotations()：获取该对象上的显式标注的所有注解，无法获取`继承`下来的注解 - Annotation getDeclaredAnnotation(Class annotationClass)：根据`注解类型`，获取该对象上的特定一个注解，无法获取`继承`下来的注解 只有注解的`@Retension`标注为`RUNTIME`时，才能够通过反射获取到该注解，@Retension 有`3`种保存策略： - `SOURCE`：只在**源文件(.java)**中保存，即该注解只会保留在源文件中，**编译时编译器会忽略该注解**，例如 @Override 注解 - `CLASS`：保存在**字节码文件(.class)**中，注解会随着编译跟随字节码文件中，但是**运行时**不会对该注解进行解析 - `RUNTIME`：一直保存到**运行时**，**用得最多的一种保存策略**，在运行时可以获取到该注解的所有信息 像下面这个例子，SmallPineapple 类继承了抽象类`Pineapple`，`getInfo()`方法上标识有 @Override 注解，且在子类中标注了`@Transient`注解，在运行时获取子类重写方法上的所有注解，只能获取到`@Transient`的信息。 ```java public abstract class Pineapple { public abstract void getInfo(); } public class SmallPineapple extends Pineapple { @Transient @Override public void getInfo() { System.out.print("小菠萝的身高和年龄是:" + height + "cm ; " + age + "岁"); } } ``` 启动类`Bootstrap`获取 SmallPineapple 类中的 getInfo() 方法上的注解信息： ```java public class Bootstrap { /** * 根据运行时传入的全类名路径判断具体的类对象 * @param path 类的全类名路径 */ public static void execute(String path) throws Exception { Class obj = Class.forName(path); Method method = obj.getMethod("getInfo"); Annotation[] annotations = method.getAnnotations(); for (Annotation annotation : annotations) { System.out.println(annotation.toString()); } } public static void main(String[] args) throws Exception { execute("com.pineapple.SmallPineapple"); } } // @java.beans.Transient(value=true) ``` ### 通过反射调用方法 通过反射获取到某个 Method 类对象后，可以通过调用`invoke`方法执行。 - `invoke(Oject obj, Object... args)`：参数``1`指定调用该方法的**对象**，参数`2`是方法的参数列表值。 如果调用的方法是**静态方法**，参数1只需要传入`null`，因为静态方法不与某个对象有关，只与某个类有关。 可以像下面这种做法，通过反射实例化一个对象，然后获取`Method`方法对象，调用`invoke()`指定`SmallPineapple`的`getInfo()`方法。 ```java Class clazz = Class.forName("com.bean.SmallPineapple"); Constructor constructor = clazz.getConstructor(String.class, int.class); constructor.setAccessible(true); SmallPineapple sp = (SmallPineapple) constructor.newInstance("小菠萝", 21); Method method = clazz.getMethod("getInfo"); if (method != null) { method.invoke(sp, null); } // [小菠萝的年龄是：21] ``` ## 反射的应用场景 反射常见的应用场景这里介绍`3`个： - Spring 实例化对象：当程序启动时，Spring 会读取配置文件`applicationContext.xml`并解析出里面所有的 标签实例化到`IOC`容器中。 - 反射 + 工厂模式：通过`反射`消除工厂中的多个分支，如果需要生产新的类，无需关注工厂类，工厂类可以应对各种新增的类，`反射`可以使得程序更加健壮。 - JDBC连接数据库：使用JDBC连接数据库时，指定连接数据库的`驱动类`时用到反射加载驱动类 ### Spring 的 IOC 容器 在 Spring 中，经常会编写一个上下文配置文件`applicationContext.xml`，里面就是关于`bean`的配置，程序启动时会读取该 xml 文件，解析出所有的 ``标签，并实例化对象放入`IOC`容器中。 ```xml ``` 在定义好上面的文件后，通过`ClassPathXmlApplicationContext`加载该配置文件，程序启动时，Spring 会将该配置文件中的所有`bean`都实例化，放入 IOC 容器中，IOC 容器本质上就是一个工厂，通过该工厂传入 \ 标签的`id`属性获取到对应的实例。 ```java public class Main { public static void main(String[] args) { ApplicationContext ac = new ClassPathXmlApplicationContext("applicationContext.xml"); SmallPineapple smallPineapple = (SmallPineapple) ac.getBean("smallpineapple"); smallPineapple.getInfo(); // [小菠萝的年龄是：21] } } ``` Spring 在实例化对象的过程经过简化之后，可以理解为反射实例化对象的步骤： - **获取Class对象的构造器** - 通过构造器**调用 newInstance()** 实例化对象 当然 Spring 在实例化对象时，做了非常多额外的操作，才能够让现在的开发足够的**便捷且稳定**。 > 在之后的文章中会专门写一篇文章讲解如何利用反射实现一个`简易版`的`IOC`容器，IOC容器原理很简单，只要掌握了反射的思想，了解反射的常用 API 就可以实现，我可以提供一个简单的思路：利用 HashMap 存储所有实例，key 代表 \ 标签的 `id`，value 存储对应的实例，这对应了 Spring IOC容器管理的对象默认是**单例**的。 ### 反射 + 抽象工厂模式 传统的工厂模式，如果需要生产新的子类，**需要修改工厂类，在工厂类中增加新的分支**； ```java public class MapFactory { public Map