ReflectUtil (hutool-core 4.1.17 API)

java.lang.Object
- cn.hutool.core.util.ReflectUtil

```
public class ReflectUtil
extends java.lang.Object
```
反射工具类

从以下版本开始:

3.0.9

作者:

Looly

构造器概要

构造器
构造器和说明

ReflectUtil()

构造器
构造器和说明
`ReflectUtil()`

方法概要

方法
限定符和类型	方法和说明
`static <T> java.lang.reflect.Constructor<T>`	`getConstructor(java.lang.Class<T> clazz, java.lang.Class<?>... parameterTypes)` 查找类中的指定参数的构造方法，如果找到构造方法，会自动设置可访问为true
`static <T> java.lang.reflect.Constructor<T>[]`	`getConstructors(java.lang.Class<T> beanClass)` 获得一个类中所有构造列表
`static java.lang.reflect.Constructor<?>[]`	`getConstructorsDirectly(java.lang.Class<?> beanClass)` 获得一个类中所有字段列表，直接反射获取，无缓存
`static java.lang.reflect.Field`	`getField(java.lang.Class<?> beanClass, java.lang.String name)` 查找指定类中的所有字段（包括非public字段），也包括父类和Object类的字段，字段不存在则返回`null`
`static java.lang.reflect.Field[]`	`getFields(java.lang.Class<?> beanClass)` 获得一个类中所有字段列表，包括其父类中的字段
`static java.lang.reflect.Field[]`	`getFieldsDirectly(java.lang.Class<?> beanClass, boolean withSuperClassFieds)` 获得一个类中所有字段列表，直接反射获取，无缓存
`static java.lang.Object[]`	`getFieldsValue(java.lang.Object obj)` 获取所有字段的值
`static java.lang.Object`	`getFieldValue(java.lang.Object obj, java.lang.reflect.Field field)` 获取字段值
`static java.lang.Object`	`getFieldValue(java.lang.Object obj, java.lang.String fieldName)` 获取字段值
`static java.lang.reflect.Method`	`getMethod(java.lang.Class<?> clazz, boolean ignoreCase, java.lang.String methodName, java.lang.Class<?>... paramTypes)` 查找指定方法如果找不到对应的方法则返回`null`
`static java.lang.reflect.Method`	`getMethod(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.Class<?>... paramTypes)` 查找指定方法如果找不到对应的方法则返回`null`
`static java.lang.reflect.Method`	`getMethodIgnoreCase(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.Class<?>... paramTypes)` 忽略大小写查找指定方法，如果找不到对应的方法则返回`null`
`static java.util.Set<java.lang.String>`	`getMethodNames(java.lang.Class<?> clazz)` 获得指定类中的Public方法名去重重载的方法
`static java.lang.reflect.Method`	`getMethodOfObj(java.lang.Object obj, java.lang.String methodName, java.lang.Object... args)` 查找指定对象中的所有方法（包括非public方法），也包括父对象和Object类的方法
`static java.lang.reflect.Method[]`	`getMethods(java.lang.Class<?> beanClass)` 获得一个类中所有方法列表，包括其父类中的方法
`static java.lang.reflect.Method[]`	`getMethods(java.lang.Class<?> clazz, Filter<java.lang.reflect.Method> filter)` 获得指定类过滤后的Public方法列表
`static java.lang.reflect.Method[]`	`getMethodsDirectly(java.lang.Class<?> beanClass, boolean withSuperClassMethods)` 获得一个类中所有方法列表，直接反射获取，无缓存
`static <T> T`	`invoke(java.lang.Object obj, java.lang.reflect.Method method, java.lang.Object... args)` 执行方法
`static <T> T`	`invoke(java.lang.Object obj, java.lang.String methodName, java.lang.Object... args)` 执行对象中指定方法
`static <T> T`	`invokeStatic(java.lang.reflect.Method method, java.lang.Object... args)` 执行静态方法
`static <T> T`	`invokeWithCheck(java.lang.Object obj, java.lang.reflect.Method method, java.lang.Object... args)` 执行方法执行前要检查给定参数： 1.
`static boolean`	`isEqualsMethod(java.lang.reflect.Method method)` 是否为equals方法
`static boolean`	`isHashCodeMethod(java.lang.reflect.Method method)` 是否为hashCode方法
`static boolean`	`isToStringMethod(java.lang.reflect.Method method)` 是否为toString方法
`static <T> T`	`newInstance(java.lang.Class<T> clazz, java.lang.Object... params)` 实例化对象
`static <T> T`	`newInstance(java.lang.String clazz)` 实例化对象
`static <T> T`	`newInstanceIfPossible(java.lang.Class<T> beanClass)` 尝试遍历并调用此类的所有构造方法，直到构造成功并返回
`static void`	`setFieldValue(java.lang.Object obj, java.lang.reflect.Field field, java.lang.Object value)` 设置字段值
`static void`	`setFieldValue(java.lang.Object obj, java.lang.String fieldName, java.lang.Object value)` 设置字段值

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - ReflectUtil
```
public ReflectUtil()
```
- 方法详细资料
  - getConstructor
