Java学习_反射

• 什么是反射？
  • 反射就是Reflection，Java的反射是指程序在运行期可以拿到一个对象的所有信息。
  • 反射是为了解决在运行期，对某个实例一无所知的情况下，如何调用其方法。
  • JAVA反射机制是在运行状态中，对于任何一个类，都能够知道这个类的所有属性和方法；对于任何一个对象，都能够调用它的任意方法和属性；这种动态获取信息以及动态调用对象方法的功能称为java语言的反射机制。
• Class类
  • class是由JVM在执行过程中动态加载的。JVM在第一次读取到一种class类型时，将其加载进内存。每加载一种class，JVM就为其创建一个Class类型的实例，并关联起来。注意：这里的Class类型是一个名叫Class的class。

    public final class Class {
        private Class() {}
    }

    以String类为例，当JVM加载String类时，它首先读取String.class文件到内存，然后，为String类创建一个Class实例并关联起来。

    Class cls = new Class(String);

    查看JDK源码，可以发现Class类的构造方法是private，只有JVM能创建Class实例，我们自己的Java程序是无法创建Class实例的。JVM持有的每个Class实例都指向一个数据类型（class或interface）。一个Class实例包含了该class的所有完整信息。

    ┌───────────────────────────┐
    │      Class Instance       │──────> String
    ├───────────────────────────┤
    │name = "java.lang.String"  │
    └───────────────────────────┘
    ┌───────────────────────────┐
    │      Class Instance       │──────> Random
    ├───────────────────────────┤
    │name = "java.util.Random"  │
    └───────────────────────────┘
    ┌───────────────────────────┐
    │      Class Instance       │──────> Runnable
    ├───────────────────────────┤
    │name = "java.lang.Runnable"│
    └───────────────────────────┘

    ┌───────────────────────────┐
    │      Class Instance       │──────> String
    ├───────────────────────────┤
    │name = "java.lang.String"  │
    ├───────────────────────────┤
    │package = "java.lang"      │
    ├───────────────────────────┤
    │super = "java.lang.Object" │
    ├───────────────────────────┤
    │interface = CharSequence...│
    ├───────────────────────────┤
    │field = value[],hash,...   │
    ├───────────────────────────┤
    │method = indexOf()...      │
    └───────────────────────────┘

  • JVM为每个加载的class创建了对应的Class实例，并在实例中保存了该class的所有信息，包括类名、包名、父类、实现的接口、所有方法、字段等，因此，如果获取了某个Class实例，我们就可以通过这个Class实例获取到该实例对应的class的所有信息。这种通过Class实例获取class信息的方法称为反射（Reflection）。

  • 获取一个class的Class实例，有三个方法。
    • 方法一：直接通过一个class的静态变量class获取。

      Class cls = String.class;

    • 如果有一个实例变量，可以通过该实例变量提供的getClass()方法获取。

      String s = "Hello";
      Class cls = s.getClass();

    • 如果知道一个class的完整类名，可以通过静态方法Class.forName()获取。

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

  • Class实例在JVM中是唯一的，所以，上述方法获取的Class实例是同一个实例。可以用==比较两个Class实例。

    Integer n = new Integer(123);
    
    boolean b1 = n instanceof Integer; // true，因为n是Integer类型
    boolean b2 = n instanceof Number; // true，因为n是Number类型的子类
    
    boolean b3 = n.getClass() == Integer.class; // true，因为n.getClass()返回Integer.class
    boolean b4 = n.getClass() == Number.class; // false，因为Integer.class!=Number.class

    用instanceof不但匹配指定类型，还匹配指定类型的子类。而用==判断class实例可以精确地判断数据类型，但不能作子类型比较。通常情况下，我们应该用instanceof判断数据类型，因为面向抽象编程的时候，我们不关心具体的子类型。只有在需要精确判断一个类型是不是某个class的时候，我们才使用==判断class实例。

  • 从Class实例获取获取的基本信息。

     1 public class Main {
     2     public static void main(String[] args) {
     3         printClassInfo("".getClass());
     4         printClassInfo(Runnable.class);
     5         printClassInfo(java.time.Month.class);
     6         printClassInfo(String[].class);
     7         printClassInfo(int.class);
     8     }
     9
    10     static void printClassInfo(Class cls) {
    11         System.out.println("Class name: " + cls.getName());
    12         System.out.println("Simple name: " + cls.getSimpleName());
    13         if (cls.getPackage() != null) {
    14             System.out.println("Package name: " + cls.getPackage().getName());
    15         }
    16         System.out.println("is interface: " + cls.isInterface());
    17         System.out.println("is enum: " + cls.isEnum());
    18         System.out.println("is array: " + cls.isArray());
    19         System.out.println("is primitive: " + cls.isPrimitive());
    20     }
    21 }

  • 获取到了一个Class实例，可以通过该Class实例来创建对应类型的实例。

    // 获取String的Class实例:
    Class cls = String.class;
    // 创建一个String实例:
    String s = (String) cls.newInstance();

    上述代码相当于new String()。通过Class.newInstance()可以创建类实例，它的局限是：只能调用public的无参数构造方法。带参数的构造方法，或者非public的构造方法都无法通过Class.newInstance()被调用。

  • 动态加载

    • JVM在执行Java程序的时候，并不是一次性把所有用到的class全部加载到内存，而是第一次需要用到class时才加载。　

