反射

# 反射

## Java反射机制定义

Java反射机制是指在运行状态中,对于任意一个类,都能够知道这个类的所有属性和方法对于任意一个对象,都能够调用它的任意一个方法和属性;这种动态获取的信息以及动态调用对象的方法的功能称为java语言的反射机制。

用一句话总结就是反射可以实现在运行时可以知道任意一个类的属性和方法。

#### 反射的概念

- 静态编译:在编译时确定类型,绑定对象,即通过。

- 动态编译:运行时确定类型,绑定对象。动态编译最大限度发挥了java的灵活性,体现了多态的应用,有以降低类之间的藕合性

耦合性:指模块之间的联系及相互影响尽可能地少,必须联系的应加以明确的说明,这种联系及相互影响称为模块的藕合性。

耦合是影响软件复杂程度的一个重要因素。应该采取的原则是:尽量使用数据耦合,少用控制耦合,限制公共环境耦合的范围,完全不用内容耦合

## 反射机制的优点与缺点

#### 优点

灵活性高。因为**反射属于动态编译**,即只有到运行时才动态创建 &获取对象实例。

编译方式说明:

- 静态编译:在编译时确定类型 & 绑定对象。如常见的使用`new`关键字创建对象

- 动态编译:运行时确定类型 & 绑定对象。动态编译体现了`Java`的灵活性、多态特性 & 降低类之间的藕合性

#### 缺点

#### 缺点

执行效率低,因为反射的操作主要通过JVM执行,所以时间成本会高于直接执行相同操作