```
public static <T> java.lang.reflect.Constructor<T> getConstructor(java.lang.Class<T> clazz,
                                                  java.lang.Class<?>... parameterTypes)
```
    查找类中的指定参数的构造方法，如果找到构造方法，会自动设置可访问为true
    
    类型参数:
    T - 对象类型
    参数:
    clazz - 类
    parameterTypes - 参数类型，只要任何一个参数是指定参数的父类或接口或相等即可，此参数可以不传
    
    返回:
    构造方法，如果未找到返回null
  - getConstructors
```
public static <T> java.lang.reflect.Constructor<T>[] getConstructors(java.lang.Class<T> beanClass)
                                                          throws java.lang.SecurityException
```
    获得一个类中所有构造列表
    
    类型参数:
    T - 构造的对象类型
    参数:
    beanClass - 类
    
    返回:
    字段列表
    
    抛出:
    
    java.lang.SecurityException - 安全检查异常
  - getConstructorsDirectly
```
public static java.lang.reflect.Constructor<?>[] getConstructorsDirectly(java.lang.Class<?> beanClass)
                                                                  throws java.lang.SecurityException
```
    获得一个类中所有字段列表，直接反射获取，无缓存
    
    参数:
    beanClass - 类
    
    返回:
    字段列表
    
    抛出:
    
    java.lang.SecurityException - 安全检查异常
  - getField
```
public static java.lang.reflect.Field getField(java.lang.Class<?> beanClass,
                               java.lang.String name)
                                        throws java.lang.SecurityException
```
    查找指定类中的所有字段（包括非public字段），也包括父类和Object类的字段，字段不存在则返回null
    
    参数:
    beanClass - 被查找字段的类,不能为null
    name - 字段名
    
    返回:
    字段
    
    抛出:
    
    java.lang.SecurityException - 安全异常
  - getFields
```
public static java.lang.reflect.Field[] getFields(java.lang.Class<?> beanClass)
                                           throws java.lang.SecurityException
```
    获得一个类中所有字段列表，包括其父类中的字段
    
    参数:
    beanClass - 类
    
    返回:
    字段列表
    
    抛出:
    
    java.lang.SecurityException - 安全检查异常
  - getFieldsDirectly
```
public static java.lang.reflect.Field[] getFieldsDirectly(java.lang.Class<?> beanClass,
                                          boolean withSuperClassFieds)
                                                   throws java.lang.SecurityException
```
    获得一个类中所有字段列表，直接反射获取，无缓存
    
    参数:
    beanClass - 类
    withSuperClassFieds - 是否包括父类的字段列表
    
    返回:
    字段列表
    
    抛出:
    
    java.lang.SecurityException - 安全检查异常
  - getFieldValue
```
public static java.lang.Object getFieldValue(java.lang.Object obj,
                             java.lang.String fieldName)
                                      throws UtilException
```
    获取字段值
    
    参数:
    obj - 对象
    fieldName - 字段名
    
    返回:
    字段值
    
    抛出:
    
    UtilException - 包装IllegalAccessException异常
  - getFieldValue
```
public static java.lang.Object getFieldValue(java.lang.Object obj,
                             java.lang.reflect.Field field)
                                      throws UtilException
```
    获取字段值
    
    参数:
    obj - 对象
    field - 字段
    
    返回:
    字段值
    
    抛出:
    
    UtilException - 包装IllegalAccessException异常
  - getFieldsValue
```
public static java.lang.Object[] getFieldsValue(java.lang.Object obj)
```
    获取所有字段的值
    
    参数:
    obj - bean对象
    
    返回:
    字段值数组
    从以下版本开始:
    
    4.1.17
  - setFieldValue
```
public static void setFieldValue(java.lang.Object obj,
                 java.lang.String fieldName,
                 java.lang.Object value)
                          throws UtilException
```
    设置字段值
    
    参数:
    obj - 对象
    fieldName - 字段名
    value - 值，值类型必须与字段类型匹配，不会自动转换对象类型
    
    抛出:
    
    UtilException - 包装IllegalAccessException异常
  - setFieldValue