• 访问字段

  • Class类提供了以下几个方法来获取字段：

    • Field getField(name)：根据字段名获取某个public的field（包括父类）
    • Field getDeclaredField(name)：根据字段名获取当前类的某个field（不包括父类）
    • Field[] getFields()：获取所有public的field（包括父类）
    • Field[] getDeclaredFields()：获取当前类的所有field（不包括父类）

       1 public class Main {
       2     public static void main(String[] args) throws Exception {
       3         Class stdClass = Student.class;
       4         // 获取public字段"score":
       5         System.out.println(stdClass.getField("score"));
       6         // 获取继承的public字段"name":
       7         System.out.println(stdClass.getField("name"));
       8         // 获取private字段"grade":
       9         System.out.println(stdClass.getDeclaredField("grade"));
      10     }
      11 }
      12
      13 class Student extends Person {
      14     public int score;
      15     private int grade;
      16 }
      17
      18 class Person {
      19     public String name;
      20 }

  • 一个Field对象包含了一个字段的所有信息：

    • getName()：返回字段名称，例如，"name"；
    • getType()：返回字段类型，也是一个Class实例，例如，String.class；
    • getModifiers()：返回字段的修饰符，它是一个int，不同的bit表示不同的含义。

    • 以String类的value字段为例，它的定义是：

      public final class String {
          private final byte[] value;
      }

      用反射获取该字段的信息：

      Field f = String.class.getDeclaredField("value");
      f.getName(); // "value"
      f.getType(); // class [B 表示byte[]类型
      int m = f.getModifiers();
      Modifier.isFinal(m); // true
      Modifier.isPublic(m); // false
      Modifier.isProtected(m); // false
      Modifier.isPrivate(m); // true
      Modifier.isStatic(m); // false

  • 获取字段值

    • 利用反射拿到字段的一个Field实例只是第一步，还可以拿到一个实例对应的该字段的值。例如，对于一个Person实例，可以先拿到name字段对应的Field，再获取这个实例的name字段的值。

       1 import java.lang.reflect.Field;
       2
       3 public class Main {
       4
       5     public static void main(String[] args) throws Exception {
       6         Object p = new Person("Xiao Ming");
       7         Class c = p.getClass();
       8         Field f = c.getDeclaredField("name");
                 f.setAccessible(true);
       9         Object value = f.get(p);
      10         System.out.println(value); // "Xiao Ming"
      11     }
      12 }
      13
      14 class Person {
      15     private String name;
      16
      17     public Person(String name) {
      18         this.name = name;
      19     }
      20 }

       

  • 设置字段值

    • 设置字段值是通过Field.set(Object, Object)实现的，其中第一个Object参数是指定的实例，第二个Object参数是待修改的值。

       1 import java.lang.reflect.Field;
       2
       3 public class Main {
       4
       5     public static void main(String[] args) throws Exception {
       6         Person p = new Person("Xiao Ming");
       7         System.out.println(p.getName()); // "Xiao Ming"
       8         Class c = p.getClass();
       9         Field f = c.getDeclaredField("name");
      10         f.setAccessible(true);
      11         f.set(p, "Xiao Hong");
      12         System.out.println(p.getName()); // "Xiao Hong"
      13     }
      14 }
      15
      16 class Person {
      17     private String name;
      18
      19     public Person(String name) {
      20         this.name = name;
      21     }
      22
      23     public String getName() {
      24         return this.name;
      25     }
      26 }

  • Java的反射API提供的Field类封装了字段的所有信息：
    • 通过Class实例的方法可以获取Field实例：getField()，getFields()，getDeclaredField()，getDeclaredFields()；
    • 通过Field实例可以获取字段信息：getName()，getType()，getModifiers()；
    • 通过Field实例可以读取或设置某个对象的字段，如果存在访问限制，要首先调用setAccessible(true)来访问非public字段。
    • 通过反射读写字段是一种非常规方法，它会破坏对象的封装。
