Java学习之反射机制

以你之姓@ 2023-03-01 11:40 33阅读 0赞

## Java高级之反射 ##

> Java反射机制是在程序的运行状态中，可以获取类或者对象的信息，包括对象所属的类，类的成员变量和方法，对象的属性和方法。

基本使用涉及到的类：`Class类`、`Constructor类`(构造方法)、`Method类`(普通方法)、`Field类`(属性字段)。

#### 一、获取类对象。 ####

> `Java`是一门`面向对象`的语言，所以通常使用的类也是对象，是特殊的类Class 的对象。`Class` 没有公共构造方法，`Class` 类的实例表示正在运行的 Java 应用程序中的类和接口。所有具有相同元素类型和维数的数组都共享该 `Class` 对象。基本的 Java 类型（`boolean`、`byte`、`char`、`short`、`int`、`long`、`float` 和 `double`）和关键字 `void` 也表示为 `Class` 对象

1.  测试类Student

class Student{
        
        private int age;
        private String name;
        public long id = System.currentTimeMillis();
        
        Student(){
        }
        public Student(int age){
        
            this.age = age;
        }
        
        Student(String name,int age){
        
            this.name = name;
            this.age = age;
        }
        
        private Student(String name){
        
            this.name = name;
        }
    
        public int getAge() {
        
            return age;
        }
    
        public void setAge(int age) {
        
            this.age = age;
        }
    
        public void prints(){
        
            System.out.println("lalala");
            print();
        }
        private void print(){
        
            System.out.println("hahah");
        }
    }

1.  获取其Class的对象.

//获取类对象
    //  第一种方法,实例化Student对象并使用其getClass方法获取
    Student stu = new Student("test",18);
    Class c1 = stu.getClass();
    // 第二种方法，直接通过类调用静态class属性。
    Class c2 = Student.class;
    // 第三种方法(最常用的方法),使用ClassS类的forName方法，参数为完整的类名路径。(包含包名)，会有ClassNotFoundException异常出现。
    Class c3 = Class.forName("Test.Student");

**注意**：

**三种方式获取的Class对象是同一个对象，即使是通过Student的实例化对象获取的Class对象，得到的Class对象均是同一个。即相同类的Class对象只有一个。**

#### 二、获取类的构造方法 ####

1.  方法介绍

<table> 
 <thead> 
  <tr> 
   <th align="left">方法名</th> 
   <th align="center">返回值</th> 
   <th align="center">函数参数</th> 
   <th align="left">作用</th> 
   <th align="left">异常</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left"><code>getConstructor(Class&lt;?&gt;...param)</code></td> 
   <td align="center"><code>Constructor对象</code></td> 
   <td align="center">公共构造方法参数类型的类对象，作为标识如：<code>String.class</code>等</td> 
   <td align="left">按照参数类型返回特定的公共构造方法。</td> 
   <td align="left"><code>NoSuchMethodException</code>匹配不到构造方法</td> 
  </tr> 
  <tr> 
   <td align="left"><code>getConstructors()</code></td> 
   <td align="center"><code>Constructor[]</code></td> 
   <td align="center">无</td> 
   <td align="left">返回该类的所有公共构造方法。</td> 
   <td align="left">无</td> 
  </tr> 
  <tr> 
   <td align="left"><code>getDeclaredConstructor(Class&lt;?&gt;...param)</code></td> 
   <td align="center"><code>Constructor对象</code></td> 
   <td align="center">构造方法参数类型的类对象，作为标识如：<code>String.class</code>等</td> 
   <td align="left">根据参数返回指定的构造方法</td> 
   <td align="left"><code>NoSuchMethodException</code>匹配不到构造方法</td> 
  </tr> 
  <tr> 
   <td align="left"><code>getDeclaredConstructors()</code></td> 
   <td align="center"><code>Constructor[]</code></td> 
   <td align="center">无</td> 
   <td align="left">返回该类声明的所有构造方法。</td> 
   <td align="left">无</td> 
  </tr> 
 </tbody> 
</table>

1.  代码演示