```
public static void setFieldValue(java.lang.Object obj,
                 java.lang.reflect.Field field,
                 java.lang.Object value)
                          throws UtilException
```
    设置字段值
    
    参数:
    obj - 对象
    field - 字段
    value - 值，值类型必须与字段类型匹配，不会自动转换对象类型
    
    抛出:
    
    UtilException - UtilException 包装IllegalAccessException异常
  - getMethodOfObj
```
public static java.lang.reflect.Method getMethodOfObj(java.lang.Object obj,
                                      java.lang.String methodName,
                                      java.lang.Object... args)
                                               throws java.lang.SecurityException
```
    查找指定对象中的所有方法（包括非public方法），也包括父对象和Object类的方法
    
    参数:
    obj - 被查找的对象，如果为null返回null
    methodName - 方法名，如果为空字符串返回null
    args - 参数
    
    返回:
    方法
    
    抛出:
    
    java.lang.SecurityException - 无访问权限抛出异常
  - getMethodIgnoreCase
```
public static java.lang.reflect.Method getMethodIgnoreCase(java.lang.Class<?> clazz,
                                           java.lang.String methodName,
                                           java.lang.Class<?>... paramTypes)
                                                    throws java.lang.SecurityException
```
    忽略大小写查找指定方法，如果找不到对应的方法则返回null
    
    参数:
    clazz - 类，如果为null返回null
    methodName - 方法名，如果为空字符串返回null
    paramTypes - 参数类型，指定参数类型如果是方法的子类也算
    
    返回:
    方法
    
    抛出:
    
    java.lang.SecurityException - 无权访问抛出异常
    从以下版本开始:
    
    3.2.0
  - getMethod
```
public static java.lang.reflect.Method getMethod(java.lang.Class<?> clazz,
                                 java.lang.String methodName,
                                 java.lang.Class<?>... paramTypes)
                                          throws java.lang.SecurityException
```
    查找指定方法如果找不到对应的方法则返回null
    
    参数:
    clazz - 类，如果为null返回null
    methodName - 方法名，如果为空字符串返回null
    paramTypes - 参数类型，指定参数类型如果是方法的子类也算
    
    返回:
    方法
    
    抛出:
    
    java.lang.SecurityException - 无权访问抛出异常
  - getMethod
```
public static java.lang.reflect.Method getMethod(java.lang.Class<?> clazz,
                                 boolean ignoreCase,
                                 java.lang.String methodName,
                                 java.lang.Class<?>... paramTypes)
                                          throws java.lang.SecurityException
```
    查找指定方法如果找不到对应的方法则返回null
    
    参数:
    clazz - 类，如果为null返回null
    ignoreCase - 是否忽略大小写
    methodName - 方法名，如果为空字符串返回null
    paramTypes - 参数类型，指定参数类型如果是方法的子类也算
    
    返回:
    方法
    
    抛出:
    
    java.lang.SecurityException - 无权访问抛出异常
    从以下版本开始:
    
    3.2.0
  - getMethodNames
```
public static java.util.Set<java.lang.String> getMethodNames(java.lang.Class<?> clazz)
                                                      throws java.lang.SecurityException
```
    获得指定类中的Public方法名
    去重重载的方法
    
    参数:
    clazz - 类
    
    返回:
    方法名Set
    
    抛出:
    
    java.lang.SecurityException - 安全异常
  - getMethods
```
public static java.lang.reflect.Method[] getMethods(java.lang.Class<?> clazz,
                                    Filter<java.lang.reflect.Method> filter)
                                             throws java.lang.SecurityException
```
    获得指定类过滤后的Public方法列表
    
    参数:
    clazz - 查找方法的类
    filter - 过滤器
    
    返回:
    过滤后的方法列表
    
    抛出:
    
    java.lang.SecurityException - 安全异常
  - getMethods
```
public static java.lang.reflect.Method[] getMethods(java.lang.Class<?> beanClass)
                                             throws java.lang.SecurityException
```
    获得一个类中所有方法列表，包括其父类中的方法
    
    参数:
    beanClass - 类
    
    返回:
    方法列表
    
    抛出:
    
    java.lang.SecurityException - 安全检查异常
  - getMethodsDirectly