• 调用方法

  • Class类提供了以下几个方法来获取Method：

    • Method getMethod(name, Class...)：获取某个public的Method（包括父类）
    • Method getDeclaredMethod(name, Class...)：获取当前类的某个Method（不包括父类）
    • Method[] getMethods()：获取所有public的Method（包括父类）
    • Method[] getDeclaredMethods()：获取当前类的所有Method（不包括父类）

       1 public class Main {
       2     public static void main(String[] args) throws Exception {
       3         Class stdClass = Student.class;
       4         // 获取public方法getScore，参数为String:
       5         System.out.println(stdClass.getMethod("getScore", String.class));
       6         // 获取继承的public方法getName，无参数:
       7         System.out.println(stdClass.getMethod("getName"));
       8         // 获取private方法getGrade，参数为int:
       9         System.out.println(stdClass.getDeclaredMethod("getGrade", int.class));
      10     }
      11 }
      12
      13 class Student extends Person {
      14     public int getScore(String type) {
      15         return 99;
      16     }
      17     private int getGrade(int year) {
      18         return 1;
      19     }
      20 }
      21
      22 class Person {
      23     public String getName() {
      24         return "Person";
      25     }
      26 }

    • 一个Method对象包含一个方法的所有信息：

      • getName()：返回方法名称，例如："getScore"；
      • getReturnType()：返回方法返回值类型，也是一个Class实例，例如：String.class；
      • getParameterTypes()：返回方法的参数类型，是一个Class数组，例如：{String.class, int.class}；
      • getModifiers()：返回方法的修饰符，它是一个int，不同的bit表示不同的含义。
    • 如果用反射来调用substring方法。

       1 import java.lang.reflect.Method;
       2
       3 public class Main {
       4     public static void main(String[] args) throws Exception {
       5         // String对象:
       6         String s = "Hello world";
       7         // 获取String substring(int)方法，参数为int:
       8         Method m = String.class.getMethod("substring", int.class);
       9         // 在s对象上调用该方法并获取结果:
      10         String r = (String) m.invoke(s, 6);
      11         // 打印调用结果:
      12         System.out.println(r);
      13     }
      14 }

  • 调用静态方法

    • 如果获取到的Method表示一个静态方法，调用静态方法时，由于无需指定实例对象，所以invoke方法传入的第一个参数永远为null。以Integer.parseInt(String)为例。

       1 import java.lang.reflect.Method;
       2
       3 public class Main {
       4     public static void main(String[] args) throws Exception {
       5         // 获取Integer.parseInt(String)方法，参数为String:
       6         Method m = Integer.class.getMethod("parseInt", String.class);
       7         // 调用该静态方法并获取结果:
       8         Integer n = (Integer) m.invoke(null, "12345");
       9         // 打印调用结果:
      10         System.out.println(n);
      11     }
      12 }

  • 调用非public方法

    • 和Field类似，对于非public方法，虽然可以通过Class.getDeclaredMethod()获取该方法实例，但直接对其调用将得到一个IllegalAccessException。为了调用非public方法，通过Method.setAccessible(true)允许其调用。

      import java.lang.reflect.Method;
      
      public class Main {
          public static void main(String[] args) throws Exception {
              Person p = new Person();
              Method m = p.getClass().getDeclaredMethod("setName", String.class);
              m.setAccessible(true);
              m.invoke(p, "Bob");
              System.out.println(p.name);
          }
      }
      
      class Person {
          String name;
          private void setName(String name) {
              this.name = name;
          }
      }

  • 多态

    • 一个Person类定义了hello()方法，并且它的子类Student也覆写了hello()方法，那么，从Person.class获取的Method，作用于Student实例时（如下）。结果可知使用反射调用方法时，仍然遵循多态原则：即总是调用实际类型的覆写方法（如果存在）。　

       1 import java.lang.reflect.Method;
       2
       3 public class Main {
       4     public static void main(String[] args) throws Exception {
       5         // 获取Person的hello方法:
       6         Method h = Person.class.getMethod("hello");
       7         // 对Student实例调用hello方法:
       8         h.invoke(new Student());
       9     }
      10 }
      11
      12 class Person {
      13     public void hello() {
      14         System.out.println("Person:hello");
      15     }
      16 }
      17
      18 class Student extends Person {
      19     public void hello() {
      20         System.out.println("Student:hello");
      21     }
      22 }

      通过设置setAccessible(true)来访问非public方法；