try {
        
        Class clazz = Class.forName("Test.Student");
    
        System.out.println("----------------------------getConstructor方法");
        Constructor c1 = clazz.getConstructor(int.class);
        System.out.println(c1);
    
        System.out.println("----------------------------getConstructors方法");
        Constructor[] c2 = clazz.getConstructors();
        for(Constructor c : c2){
        
            System.out.println(c);
        }
    
        System.out.println("----------------------------getDeclaredConstructor方法");
        Constructor c3 = clazz.getDeclaredConstructor(String.class,int.class);
        System.out.println(c3);
    
        System.out.println("----------------------------getDeclaredConstructors");
        Constructor[] c4 = clazz.getDeclaredConstructors();
        for(Constructor c : c4){
        
            System.out.println(c);
        }
    } catch (ClassNotFoundException e) {
        
        e.printStackTrace();
    } catch (NoSuchMethodException e) {
        
        e.printStackTrace();
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xfamRfZ3VsdWx1_size_16_color_FFFFFF_t_70_pic_center]

**注意：**

1.  **使用`getConstructors`方法时，如果该类没有公共构造方法，或者该类是一个`数组类`，或者该类反映一个`基本类型`或 `void`，则返回一个长度为 0 的数组。**
2.  **使用`getDeclaredConstructors()`方法时，返回数组中的元素没有排序，也没有任何特定的顺序。如果此 Class 对象表示一个`接口`、一个`基本类型`、一个`数组类`或 `void`，则此方法返回一个长度为 0 的数组。**

#### 三、获取类的属性/字段。 ####

1.  方法介绍

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>返回值</th> 
   <th>参数</th> 
   <th>作用</th> 
   <th>异常</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>getField(String name)</code></td> 
   <td><code>Field对象</code></td> 
   <td>name表示所要获取的公共字段名字</td> 
   <td>返回该类的指定公共成员字段</td> 
   <td><code>NoSuchFieldException</code> - 找不到带有指定名称的字段。<code>NullPointerException</code> - 如果 name值 为 null</td> 
  </tr> 
  <tr> 
   <td><code>getFields()</code></td> 
   <td><code>Field[]</code></td> 
   <td>无</td> 
   <td>返回该类的所有可访问公共字段</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td><code>getDeclaredField(String name)</code></td> 
   <td><code>Field对象</code></td> 
   <td>name表示所要获取的字段名字简称</td> 
   <td>返回该类指定已声明字段。</td> 
   <td><code>NoSuchFieldException</code> - 找不到带有指定名称的字段。<code>NullPointerException</code> - 如果 name值 为 null</td> 
  </tr> 
  <tr> 
   <td><code>getDeclaredFields()</code></td> 
   <td><code>Field[]</code></td> 
   <td>无</td> 
   <td>返回该类所声明的所有字段。包括公共、保护、默认（包）访问和私有字段，但不包括继承的字段。</td> 
   <td>无</td> 
  </tr> 
 </tbody> 
</table>

1.  代码演示

try {
        
        Class clazz = Class.forName("Test.Student");
    
        System.out.println("----------------------------getField");
        Field f1 = clazz.getField("id");
        System.out.println(f1);
    
        System.out.println("----------------------------getFields");
        Field[] f2 = clazz.getFields();
        for(Field f : f2){
        
            System.out.println(f);
        }
    
        System.out.println("----------------------------getDeclaredField");
        Field f3 = clazz.getDeclaredField("name");
        System.out.println(f3);
    
        System.out.println("----------------------------getDeclaredFields");
        Field[] f4 = clazz.getDeclaredFields();
        for(Field f : f4){
        
            System.out.println(f);
        }
    } catch (ClassNotFoundException e) {
        
        e.printStackTrace();
    } catch (NoSuchFieldException e) {
        
        e.printStackTrace();
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xfamRfZ3VsdWx1_size_16_color_FFFFFF_t_70_pic_center 1]

**注意：**

*  **`getField(String name)`方法的实现过程：**
    
    1.  **现在当前类中寻找一个带有指定名的公共字段，则它就是要反映的字段。否则转2**
    2.  **第 1 步中没有找到任何字段，则该算法被递归地应用于当前类的每一个`直接超接口`。`直接超接口`按其声明顺序进行搜索。 否则转3**
    3.  **第 1、2 两步没有找到任何字段，且当前类有一个`超类` ，则在超类上递归调用该算法。如果此类没有`超类`，则抛出 `NoSuchFieldException`异常。**
 *  **使用`getFields()`方法时，返回数组中的元素无序，如果类或接口没有可访问的公共字段，或者表示一个`数组类`、一个`基本类型`或 `void`，则此方法返回长度为 0 的数组。 如果该 Class 对象表示一个类，则此方法返回该类及其所有`超类`的公共字段。如果该 Class `对象表示一个接口`，则此方法返回该接口及其所有超接口的公共字段。**

