package com.ruoyi.common.utils.reflect;
|
|
import java.lang.reflect.Field;
|
import java.lang.reflect.InvocationTargetException;
|
import java.lang.reflect.Method;
|
import java.lang.reflect.Modifier;
|
import java.lang.reflect.ParameterizedType;
|
import java.lang.reflect.Type;
|
import java.util.ArrayList;
|
import java.util.Arrays;
|
import java.util.Date;
|
import java.util.HashSet;
|
import java.util.List;
|
import java.util.Objects;
|
import java.util.Set;
|
import org.apache.commons.lang3.StringUtils;
|
import org.apache.commons.lang3.Validate;
|
import org.apache.poi.ss.usermodel.DateUtil;
|
import org.slf4j.Logger;
|
import org.slf4j.LoggerFactory;
|
import com.ruoyi.common.core.text.Convert;
|
import com.ruoyi.common.utils.DateUtils;
|
|
/**
|
* 反射工具类. 提供调用getter/setter方法, 访问私有变量, 调用私有方法, 获取泛型类型Class, 被AOP过的真实类等工具函数.
|
*
|
* @author ruoyi
|
*/
|
@SuppressWarnings("rawtypes")
|
public class ReflectUtils
|
{
|
private static final String SETTER_PREFIX = "set";
|
|
private static final String GETTER_PREFIX = "get";
|
|
private static final String CGLIB_CLASS_SEPARATOR = "$$";
|
|
private static Logger logger = LoggerFactory.getLogger(ReflectUtils.class);
|
|
/**
|
* 调用Getter方法.
|
* 支持多级，如：对象名.对象名.方法
|
*/
|
@SuppressWarnings("unchecked")
|
public static <E> E invokeGetter(Object obj, String propertyName)
|
{
|
Object object = obj;
|
for (String name : StringUtils.split(propertyName, "."))
|
{
|
String getterMethodName = GETTER_PREFIX + StringUtils.capitalize(name);
|
object = invokeMethod(object, getterMethodName, new Class[] {}, new Object[] {});
|
}
|
return (E) object;
|
}
|
|
/**
|
* 调用Setter方法, 仅匹配方法名。
|
* 支持多级，如：对象名.对象名.方法
|
*/
|
public static <E> void invokeSetter(Object obj, String propertyName, E value)
|
{
|
Object object = obj;
|
String[] names = StringUtils.split(propertyName, ".");
|
for (int i = 0; i < names.length; i++)
|
{
|
if (i < names.length - 1)
|
{
|
String getterMethodName = GETTER_PREFIX + StringUtils.capitalize(names[i]);
|
object = invokeMethod(object, getterMethodName, new Class[] {}, new Object[] {});
|
}
|
else
|
{
|
String setterMethodName = SETTER_PREFIX + StringUtils.capitalize(names[i]);
|
invokeMethodByName(object, setterMethodName, new Object[] { value });
|
}
|
}
|
}
|
|
/**
|
* 直接读取对象属性值, 无视private/protected修饰符, 不经过getter函数.
|
*/
|
@SuppressWarnings("unchecked")
|
public static <E> E getFieldValue(final Object obj, final String fieldName)
|
{
|
Field field = getAccessibleField(obj, fieldName);
|
if (field == null)
|
{
|
logger.debug("在 [" + obj.getClass() + "] 中，没有找到 [" + fieldName + "] 字段 ");
|
return null;
|
}
|
E result = null;
|
try
|
{
|
result = (E) field.get(obj);
|
}
|
catch (IllegalAccessException e)
|
{
|
logger.error("不可能抛出的异常{}", e.getMessage());
|
}
|
return result;
|
}
|
|
/**
|
* 直接设置对象属性值, 无视private/protected修饰符, 不经过setter函数.
|
*/
|
public static <E> void setFieldValue(final Object obj, final String fieldName, final E value)
|
{
|
Field field = getAccessibleField(obj, fieldName);
|
if (field == null)
|
{
|
// throw new IllegalArgumentException("在 [" + obj.getClass() + "] 中，没有找到 [" + fieldName + "] 字段 ");
|
logger.debug("在 [" + obj.getClass() + "] 中，没有找到 [" + fieldName + "] 字段 ");
|
return;
|
}
|
try
|
{
|
field.set(obj, value);
|
}
|
catch (IllegalAccessException e)
|
{
|
logger.error("不可能抛出的异常: {}", e.getMessage());
|
}
|
}
|
|
/**
|
* 直接调用对象方法, 无视private/protected修饰符.
|
* 用于一次性调用的情况，否则应使用getAccessibleMethod()函数获得Method后反复调用.
|
* 同时匹配方法名+参数类型，
|
*/
|
@SuppressWarnings("unchecked")
|
public static <E> E invokeMethod(final Object obj, final String methodName, final Class<?>[] parameterTypes,
|
final Object[] args)
|
{
|
if (obj == null || methodName == null)
|
{
|
return null;
|
}
|
Method method = getAccessibleMethod(obj, methodName, parameterTypes);
|
if (method == null)
|
{
|
logger.debug("在 [" + obj.getClass() + "] 中，没有找到 [" + methodName + "] 方法 ");
|
return null;
|
}
|
try
|
{
|
return (E) method.invoke(obj, args);
|
}
|
catch (Exception e)
|
{
|
String msg = "method: " + method + ", obj: " + obj + ", args: " + args + "";
|
throw convertReflectionExceptionToUnchecked(msg, e);
|
}
|
}
|
|
/**
|
* 直接调用对象方法, 无视private/protected修饰符，
|
* 用于一次性调用的情况，否则应使用getAccessibleMethodByName()函数获得Method后反复调用.
|
* 只匹配函数名，如果有多个同名函数调用第一个。
|
*/
|
@SuppressWarnings("unchecked")
|
public static <E> E invokeMethodByName(final Object obj, final String methodName, final Object[] args)
|
{
|
Method method = getAccessibleMethodByName(obj, methodName, args.length);
|
if (method == null)
|
{
|
// 如果为空不报错，直接返回空。
|
logger.debug("在 [" + obj.getClass() + "] 中，没有找到 [" + methodName + "] 方法 ");
|
return null;
|
}
|
try
|
{
|
// 类型转换（将参数数据类型转换为目标方法参数类型）
|
Class<?>[] cs = method.getParameterTypes();
|
for (int i = 0; i < cs.length; i++)
|
{
|
if (args[i] != null && !args[i].getClass().equals(cs[i]))
|
{
|
if (cs[i] == String.class)
|
{
|
args[i] = Convert.toStr(args[i]);
|
if (StringUtils.endsWith((String) args[i], ".0"))
|
{
|
args[i] = StringUtils.substringBefore((String) args[i], ".0");
|
}
|
}
|
else if (cs[i] == Integer.class)
|
{
|
args[i] = Convert.toInt(args[i]);
|
}
|
else if (cs[i] == Long.class)
|
{
|
args[i] = Convert.toLong(args[i]);
|
}
|
else if (cs[i] == Double.class)
|
{
|
args[i] = Convert.toDouble(args[i]);
|
}
|
else if (cs[i] == Float.class)
|
{
|
args[i] = Convert.toFloat(args[i]);
|
}
|
else if (cs[i] == Date.class)
|
{
|
if (args[i] instanceof String)
|
{
|
args[i] = DateUtils.parseDate(args[i]);
|
}
|
else
|
{
|
args[i] = DateUtil.getJavaDate((Double) args[i]);
|
}
|
}
|
else if (cs[i] == boolean.class || cs[i] == Boolean.class)
|
{
|
args[i] = Convert.toBool(args[i]);
|
}
|
}
|
}
|
return (E) method.invoke(obj, args);
|
}
|
catch (Exception e)
|
{
|
String msg = "method: " + method + ", obj: " + obj + ", args: " + args + "";
|
throw convertReflectionExceptionToUnchecked(msg, e);
|
}
|
}
|
|
/**
|
* 循环向上转型, 获取对象的DeclaredField, 并强制设置为可访问.
|
* 如向上转型到Object仍无法找到, 返回null.
|
*/
|
public static Field getAccessibleField(final Object obj, final String fieldName)
|
{
|
// 为空不报错。直接返回 null
|
if (obj == null)
|
{
|
return null;
|
}
|
Validate.notBlank(fieldName, "fieldName can't be blank");
|
for (Class<?> superClass = obj.getClass(); superClass != Object.class; superClass = superClass.getSuperclass())
|
{
|
try
|
{
|
Field field = superClass.getDeclaredField(fieldName);
|
makeAccessible(field);
|
return field;
|
}
|
catch (NoSuchFieldException e)
|
{
|
continue;
|
}
|
}
|
return null;
|
}
|
|
/**
|
* 循环向上转型, 获取对象的DeclaredMethod,并强制设置为可访问.
|
* 如向上转型到Object仍无法找到, 返回null.
|
* 匹配函数名+参数类型。
|
* 用于方法需要被多次调用的情况. 先使用本函数先取得Method,然后调用Method.invoke(Object obj, Object... args)
|
*/
|
public static Method getAccessibleMethod(final Object obj, final String methodName,
|
final Class<?>... parameterTypes)
|
{
|
// 为空不报错。直接返回 null
|
if (obj == null)
|
{
|
return null;
|
}
|
Validate.notBlank(methodName, "methodName can't be blank");
|
for (Class<?> searchType = obj.getClass(); searchType != Object.class; searchType = searchType.getSuperclass())
|
{
|
try
|
{
|
Method method = searchType.getDeclaredMethod(methodName, parameterTypes);
|
makeAccessible(method);
|
return method;
|
}
|
catch (NoSuchMethodException e)
|
{
|
continue;
|
}
|
}
|
return null;
|
}
|
|
/**
|
* 循环向上转型, 获取对象的DeclaredMethod,并强制设置为可访问.
|
* 如向上转型到Object仍无法找到, 返回null.
|
* 只匹配函数名。
|
* 用于方法需要被多次调用的情况. 先使用本函数先取得Method,然后调用Method.invoke(Object obj, Object... args)
|
*/
|
public static Method getAccessibleMethodByName(final Object obj, final String methodName, int argsNum)
|
{
|
// 为空不报错。直接返回 null
|
if (obj == null)
|
{
|
return null;
|
}
|
Validate.notBlank(methodName, "methodName can't be blank");
|
for (Class<?> searchType = obj.getClass(); searchType != Object.class; searchType = searchType.getSuperclass())
|
{
|
Method[] methods = searchType.getDeclaredMethods();
|
for (Method method : methods)
|
{
|
if (method.getName().equals(methodName) && method.getParameterTypes().length == argsNum)
|
{
|
makeAccessible(method);
|
return method;
|
}
|
}
|
}
|
return null;
|
}
|
|
/**
|
* 改变private/protected的方法为public，尽量不调用实际改动的语句，避免JDK的SecurityManager抱怨。
|
*/
|
public static void makeAccessible(Method method)
|
{
|
if ((!Modifier.isPublic(method.getModifiers()) || !Modifier.isPublic(method.getDeclaringClass().getModifiers()))
|
&& !method.isAccessible())
|
{
|
method.setAccessible(true);
|
}
|
}
|
|
/**
|
* 改变private/protected的成员变量为public，尽量不调用实际改动的语句，避免JDK的SecurityManager抱怨。
|
*/
|
public static void makeAccessible(Field field)
|
{
|
if ((!Modifier.isPublic(field.getModifiers()) || !Modifier.isPublic(field.getDeclaringClass().getModifiers())
|
|| Modifier.isFinal(field.getModifiers())) && !field.isAccessible())
|
{
|
field.setAccessible(true);
|
}
|
}
|
|
/**
|
* 通过反射, 获得Class定义中声明的泛型参数的类型, 注意泛型必须定义在父类处
|
* 如无法找到, 返回Object.class.
|
*/
|
@SuppressWarnings("unchecked")
|
public static <T> Class<T> getClassGenricType(final Class clazz)
|
{
|
return getClassGenricType(clazz, 0);
|
}
|
|
/**
|
* 通过反射, 获得Class定义中声明的父类的泛型参数的类型.
|
* 如无法找到, 返回Object.class.
|
*/
|
public static Class getClassGenricType(final Class clazz, final int index)
|
{
|
Type genType = clazz.getGenericSuperclass();
|
|
if (!(genType instanceof ParameterizedType))
|
{
|
logger.debug(clazz.getSimpleName() + "'s superclass not ParameterizedType");
|
return Object.class;
|
}
|
|
Type[] params = ((ParameterizedType) genType).getActualTypeArguments();
|
|
if (index >= params.length || index < 0)
|
{
|
logger.debug("Index: " + index + ", Size of " + clazz.getSimpleName() + "'s Parameterized Type: "
|
+ params.length);
|
return Object.class;
|
}
|
if (!(params[index] instanceof Class))
|
{
|
logger.debug(clazz.getSimpleName() + " not set the actual class on superclass generic parameter");
|
return Object.class;
|
}
|
|
return (Class) params[index];
|
}
|
|
public static Class<?> getUserClass(Object instance)
|
{
|
if (instance == null)
|
{
|
throw new RuntimeException("Instance must not be null");
|
}
|
Class clazz = instance.getClass();
|
if (clazz != null && clazz.getName().contains(CGLIB_CLASS_SEPARATOR))
|
{
|
Class<?> superClass = clazz.getSuperclass();
|
if (superClass != null && !Object.class.equals(superClass))
|
{
|
return superClass;
|
}
|
}
|
return clazz;
|
|
}
|
|
/**
|
* 将反射时的checked exception转换为unchecked exception.
|
*/
|
public static RuntimeException convertReflectionExceptionToUnchecked(String msg, Exception e)
|
{
|
if (e instanceof IllegalAccessException || e instanceof IllegalArgumentException
|
|| e instanceof NoSuchMethodException)
|
{
|
return new IllegalArgumentException(msg, e);
|
}
|
else if (e instanceof InvocationTargetException)
|
{
|
return new RuntimeException(msg, ((InvocationTargetException) e).getTargetException());
|
}
|
return new RuntimeException(msg, e);
|
}
|
|
/**
|
* 比较两个相同类型对象的所有字段值是否相等
|
* 使用反射获取所有字段（包括父类字段），并逐个比较
|
*
|
* @param obj1 第一个对象
|
* @param obj2 第二个对象
|
* @return 如果所有字段值都相等返回true，否则返回false
|
* *示例1：比较所有字段
|
* * boolean result = ReflectUtils.equalsAllFields(user1, user2);
|
*/
|
public static boolean equalsAllFields(Object obj1, Object obj2)
|
{
|
return equalsAllFields(obj1, obj2, new String[]{});
|
}
|
|
/**
|
* 比较两个相同类型对象的所有字段值是否相等（可排除指定字段）
|
* 使用反射获取所有字段（包括父类字段），并逐个比较
|
*
|
* @param obj1 第一个对象
|
* @param obj2 第二个对象
|
* @param excludeFields 要排除的字段名称数组
|
* @return 如果所有字段值都相等返回true，否则返回false
|
* // 示例2：排除分页参数
|
* * boolean result = ReflectUtils.equalsAllFields(vo1, vo2, "pageNum", "pageSize");
|
*/
|
public static boolean equalsAllFields(Object obj1, Object obj2, String... excludeFields)
|
{
|
// 两个对象都为null，认为相等
|
if (obj1 == null && obj2 == null) return true;
|
|
// 只有一个为null，不相等
|
if (obj1 == null || obj2 == null) return false;
|
|
// 如果是同一个对象引用，直接返回true
|
if (obj1 == obj2) return true;
|
|
// 类型不同，不相等
|
if (!obj1.getClass().equals(obj2.getClass())) return false;
|
|
// 将排除字段转换为Set，便于快速查找
|
Set<String> excludeFieldSet = new HashSet<>(Arrays.asList(excludeFields));
|
|
// 获取所有字段（包括父类字段）
|
List<Field> allFields = getAllFields(obj1);
|
|
// 逐个比较字段值
|
for (Field field : allFields)
|
{
|
// 跳过排除的字段
|
if (excludeFieldSet.contains(field.getName())) continue;
|
|
// 跳过static和transient字段
|
if (Modifier.isStatic(field.getModifiers()) || Modifier.isTransient(field.getModifiers()))
|
{
|
continue;
|
}
|
|
try{
|
makeAccessible(field);
|
Object value1 = field.get(obj1);
|
Object value2 = field.get(obj2);
|
|
// 使用Objects.equals进行比较，可以正确处理null值
|
if (!Objects.equals(value1, value2))
|
{
|
//logger.debug("字段 [{}] 的值不相等: obj1={}, obj2={}", field.getName(), value1, value2);
|
return false;
|
}
|
}catch (IllegalAccessException e)
|
{
|
//logger.error("访问字段 [{}] 时发生错误: {}", field.getName(), e.getMessage());
|
return false;
|
}
|
}
|
|
return true;
|
}
|
|
/**
|
* 获取对象的所有字段（包括父类字段）
|
*
|
* @param obj 目标对象
|
* @return 所有字段的列表
|
*/
|
public static List<Field> getAllFields(Object obj)
|
{
|
List<Field> allFields = new ArrayList<>();
|
Class<?> clazz = obj.getClass();
|
|
// 循环向上遍历父类，获取所有字段
|
while (clazz != null && clazz != Object.class)
|
{
|
Field[] fields = clazz.getDeclaredFields();
|
allFields.addAll(Arrays.asList(fields));
|
clazz = clazz.getSuperclass();
|
}
|
|
return allFields;
|
}
|
|
/**
|
* 比较两个对象指定字段的值是否相等
|
*
|
* @param obj1 第一个对象
|
* @param obj2 第二个对象
|
* @param includeFields 要比较的字段名称数组
|
* @return 如果指定字段值都相等返回true，否则返回false
|
*
|
* // 示例3：只比较关键字段
|
* boolean result = ReflectUtils.equalsSpecifiedFields(user1, user2, "userId", "userName", "email");
|
*/
|
public static boolean equalsSpecifiedFields(Object obj1, Object obj2, String... includeFields)
|
{
|
// 两个对象都为null，认为相等
|
if (obj1 == null && obj2 == null) return true;
|
|
// 只有一个为null，不相等
|
if (obj1 == null || obj2 == null) return false;
|
|
// 如果是同一个对象引用，直接返回true
|
if (obj1 == obj2) return true;
|
|
// 类型不同，不相等
|
if (!obj1.getClass().equals(obj2.getClass())) return false;
|
|
// 如果没有指定字段，返回true
|
if (includeFields == null || includeFields.length == 0) return true;
|
|
// 逐个比较指定字段的值
|
for (String fieldName : includeFields)
|
{
|
Field field = getAccessibleField(obj1, fieldName);
|
if (field == null)
|
{
|
//logger.warn("在 [{}] 中未找到字段 [{}]", obj1.getClass().getName(), fieldName);
|
continue;
|
}
|
|
try
|
{
|
makeAccessible(field);
|
Object value1 = field.get(obj1);
|
Object value2 = field.get(obj2);
|
|
// 使用Objects.equals进行比较，可以正确处理null值
|
if (!Objects.equals(value1, value2))
|
{
|
//logger.debug("字段 [{}] 的值不相等: obj1={}, obj2={}", fieldName, value1, value2);
|
return false;
|
}
|
}
|
catch (IllegalAccessException e)
|
{
|
//logger.error("访问字段 [{}] 时发生错误: {}", fieldName, e.getMessage());
|
return false;
|
}
|
}
|
|
return true;
|
}
|
}
|