• 调用构造方法

  • 通过反射来创建新的实例，可以调用Class提供的newInstance()方法：

    Person p = Person.class.newInstance();

    调用Class.newInstance()的局限是，它只能调用该类的public无参数构造方法。如果构造方法带有参数，或者不是public，就无法直接通过Class.newInstance()来调用。

  • 为了调用任意的构造方法，Java的反射API提供了Constructor对象，它包含一个构造方法的所有信息，可以创建一个实例。Constructor对象和Method非常类似，不同之处仅在于它是一个构造方法，并且，调用结果总是返回实例。

     1 import java.lang.reflect.Constructor;
     2
     3 public class Main {
     4     public static void main(String[] args) throws Exception {
     5         // 获取构造方法Integer(int):
     6         Constructor cons1 = Integer.class.getConstructor(int.class);
     7         // 调用构造方法:
     8         Integer n1 = (Integer) cons1.newInstance(123);
     9         System.out.println(n1);
    10
    11         // 获取构造方法Integer(String)
    12         Constructor cons2 = Integer.class.getConstructor(String.class);
    13         Integer n2 = (Integer) cons2.newInstance("456");
    14         System.out.println(n2);
    15     }
    16 }

  • 通过Class实例获取Constructor的方法

    • getConstructor(Class...)：获取某个public的Constructor；
    • getDeclaredConstructor(Class...)：获取某个Constructor；
    • getConstructors()：获取所有public的Constructor；
    • getDeclaredConstructors()：获取所有Constructor。

    注意Constructor总是当前类定义的构造方法，和父类无关，因此不存在多态的问题。

    调用非public的Constructor时，必须首先通过setAccessible(true)设置允许访问。setAccessible(true)可能会失败。

• 获取继承关系

  • 有了Class实例，还可以获取它的父类的Class。

    public class Main {
        public static void main(String[] args) throws Exception {
            Class i = Integer.class;
            Class n = i.getSuperclass();
            System.out.println(n);
            Class o = n.getSuperclass();
            System.out.println(o);
            System.out.println(o.getSuperclass());
        }
    }

  • 由于一个类可能实现一个或多个接口，通过Class可以查询到实现的接口类型。

    import java.lang.reflect.Method;
    
    public class Main {
        public static void main(String[] args) throws Exception {
            Class s = Integer.class;
            Class[] is = s.getInterfaces();
            for (Class i : is) {
                System.out.println(i);
            }
        }
    }

    getInterfaces()只返回当前类直接实现的接口类型，并不包括其父类实现的接口类型。对所有interface的Class调用getSuperclass()返回的是null，获取接口的父接口要用getInterfaces()。如果一个类没有实现任何interface，那么getInterfaces()返回空数组。

  • 判断一个实例是否是某个类型时，正常情况下，使用instanceof操作符，如果是两个Class实例，要判断一个向上转型是否成立，可以调用isAssignableFrom()。

    // Integer i = ?
    Integer.class.isAssignableFrom(Integer.class); // true，因为Integer可以赋值给Integer
    // Number n = ?
    Number.class.isAssignableFrom(Integer.class); // true，因为Integer可以赋值给Number
    // Object o = ?
    Object.class.isAssignableFrom(Integer.class); // true，因为Integer可以赋值给Object
    // Integer i = ?
    Integer.class.isAssignableFrom(Number.class); // false，因为Number不能赋值给Integer