#### 四、获取类的方法 ####

1.  方法介绍

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>返回值</th> 
   <th>参数</th> 
   <th>作用</th> 
   <th>异常</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>getMethod(String name,Class&lt;?&gt;... Types)</code></td> 
   <td><code>Method类</code></td> 
   <td>name 指定的方法名称，Types是指定方法参数的Class类型数组。如<code>public boolean equals(Object obj)</code>,则name为<code>"equals"</code>,Types即为<code>Object.class</code></td> 
   <td>此 Class 对象所表示的类或接口的指定公共成员方法。</td> 
   <td><code>NoSuchMethodException</code> - 如果找不到匹配的方法，或者方法名为 <code>&lt;init&gt;"</code> 或 <code>&lt;clinit&gt;</code> <code>NullPointerException</code> - 如果 name 为 null</td> 
  </tr> 
  <tr> 
   <td><code>getMethods()</code></td> 
   <td><code>Method[]</code></td> 
   <td>无</td> 
   <td>获取此类中的所有公共方法，包括其继承实现的父类及接口的公共的方法。</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td><code>getDeclaredMethod(String name,Class&lt;?&gt;... Types)</code></td> 
   <td><code>Method类</code></td> 
   <td>name 指定的方法名称，Types是指定方法参数的Class类型数组。如<code>public boolean equals(Object obj)</code>,则name为<code>"equals"</code>,Types即为<code>Object.class</code></td> 
   <td>获取此类中指定已声明方法。</td> 
   <td><code>NoSuchMethodException</code> - 如果找不到匹配的方法，或者方法名为 <code>&lt;init&gt;"</code> 或 <code>&lt;clinit&gt;</code> <code>NullPointerException</code> - 如果 name 为 null</td> 
  </tr> 
  <tr> 
   <td><code>getDeclaredMethods()</code></td> 
   <td><code>Method[]</code></td> 
   <td>无</td> 
   <td>获取此类的所有方法，包括公共、保护、默认（包）访问和私有方法，但不包括继承的方法。</td> 
   <td>无</td> 
  </tr> 
 </tbody> 
</table>

1.  代码演示

try {
        
        Class clazz = Class.forName("Test.Student");
    
        System.out.println("----------------------------getMethod");
        Method m1 = clazz.getMethod("setAge", int.class);
        System.out.println(m1);
    
        System.out.println("----------------------------getMethods");
        Method[] m2 = clazz.getMethods();
        for (Method m : m2) {
        
            System.out.println(m);
        }
    
        System.out.println("----------------------------getDeclaredMethod");
        Method m3 = clazz.getDeclaredMethod("print");
        System.out.println(m3);
    
        System.out.println("----------------------------getDeclaredMethods");
        Method[] m4 = clazz.getDeclaredMethods();
        for (Method m : m4) {
        
            System.out.println(m);
        }
    } catch (ClassNotFoundException e) {
        
        e.printStackTrace();
    } catch (NoSuchMethodException e) {
        
        e.printStackTrace();
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xfamRfZ3VsdWx1_size_16_color_FFFFFF_t_70_pic_center 2]

**注意：**

*  **`getMethod(String name,Class<?>... Types)`由下面的算法确定**
    
    > 在类中查找匹配的方法：如果此类正好声明了一个具有指定名称的公共方法并且恰恰有相同的`形参类型`，则它就是匹配的方法。如果在此类中找到了多个这样的方法，并且其中有一个方法的`返回类型`比其他方法的`返回类型`都特殊，则匹配该方法；否则将从中任选一个方法。
    
    1.  **在当前类中搜索任一匹配的方法如果找不到匹配的方法，则将在此类的`超类`上递归调用第 1 步算法。**
    2.  **如果在第 1 步中没有找到任何方法，则在此类的`超接口`中搜索匹配的方法。如果找到了这样的方法，则记录该方法。**
 *  **`getMethods()`与`getDeclaredMethods()`比较，前者返回所有的public修饰的方法，包括继承父类或接口中的方法，后者返回当前类的所有方法但不包括从父类或者接口中继承实现的方法。**

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xfamRfZ3VsdWx1_size_16_color_FFFFFF_t_70_pic_center]: /images/20230208/e73723347ac144e7bb3c484e4ee7fe9a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xfamRfZ3VsdWx1_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20230208/5d0916680f7f4f729037aeaf5553f9a4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xfamRfZ3VsdWx1_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20230208/d529421babe94827bf48f6b761cf314f.png