反射

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

类名 用途
Class 类 代表类的实体，在运行的 Java 应用程序中表示类和接口
Field 类 代表类的成员变量（成员变量也称为类的属性）
Method 类 代表类的方法
Constructor 类 代表类的构造方法

获得类相关的方法

方法 用途
asSubclass(Class clazz) 把传递的类的对象转换成代表其子类的对象
Cast 把对象转换成代表类或是接口的对象
getClassLoader() 获得类的加载器
getClasses() 返回一个数组，数组中包含该类中所有公共类和接口类的对象
getDeclaredClasses() 返回一个数组，数组中包含该类中所有类和接口类的对象
forName(String className) 根据类名返回类的对象
getName() 获得类的完整路径名字
newInstance() 创建类的实例
getPackage() 获得类的包
getSimpleName() 获得类的名字
getSuperclass() 获得当前类继承的父类的名字
getInterfaces() 获得当前类实现的类或是接口

获得类中属性相关的方法

方法 用途
getField(String name) 获得某个公有的属性对象
getFields() 获得所有公有的属性对象
getDeclaredField(String name) 获得某个属性对象
getDeclaredFields() 获得所有属性对象

获得类中注解相关的方法

方法 用途
getAnnotation(Class annotationClass) 返回该类中与参数类型匹配的公有注解对象
getAnnotations() 返回该类所有的公有注解对象
getDeclaredAnnotation(Class annotationClass) 返回该类中与参数类型匹配的所有注解对象
getDeclaredAnnotations() 返回该类所有的注解对象

获得类中构造器相关的方法

方法 用途
getConstructor(Class…<?> parameterTypes) 获得该类中与参数类型匹配的公有构造方法
getConstructors() 获得该类的所有公有构造方法
getDeclaredConstructor(Class…<?> parameterTypes) 获得该类中与参数类型匹配的构造方法
getDeclaredConstructors() 获得该类所有构造方法

获得类中方法相关的方法

方法 用途
getMethod(String name, Class…<?> parameterTypes) 获得该类某个公有的方法
getMethods() 获得该类所有公有的方法
getDeclaredMethod(String name, Class…<?> parameterTypes) 获得该类某个方法,能够获取到私有函数
getDeclaredMethods() 获得该类所有方法

类中其他重要的方法

方法 用途
isAnnotation() 如果是注解类型则返回 true
isAnnotationPresent(Class<? extends Annotation> annotationClass) 如果是指定类型注解类型则返回 true
isAnonymousClass() 如果是匿名类则返回 true
isArray() 如果是一个数组类则返回 true
isEnum() 如果是枚举类则返回 true
isInstance(Object obj) 如果 obj 是该类的实例则返回 true
isInterface() 如果是接口类则返回 true
isLocalClass() 如果是局部类则返回 true
isMemberClass() 如果是内部类则返回 true

Field 类

Field 代表类的成员变量（成员变量也称为类的属性）。

方法 用途
equals(Object obj) 属性与 obj 相等则返回 true
get(Object obj) 获得 obj 中对应的属性值
set(Object obj, Object value) 设置 obj 中对应属性值

Method 类

Method 代表类的方法。

方法 用途
invoke(Object obj, Object… args) 传递 object 对象及参数调用该对象对应的方法

Constructor 类

Constructor 代表类的构造方法。

方法 用途
newInstance(Object… initargs) 根据传递的参数创建类的对象

example

先写一个被反射调用的基础类

public class ExampleReflex {

    private static final String TAG = ExampleReflex.class.getSimpleName();

    private static int A = 2021;
    public static String LOG = "LOG";

    private String privateName = "privateName";
    public String publicName = "publicName";

    private String name = "defaultName";

    private final String FINAL_NAME = "FINAL_NAME";
    private static final String STATIC_FINAL_NAME = "STATIC_FINAL_NAME";

    public ExampleReflex() {

    }

    private ExampleReflex(String name) {
        this.name = name;
    }

    public void publicMethodNoParams() {
        Log.d(TAG, "publicMethodNoParams: ");
    }

    public void publicMethodHasParams(String name) {
        Log.d(TAG, "publicMethodHasParams: " + name);
    }

    private String getName() {
        Log.d(TAG, "Private No Params getName: ");
        return name;
    }

    private String privateMethodHasParams(int size) {
        Log.d(TAG, "privateMethodHasParams: " + size);
        return "size:" + size;
    }

    public static String staticMethodNoParams() {
        Log.d(TAG, "staticMethodNoParams: ");
        return "staticMethodNoParams";
    }

    public static String staticMethodHasParams(String name) {
        Log.d(TAG, "staticMethodHasParams: " + name);
        return name + "_____" + name;
    }

    private static void privateStaticMethod() {
        Log.d(TAG, "privateStaticMethod: ");
    }

    public void logPrivateName() {
        Log.d(TAG, "logPrivateName: " + privateName);
    }

    public void logPublicName() {
        Log.d(TAG, "logPublicName: " + publicName);
    }

    public void logStatic() {
        Log.d(TAG, "logStatic: A: " + A + "   LOG: " + LOG);
    }

    public void logFinal() {
        Log.d(TAG, "logFinal: finalName: " + FINAL_NAME + " STATIC_FINAL_NAME: "+ STATIC_FINAL_NAME);
    }
}

如上，其中包含 public、private、static、final 修饰的属性、以及函数

