反射工具类 - ReflectUtil

简介

ReflectUtil 是 Hutool 提供的一个反射工具类，它对 Java 的反射机制进行了封装，简化了常见的反射操作。通过这个工具类，开发者可以更方便地获取类的构造方法、字段、方法以及执行方法，从而提高开发效率。

1. 获取某个类的所有方法

ReflectUtil 提供了 getMethods 方法，用于获取某个类的所有方法。

import cn.hutool.core.util.ReflectUtil;

import java.lang.reflect.Method;

public class ReflectUtilExample {
    public static void main(String[] args) {
        // 获取指定类的所有方法
        Method[] methods = ReflectUtil.getMethods(ExamInfoDict.class);

        // 输出所有方法的名称
        for (Method method : methods) {
            System.out.println("方法名称: " + method.getName());
        }
    }
}

// 示例类，用于演示反射操作
class ExamInfoDict {
    private Long id;
    private String examName;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getExamName() {
        return examName;
    }

    public void setExamName(String examName) {
        this.examName = examName;
    }
}

• getMethods(Class<?> clazz)：获取指定类的所有方法。

  • clazz：要获取方法的类。
  • 返回值：包含类的所有方法的数组。

  作用： 获取类的所有方法信息，便于后续操作。

  实际开发场景： 当需要遍历类中的所有方法时，可以使用此方法。

2. 获取某个类的指定方法

ReflectUtil 提供了 getMethod 方法，用于获取某个类的指定方法。

import cn.hutool.core.util.ReflectUtil;

import java.lang.reflect.Method;

public class ReflectUtilExample {
    public static void main(String[] args) {
        // 获取指定类的指定方法
        Method method = ReflectUtil.getMethod(ExamInfoDict.class, "getId");

        // 输出方法名称
        System.out.println("方法名称: " + method.getName());
    }
}

// 示例类，和上一个示例中的 ExamInfoDict 类相同
class ExamInfoDict {
    private Long id;
    private String examName;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getExamName() {
        return examName;
    }

    public void setExamName(String examName) {
        this.examName = examName;
    }
}

• getMethod(Class<?> clazz, String methodName, Class<?>... parameterTypes)：获取指定类的指定方法。

  • clazz：要获取方法的类。
  • methodName：方法的名称。
  • parameterTypes：方法的参数类型。
  • 返回值：指定的方法对象。

  作用： 获取类中指定的方法，便于执行或分析该方法。

  实际开发场景： 在需要动态调用某个类的特定方法时，可以使用此方法。

3. 构造对象

ReflectUtil 提供了 newInstance 方法，用于通过反射构造对象。

import cn.hutool.core.util.ReflectUtil;

public class ReflectUtilExample {
    public static void main(String[] args) {
        // 通过反射构造对象
        ExamInfoDict examInfoDict = ReflectUtil.newInstance(ExamInfoDict.class);

        // 设置对象属性值
        examInfoDict.setId(1L);
        examInfoDict.setExamName("期中考试");

        // 输出对象信息
        System.out.println("考试名称: " + examInfoDict.getExamName());
    }
}

// 示例类，和前面一样
class ExamInfoDict {
    private Long id;
    private String examName;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getExamName() {
        return examName;
    }

    public void setExamName(String examName) {
        this.examName = examName;
    }
}

• newInstance(Class<T> clazz)：通过反射构造对象实例。

  • clazz：要构造对象的类。
  • 返回值：构造的对象实例。

  作用： 动态创建类的实例，适用于需要动态实例化对象的场景。

  实际开发场景： 在工厂模式、依赖注入框架等场景下，通常需要通过反射动态创建对象实例。

4. 执行方法

ReflectUtil 提供了 invoke 方法，用于执行指定对象的方法。

示例：通过反射执行方法

import cn.hutool.core.util.ReflectUtil;

public class ReflectUtilExample {
    public static void main(String[] args) {
        // 创建测试类的实例
        TestClass testClass = new TestClass();

        // 通过反射调用 setA 方法
        ReflectUtil.invoke(testClass, "setA", 10);

        // 获取并输出字段 a 的值
        int value = (int) ReflectUtil.invoke(testClass, "getA");
        System.out.println("字段 a 的值: " + value);
    }
}

// 示例类，用于演示反射操作
class TestClass {
    private int a;

    public int getA() {
        return a;
    }

    public void setA(int a) {
        this.a = a;
    }
}

• invoke(Object obj, String methodName, Object... args)：通过反射执行对象的方法。

  • obj：要调用方法的对象实例。
  • methodName：要执行的方法名称。
  • args：方法的参数。
  • 返回值：方法的返回值。

  作用： 动态执行对象的方法，便于在运行时调用对象的方法。

  实际开发场景： 在插件框架、动态代理等场景下，需要动态调用对象的方法，可以使用此方法。

---

总结

ReflectUtil 工具类在处理反射操作方面提供了简洁且强大的工具方法。它适用于各种需要动态操作类和对象的场景，帮助开发者更高效地进行反射操作，从而提高开发效率。