- 因为接口的通用性,Java的invoke方法是传object和object[]数组的。基本类型参数需要装箱拆箱,产生大量额外的对象和内存开销,频繁促发GC(垃圾回收

- 编译器难以对动态调用的代码提前做优化

- 反射需要按名检索类和方法,有一定的时间开销.

- 容易破坏类结构 ,因为反射操作饶过了源码,容易干扰类原有的内部逻辑

#### Java反射机制提供的功能

![img](反射.assets/12693685-301282eafa32f611.png)

#### java.lang.Class

> 定义:java.lang.Class类是反射机制的基础

>        作用:存放着对应类型对象的运行时信息

>

> - 在Java程序运行时,Java虚拟机为所有类型维护一个java.lang.Class对象

> - 该Class对象存放着所有关于该对象的 运行时信息

> - 泛型形式为Class

> 每种类型的Class对象只有1个 = 地址只有1个

```Java

        // 对于2个String类型对象,它们的Class对象相同

        Class c1 = "class".getClass();

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

        // 用==运算符实现两个类对象地址的比较

        System.out.println(c1 == c2);

        // 输出结果:true

```

![image-20201214172821158](反射.assets/image-20201214172821158.png)

#### 实现方式

反射机制的实现 主要通过 操作java.lang.Class

- 获取 目标类型的Class对象

- 通过 Class 对象分别获取Constructor类对象、Method类对象 & Field 类对象

- 通过 Constructor类对象、Method类对象 & Field类对象分别获取类的构造函数、方法&属性的具体信息,并进行后续操作

#### 获取 目标类型的`Class`对象的方式主要有4种方法

```java

  private static void getTargetClass() throws ClassNotFoundException {

        /** 方式1:Object.getClass()

        * Object类中的getClass()返回一个Class类型的实例*/

        Boolean temp = true;

        Class type = temp.getClass();

        System.out.println(type);//结果:class java.lang.Boolean

        /** 方式2:T.class 语法,T = 任意Java类型

        * 注:Class对象表示的是一个类型,而这个类型未必一定是类

        *如,int不是类,但int.class是一个Class类型的对象*/

        Class temp2 = Boolean.class;

        System.out.println(temp2);//结果:class java.lang.Boolean

        Class temp21 = int.class;

        System.out.println(temp21);//结果:int

        /** 方式3:static method Class.forName

        Class classType = Class . forName ("java.lang.Boolean"); */

        Class temp3 = Class.forName("java.lang.Boolean");

        System.out.println(temp3);//结果:class java.lang.Boolean

        /** 方式4:TYPE语法

        * Class classType = Boolean . TYPE*/

        Class temp4 = Boolean.TYPE;

        System.out.println(temp4);//结果:boolean

    }

```

![image-20201214180258702](反射.assets/image-20201214180258702.png)

#### 反射类对应关系

> Java反射机制的实现除了依靠Java.lang.Class类,还需要依靠:Constructor类、Field类、Method类,分别作用于类的各个组成部分:

>

> ![img](https:////upload-images.jianshu.io/upload_images/12693685-12fdb465f74491df.png?imageMogr2/auto-orient/strip|imageView2/2/w/864/format/webp)

>

> image.png

#### Type类

> Type是Java中所有类型的通用超级接口编程语言。这些包括原始类型,参数化类型,数组类型、类型变量和原始类型

>  以下为继承Type子类

![img](https:////upload-images.jianshu.io/upload_images/12693685-5b894c289d2824f6.png?imageMogr2/auto-orient/strip|imageView2/2/w/877/format/webp)

image.png

#### 通过 Class 对象分别获取Constructor类对象、Method类对象 & Field 类对

```java

// 即以下方法都属于`Class` 类的方法。

<-- 1. 获取类的构造函数(传入构造函数的参数类型)->>

  // a. 获取指定的构造函数 (公共 / 继承)

  Constructor getConstructor(Class... parameterTypes)

  // b. 获取所有的构造函数(公共 / 继承)

  Constructor[] getConstructors();

  // c. 获取指定的构造函数 ( 不包括继承)

  Constructor getDeclaredConstructor(Class... parameterTypes)

  // d. 获取所有的构造函数( 不包括继承)

  Constructor[] getDeclaredConstructors();

// 最终都是获得一个Constructor类对象

// 特别注意:

  // 1. 不带 "Declared"的方法支持取出包括继承、公有(Public) & 不包括有(Private)的构造函数

  // 2. 带 "Declared"的方法是支持取出包括公共(Public)、保护(Protected)、默认(包)访问和私有(Private)的构造方法,但不包括继承的构造函数

  // 下面同理

<--  2. 获取类的属性(传入属性名) -->

  // a. 获取指定的属性(公共 / 继承)

  Field getField(String name) ;

  // b. 获取所有的属性(公共 / 继承)

  Field[] getFields() ;

  // c. 获取指定的所有属性 (不包括继承)

  Field getDeclaredField(String name) ;

  // d. 获取所有的所有属性 (不包括继承)

  Field[] getDeclaredFields() ;

// 最终都是获得一个Field类对象

<-- 3. 获取类的方法(传入方法名 & 参数类型)-->

  // a. 获取指定的方法(公共 / 继承)

    Method getMethod(String name, Class... parameterTypes) ;

  // b. 获取所有的方法(公共 / 继承)

  Method[] getMethods() ;

  // c. 获取指定的方法 ( 不包括继承)

  Method getDeclaredMethod(String name, Class... parameterTypes) ;

  // d. 获取所有的方法( 不包括继承)

  Method[] getDeclaredMethods() ;

// 最终都是获得一个Method类对象

<-- 4. Class类的其他常用方法 -->

getSuperclass();

// 返回父类

String getName();

// 作用:返回完整的类名(含包名,如java.lang.String )

Object newInstance();

// 作用:快速地创建一个类的实例

// 具体过程:调用默认构造器(若该类无默认构造器,则抛出异常

// 注:若需要为构造器提供参数需使用java.lang.reflect.Constructor中的newInstance()

```

#### 通过 Constructor类对象、Method类对象 & Field类对象分别获取类的构造函数方法 & 属性的具体信息 & 进行操作

```java

// 即以下方法都分别属于`Constructor`类、`Method`类 & `Field`类的方法。

<-- 1. 通过Constructor 类对象获取类构造函数信息 -->

  String getName();// 获取构造器名

  Class getDeclaringClass();// 获取一个用于描述类中定义的构造器的Class对象

  int getModifiers();// 返回整型数值,用不同的位开关描述访问修饰符的使用状况

  Class[] getExceptionTypes();// 获取描述方法抛出的异常类型的Class对象数组

  Class[] getParameterTypes();// 获取一个用于描述参数类型的Class对象数组

<-- 2. 通过Field类对象获取类属性信息 -->

  String getName();// 返回属性的名称

  Class getDeclaringClass(); // 获取属性类型的Class类型对象

  Class getType();// 获取属性类型的Class类型对象

  int getModifiers(); // 返回整型数值,用不同的位开关描述访问修饰符的使用状况

  Object get(Object obj) ;// 返回指定对象上 此属性的值

  void set(Object obj, Object value) // 设置 指定对象上此属性的值为value

<-- 3. 通过Method 类对象获取类方法信息 -->

  String getName();// 获取方法名

  Class getDeclaringClass();// 获取方法的Class对象

  int getModifiers();// 返回整型数值,用不同的位开关描述访问修饰符的使用状况

  Class[] getExceptionTypes();// 获取用于描述方法抛出的异常类型的Class对象数组

  Class[] getParameterTypes();// 获取一个用于描述参数类型的Class对象数组

<--额外:java.lang.reflect.Modifier类 -->

// 作用:获取访问修饰符

static String toString(int modifiers) 

// 获取对应modifiers位设置的修饰符的字符串表示

static boolean isXXX(int modifiers)

// 检测方法名中对应的修饰符在modifiers中的值

```

#### 举个例子,获取String 所有构造方法

![img](反射.assets/12693685-a9e0550bd2fb9e30.png)

image.png

#### 特别注意:访问权限问题

> 反射机制的默认行为受限于Java的访问控制

>  如,无法访问( private )私有的方法、字段

#### 冲突

> Java安全机制只允许查看任意对象有哪些域,而不允许读它们的值

>  若强制读取,将抛出异常

#### 解决方案

> 脱离Java程序中安全管理器的控制、屏蔽Java语言的访问检查,从而脱离访问控制

>  具体实现手段:使用Field类、Method类 & Constructor类对象的setAccessible()

```java

void setAccessible(boolean flag)   

// 作用:为反射对象设置可访问标志

// 规则:flag = true时 ,表示已屏蔽Java语言的访问检查,使得可以访问 & 修改对象的私有属性

boolean isAccessible() 

// 返回反射对象的可访问标志的值

static void setAccessible(AccessibleObject[] array, boolean flag) 

// 设置对象数组可访问标志

```

#### 实例1:利用反射获取类的属性 & 赋值

```java

/**

    * 测试类定义

    */

    public static class Student {

        private String name;

        public Student() {

            System.out.println("创建了一个Student实例");

        }

    }

    /**

    * 测试方法

    */

    private static void example() throws Exception {

        //利用反射获取属性 & 赋值

        // 1. 获取Student类的Class对象

        Class studentClass = Student.class;

        // 2. 通过Class对象创建Student类的对象

        Constructor constructor = studentClass.getDeclaredConstructor();

        constructor.setAccessible(true);

        Object mStudent = studentClass.newInstance();

        // 3. 通过Class对象获取Student类的name属性

        Field f = studentClass.getDeclaredField("name");

        // 4. 设置私有访问权限

        f.setAccessible(true);

        // 5. 对新创建的Student对象设置name值

        f.set(mStudent, "我是java 反射");

        // 6. 获取新创建Student对象的的name属性 & 输出

        System.out.println(f.get(mStudent));

    }

```

测试结果

![img](反射.assets/12693685-1a8ecebe6b58a07a.png)

#### 利用反射调用类的构造函数

```java

/**

    * 测试类定义

    */

    public static class Student2 {

        private String name;

        public Student2() {

            System.out.println("无参构造 ");

        }

        public Student2(String str) {

            System.out.println("有参构造 " + "****" + str);

        }

    }

    /**

    * 利用反射调用构造函数

    */

    private static void example2() throws Exception {

        //利用反射调用构造函数

        // 1. 获取Student类的Class对象

        Class studentClass = Student2.class;

        // 2.1 通过Class对象获取Constructor类对象,从而调用无参构造方法

        // 注:构造函数的调用实际上是在newInstance(),而不是在getConstructor()中调用

        Object mObj1 = studentClass.getConstructor().newInstance();

        // 2.2 通过Class对象获取Constructor类对象(传入参数类型),从而调用有参构造方法

        Object mObj2 = studentClass.getConstructor(String.class).newInstance("OK");

    }

```

[图片上传失败...(image-1c62c9-1532574152311)]

#### 利用反射调用方法

```java

/**

    * 测试类定义

    */

    public static class Student {

        public Student() {

            System.out.println("创建了一个Student实例");

        }

        // 无参数方法

        public void setName1() {

            System.out.println("调用了无参方法:setName1()");

        }

        // 有参数方法

        public void setName2(String str) {

            System.out.println("调用了有参方法setName2(String str):" + str);

        }

    }

    /**

    * 利用反射调用方法

    */

    private static void example2() throws Exception {

        //利用反射调用方法

        // 1. 获取Student类的Class对象

        Class studentClass = Student.class;

        // 2. 通过Class对象创建Student类的对象

        Object mStudent = studentClass.newInstance();

        // 3.1 通过Class对象获取方法setName1()的Method对象:需传入方法名

        // 因为该方法 = 无参,所以不需要传入参数

        Method msetName1 = studentClass.getMethod("setName1");

        // 通过Method对象调用setName1():需传入创建的实例

        msetName1.invoke(mStudent);

        // 3.2 通过Class对象获取方法setName2()的Method对象:需传入方法名 & 参数类型

        Method msetName2 = studentClass.getMethod("setName2", String.class);

        // 通过Method对象调用setName2():需传入创建的实例 & 参数值

        msetName2.invoke(mStudent, "Carson_Ho");

    }

```

![img](反射.assets/12693685-950889882fd29df7.png)

## API

Kotlin 反射 API 主要来自于 `kotlin.reflect`、`kotlin.reflect.full` 和 `kotlin.reflect.jvm` 包。其中 `kotlin.reflect`、`kotlin.reflect.full` 是主要的 Kotlin 反射 API,而 `kotlin.reflect.jvm` 包主要用于 Kotlin 反射 和 Java 反射的互操作。

  **`kotlin.reflect`** 包是 Kotlin 反射核心 API,它的类图如下图 1-1 所示,它们都是接口,详细说明如下:

- `KCkass`。表示一个具有反射功能的类。

- `KParameter`。表示一个具有反射功能的 可传递给函数或属性的参数。

- `KCallable`。表示具有反射功能的可调用实例,包括属性和函数,它的直接子接口有 KProperty 和 KFunction。

- `KFunction`。表示一个具有反射功能的函数。

- `KProperty`。表示一个具有反射功能的属性,它有很多子接口。KProperty0、KProperty1 和 KProperty2 后面的数字表示接收者作为参数的个数。

- `KMutableProperty`。表示一个具有反射功能的使用 var 声明的属性。KMutableProperty0、KMutableProperty1 和 KMutableProperty2 后面的数字含义同 KProperty。

![img](反射.assets/16251880-81a3a8fbbc0457c9.png)

**注意:**Kotlin 反射 API 所需要的运行时组件来自于独立的 **`kotlin-reflect.jar`** 文件,在 Android 等移动平台上为了减少应用程序包的大小,应用程序包再默认情况下不包含 **`kotlin-reflect.jar`** 文件。如果要在应用中使用反射功能,则需要额外添加 **`kotlin-reflect.jar`** 文件至应用程序包中,并添加 **`kotlin-reflect.jar`** 到项目的类路径。

# Properties

Properties 继承于 Hashtable。表示一个持久的属性集,属性列表以key-value的形式存在,key和value都是字符串。

Properties 类被许多Java类使用。例如,在获取环境变量时它就作为System.getProperties()方法的返回值。

我们在很多**需要避免硬编码的应用场景**下需要使用properties文件来加载程序需要的配置信息,比如JDBC、MyBatis框架等。Properties类则是properties文件和程序的中间桥梁,不论是从properties文件读取信息还是写入信息到properties文件都要经由Properties类。

### 常见方法

除了从Hashtable中所定义的方法,Properties定义了以下方法:

![img](反射.assets/2510824-6f56a4a4165d4acc.png)

Properties类

下面我们从**写入、读取、遍历**等角度来解析Properties类的常见用法:

### 写入

Properties类调用setProperty方法将键值对保存到内存中,此时可以通过getProperty方法读取,propertyNames方法进行遍历,但是并没有将键值对持久化到属性文件中,故需要调用store方法持久化键值对到属性文件中。

```java

package cn.habitdiary;

import java.io.FileInputStream;

import java.io.FileOutputStream;

import java.io.IOException;

import java.io.InputStream;

import java.io.OutputStream;

import java.util.Date;

import java.util.Enumeration;

import java.util.Properties;

import junit.framework.TestCase;

public class PropertiesTester extends TestCase {

    public void writeProperties() {

        Properties properties = new Properties();

        OutputStream output = null;

        try {

            output = new FileOutputStream("config.properties");

            properties.setProperty("url", "jdbc:mysql://localhost:3306/");

            properties.setProperty("username", "root");

            properties.setProperty("password", "root");

            properties.setProperty("database", "users");//保存键值对到内存

            properties.store(output, "Steven1997 modify" + new Date().toString());

                        // 保存键值对到文件中

        } catch (IOException io) {

            io.printStackTrace();

        } finally {

            if (output != null) {

                try {

                    output.close();

                } catch (IOException e) {

                    e.printStackTrace();

                }

            }

        }

    }

}

```

### 读取

下面给出常见的六种读取properties文件的方式:

```java

package cn.habitdiary;

import java.io.BufferedInputStream;

import java.io.File;

import java.io.FileInputStream;

import java.io.FileNotFoundException;

import java.io.IOException;

import java.io.InputStream;

import java.util.Locale;

import java.util.Properties;

import java.util.PropertyResourceBundle;

import java.util.ResourceBundle;

/**

* 读取properties文件的方式

*

*/

public class LoadPropertiesFileUtil {

    private static String basePath = "src/main/java/cn/habitdiary/prop.properties";

    private static String path = "";

    /**

    * 一、 使用java.util.Properties类的load(InputStream in)方法加载properties文件

    *

    * @return

    */

    public static String getPath1() {

        try {

            InputStream in = new BufferedInputStream(new FileInputStream(

                    new File(basePath)));

            Properties prop = new Properties();

            prop.load(in);

            path = prop.getProperty("path");

        } catch (FileNotFoundException e) {

            System.out.println("properties文件路径书写有误,请检查!");

            e.printStackTrace();

        } catch (IOException e) {

            e.printStackTrace();

        }

        return path;

    }

    /**

    * 二、 使用java.util.ResourceBundle类的getBundle()方法

    * 注意:这个getBundle()方法的参数只能写成包路径+properties文件名,否则将抛异常

    *

    * @return

    */

    public static String getPath2() {

        ResourceBundle rb = ResourceBundle

                .getBundle("cn/habitdiary/prop");

        path = rb.getString("path");

        return path;

    }

    /**

    * 三、 使用java.util.PropertyResourceBundle类的构造函数

    *

    * @return

    */

    public static String getPath3() {

        InputStream in;

        try {

            in = new BufferedInputStream(new FileInputStream(basePath));

            ResourceBundle rb = new PropertyResourceBundle(in);

            path = rb.getString("path");

        } catch (FileNotFoundException e) {

            // TODO Auto-generated catch block

            e.printStackTrace();

        } catch (IOException e) {

            e.printStackTrace();

        }

        return path;

    }

    /**

    * 四、 使用class变量的getResourceAsStream()方法

    * 注意:getResourceAsStream()方法的参数按格式写到包路径+properties文件名+.后缀

    *

    * @return

    */

    public static String getPath4() {

        InputStream in = LoadPropertiesFileUtil.class

                .getResourceAsStream("cn/habitdiary/prop.properties");

        Properties p = new Properties();

        try {

            p.load(in);

            path = p.getProperty("path");

        } catch (IOException e) {

            e.printStackTrace();

        }

        return path;

    }

    /**

    * 五、

    * 使用class.getClassLoader()所得到的java.lang.ClassLoader的

    * getResourceAsStream()方法

    * getResourceAsStream(name)方法的参数必须是包路径+文件名+.后缀

    * 否则会报空指针异常

    * @return

    */

    public static String getPath5() {

        InputStream in = LoadPropertiesFileUtil.class.getClassLoader()

                .getResourceAsStream("cn/habitdiary/prop.properties");

        Properties p = new Properties();

        try {

            p.load(in);

            path = p.getProperty("path");

        } catch (IOException e) {

            e.printStackTrace();

        }

        return path;

    }

    /**

    * 六、 使用java.lang.ClassLoader类的getSystemResourceAsStream()静态方法

    * getSystemResourceAsStream()方法的参数格式也是有固定要求的

    *

    * @return

    */

    public static String getPath6() {

        InputStream in = ClassLoader

                .getSystemResourceAsStream("cn/habitdiary/prop.properties");

        Properties p = new Properties();

        try {

            p.load(in);

            path = p.getProperty("path");

        } catch (IOException e) {

            // TODO Auto-generated catch block

            e.printStackTrace();

        }

        return path;

    }

    public static void main(String[] args) {

        System.out.println(LoadPropertiesFileUtil.getPath1());

        System.out.println(LoadPropertiesFileUtil.getPath2());

        System.out.println(LoadPropertiesFileUtil.getPath3());

        System.out.println(LoadPropertiesFileUtil.getPath4());

        System.out.println(LoadPropertiesFileUtil.getPath5());

        System.out.println(LoadPropertiesFileUtil.getPath6());

    }

}

```

其中第一、四、五、六种方式都是先获得文件的输入流,然后通过Properties类的load(InputStream inStream)方法加载到Properties对象中,最后通过Properties对象来操作文件内容。

第二、三中方式是通过ResourceBundle类来加载Properties文件,然后ResourceBundle对象来操做properties文件内容。

**其中最重要的就是每种方式加载文件时,文件的路径需要按照方法的定义的格式来加载,否则会抛出各种异常,比如空指针异常。**

### 遍历

下面给出四种遍历Properties中的所有键值对的方法:

```java

    /**

    * 输出properties的key和value

    */

    public static void printProp(Properties properties) {

        System.out.println("---------(方式一)------------");

        for (String key : properties.stringPropertyNames()) {

            System.out.println(key + "=" + properties.getProperty(key));

        }

        System.out.println("---------(方式二)------------");

        Set keys = properties.keySet();//返回属性key的集合

        for (Object key : keys) {

            System.out.println(key.toString() + "=" + properties.get(key));

        }

        System.out.println("---------(方式三)------------");

        Set> entrySet = properties.entrySet();

        //返回的属性键值对实体

        for (Map.Entry entry : entrySet) {

            System.out.println(entry.getKey() + "=" + entry.getValue());

        }

        System.out.println("---------(方式四)------------");

        Enumeration e = properties.propertyNames();

        while (e.hasMoreElements()) {

            String key = (String) e.nextElement();

            String value = properties.getProperty(key);

            System.out.println(key + "=" + value);

        }

    }

```

dom4j

maven

你可能感兴趣的:(反射)