返回调用函数

调用 public 函数

// 先获取class
Class clazz = Class.forName("weightmeasure.justin.test.ExampleReflex");
// 根据class 获取一个对象
Object obj = clazz.newInstance();
// 获取公有无参函数 第一个参数为函数名，后续参数为入参class对象
Method method1 = clazz.getMethod("publicMethodNoParams", null);
// 执行函数
method1.invoke(obj, null);


// 获取公有有参函数 第二个参数是入参参数签名
Method method2 = clazz.getMethod("publicMethodHasParams", String.class);
method2.invoke(obj, "TEST");

调用 private 函数

// 获取私有函数
Method method3 = clazz.getDeclaredMethod("getName", null);
// 私有函数需要设置允许访问 否则会报错
method3.setAccessible(true);
// 获取返回值
String name = (String) method3.invoke(obj, null);
Log.d(tag, "privateMethod Result: " + name);

// 获取私有有参函数
Method method4 = clazz.getDeclaredMethod("privateMethodHasParams", int.class);
method4.setAccessible(true);
String size = (String) method4.invoke(obj, 22);
Log.d(tag, "privateMethodHasParams Result: " + size);

可以发现，获取私有函数时不能直接使用 getMethod，而是 getDeclaredMethod。
getDeclaredMethod 可以获取到所有函数，getMethod 只能获取到公开函数

调用 static 函数

// 获取静态无参函数
Method method5 = clazz.getDeclaredMethod("staticMethodNoParams", null);
method5.setAccessible(true);
method5.invoke(obj, null);

// 获取静态有参函数
Method method6 = clazz.getDeclaredMethod("staticMethodHasParams", String.class);
method6.setAccessible(true);
String result_str6 = (String) method6.invoke(obj, "public static method");
Log.d(tag, "staticMethodHasParams Result: " + result_str6);

// 私有静态函数
Method method7 = clazz.getDeclaredMethod("privateStaticMethod", null);
method7.setAccessible(true);
method7.invoke(obj, null);

反射调用静态函数与调用私有函数其实没有不同

调用反射修改属性

修改 public、private、static 变量

// 修改public变量，并输出
// 获取属性
Field publicField = clazz.getDeclaredField("publicName");
// 在obj实例对象上设置属性新值
publicField.set(obj, "publicName_New");
Method method8 = clazz.getDeclaredMethod("logPublicName");
method8.invoke(obj, null);

// 修改private变量
Field privateField = clazz.getDeclaredField("privateName");
// 私有属性需要设置可访问
privateField.setAccessible(true);
privateField.set(obj, "privateName_New");
Method method9 = clazz.getDeclaredMethod("logPrivateName", null);
method9.invoke(obj, null);

// 修改静态属性
Field field1 = clazz.getDeclaredField("A");
field1.setAccessible(true);
field1.set(obj, 2222);
Method method10 = clazz.getDeclaredMethod("logStatic", null);
method10.setAccessible(true);
method10.invoke(obj, null);

注意，私有变量时需要调用 setAccessible，不然会报错

修改 final 修饰的常量

在 java 中，使用 final 修饰的代表常量，不允许修改。
当我们通过反射修改时

// 修改final常量
Field field2 = clazz.getDeclaredField("FINAL_NAME");
field2.setAccessible(true);
field2.set(obj, "FINAL_NAME_NEW");
Method method11 = clazz.getDeclaredMethod("logFinal", null);
method11.setAccessible(true);
method11.invoke(obj, null);

采用与 public 等一样的方式进行修改时,代码没有报错，但修改也未生效。

针对 final 修饰的属性，我们需要做的是，获取到修饰符，然后去掉 final，再进行修改

// 正确的修改final常量方式
Field field3 = clazz.getDeclaredField("FINAL_NAME");
field3.setAccessible(true);
Field modifiers = Field.class.getDeclaredField("modifiers");
modifiers.setAccessible(true);
modifiers.setInt(field3, field3.getModifiers() & ~Modifier.FINAL);
field3.set(obj, "FINAL_NAME_NEW");
Method method12 = clazz.getDeclaredMethod("logFinal", null);
method12.invoke(obj, null);

反射构造函数

在上面调用生成实例中：
Object obj = clazz.newInstance();

其实就是调用默认的构造函数生成实例对象。如果将默认构造函数修改为 private 时，此时就会报错。
修改 ExampleReflex.java 中的构造函数

private ExampleReflex(int a) {
    Log.d(TAG, "Constructor ExampleReflex: " + a);
}

public ExampleReflex(String name) {
    this.name = name;
}

直接调用 Object obj = clazz.newInstance(); 会报错，需要通过反射先获取构造函数，再生成实例

通过 public 有参构造函数生成实例

Class clazz = Class.forName("weightmeasure.justin.test.ExampleReflex");
// 获取public 有参的构造函数
Constructor constructor1 = clazz.getConstructor(String.class);
// 通过构造函数生成对象 参数为入参类型class
Object obj = constructor1.newInstance("NNNNN");
Method method81 = clazz.getDeclaredMethod("getName", null);
method81.setAccessible(true);
method81.invoke(obj, null);

通过 private 有参构造函数生成实例

// 获取private 有参构造函数
Constructor constructor2 = clazz.getDeclaredConstructor(int.class);
// 生成实例
Object obj2 = constructor2.newInstance(222);