```
public static java.lang.reflect.Method[] getMethodsDirectly(java.lang.Class<?> beanClass,
                                            boolean withSuperClassMethods)
                                                     throws java.lang.SecurityException
```
    获得一个类中所有方法列表，直接反射获取，无缓存
    
    参数:
    beanClass - 类
    withSuperClassMethods - 是否包括父类的方法列表
    
    返回:
    方法列表
    
    抛出:
    
    java.lang.SecurityException - 安全检查异常
  - isEqualsMethod
```
public static boolean isEqualsMethod(java.lang.reflect.Method method)
```
    是否为equals方法
    
    参数:
    method - 方法
    
    返回:
    是否为equals方法
  - isHashCodeMethod
```
public static boolean isHashCodeMethod(java.lang.reflect.Method method)
```
    是否为hashCode方法
    
    参数:
    method - 方法
    
    返回:
    是否为hashCode方法
  - isToStringMethod
```
public static boolean isToStringMethod(java.lang.reflect.Method method)
```
    是否为toString方法
    
    参数:
    method - 方法
    
    返回:
    是否为toString方法
  - newInstance
```
public static <T> T newInstance(java.lang.String clazz)
                     throws UtilException
```
    实例化对象
    
    类型参数:
    T - 对象类型
    参数:
    clazz - 类名
    
    返回:
    对象
    
    抛出:
    
    UtilException - 包装各类异常
  - newInstance
```
public static <T> T newInstance(java.lang.Class<T> clazz,
                java.lang.Object... params)
                     throws UtilException
```
    实例化对象
    
    类型参数:
    T - 对象类型
    参数:
    clazz - 类
    params - 构造函数参数
    
    返回:
    对象
    
    抛出:
    
    UtilException - 包装各类异常
  - newInstanceIfPossible
```
public static <T> T newInstanceIfPossible(java.lang.Class<T> beanClass)
```
    尝试遍历并调用此类的所有构造方法，直到构造成功并返回
    
    类型参数:
    T - 对象类型
    参数:
    beanClass - 被构造的类
    
    返回:
    构造后的对象
  - invokeStatic
```
public static <T> T invokeStatic(java.lang.reflect.Method method,
                 java.lang.Object... args)
                      throws UtilException
```
    执行静态方法
    
    类型参数:
    T - 对象类型
    参数:
    method - 方法（对象方法或static方法都可）
    args - 参数对象
    
    返回:
    结果
    
    抛出:
    
    UtilException - 多种异常包装
  - invokeWithCheck
```
public static <T> T invokeWithCheck(java.lang.Object obj,
                    java.lang.reflect.Method method,
                    java.lang.Object... args)
                         throws UtilException
```
    执行方法
    执行前要检查给定参数：
```
 1. 参数个数是否与方法参数个数一致
 2. 如果某个参数为null但是方法这个位置的参数为原始类型，则赋予原始类型默认值
 
```
    类型参数:
    T - 返回对象类型
    参数:
    obj - 对象，如果执行静态方法，此值为null
    method - 方法（对象方法或static方法都可）
    args - 参数对象
    
    返回:
    结果
    
    抛出:
    
    UtilException - 一些列异常的包装
  - invoke
```
public static <T> T invoke(java.lang.Object obj,
           java.lang.reflect.Method method,
           java.lang.Object... args)
                throws UtilException
```
    执行方法
    
    类型参数:
    T - 返回对象类型
    参数:
    obj - 对象，如果执行静态方法，此值为null
    method - 方法（对象方法或static方法都可）
    args - 参数对象
    
    返回:
    结果
    
    抛出:
    
    UtilException - 一些列异常的包装
  - invoke
```
public static <T> T invoke(java.lang.Object obj,
           java.lang.String methodName,
           java.lang.Object... args)
                throws UtilException
```
    执行对象中指定方法
    
    类型参数:
    T - 返回对象类型
    参数:
    obj - 方法所在对象
    methodName - 方法名
    args - 参数列表
    
    返回:
    执行结果
    
    抛出:
    
    UtilException - IllegalAccessException包装
    从以下版本开始:
    
    3.1.2

类 ReflectUtil

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

ReflectUtil

方法详细资料

getConstructor

getConstructors

getConstructorsDirectly

getField

getFields

getFieldsDirectly

getFieldValue

getFieldValue

getFieldsValue

setFieldValue

setFieldValue

getMethodOfObj

getMethodIgnoreCase

getMethod

getMethod

getMethodNames

getMethods

getMethods

getMethodsDirectly

isEqualsMethod

isHashCodeMethod

isToStringMethod

newInstance

newInstance

newInstanceIfPossible

invokeStatic

invokeWithCheck

invoke

invoke