com.gitee.huanminabc.utils_common.obj.reflect.FieldUtil Maven / Gradle / Ivy
package com.gitee.huanminabc.utils_common.obj.reflect;
import com.gitee.huanminabc.utils_common.base.AssertUtil;
import com.gitee.huanminabc.utils_common.base.ObjIsUtil;
import lombok.SneakyThrows;
import org.springframework.util.Assert;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.util.*;
import java.util.function.Consumer;
import java.util.function.Predicate;
/**
* 简要描述
*
* @Author: huanmin
* @Date: 2022/11/30 9:50
* @Version: 1.0
* @Description: 文件作用详细描述....
*/
public final class FieldUtil {
/**
* 获取所有field字段，包含父类继承的
*
* @param clazz 字段所属类型
* @return
*/
public static Field[] getFields(Class clazz) {
return getFields(clazz, null);
}
/**
* 获取指定类的指定field,包括父类
*
* @param clazz 字段所属类型
* @param name 字段名
* @return
*/
/**
* 获取指定类的所有的field,包括父类
*
* @param clazz 字段所属类型
* @param fieldFilter 字段过滤器
* @return 符合过滤器条件的字段数组
*/
public static Field[] getFields(Class clazz, Predicate fieldFilter) {
List fields = new ArrayList<>(32);
while (Object.class != clazz && clazz != null) {
// 获得该类所有声明的字段，即包括public、private和protected，但是不包括父类的申明字段，
// getFields：获得某个类的所有的公共（public）的字段，包括父类中的字段
for (Field field : clazz.getDeclaredFields()) {
field.setAccessible(true);
if (fieldFilter != null && !fieldFilter.test(field)) {
continue;
}
fields.add(field);
}
clazz = clazz.getSuperclass();
}
return fields.toArray(new Field[0]);
}
public static Field getField(Class clazz, String name) {
return getField(clazz, name, null);
}
/**
* 获取指定类的指定field,包括父类
*
* @param clazz 字段所属类型
* @param name 字段名
* @param type field类型
* @return Field对象
*/
public static Field getField(Class clazz, String name, Class type) {
AssertUtil.notNull(clazz, "clazz不能为空！");
AssertUtil.notNull(name, "name不能为空！");
while (clazz != Object.class && clazz != null) {
for (Field field : clazz.getDeclaredFields()) {
if (( name.equals(field.getName())) && (type == null || type.equals(field.getType()))) {
return field;
}else if(name.equalsIgnoreCase(field.getName())&& (type == null || type.equals(field.getType()))){//忽略大小写在试试
return field;
}
}
clazz = clazz.getSuperclass();
}
return null;
}
/**
* 对指定类的所有字段执行consumer操作
*
* @param clazz 目标对象
* @param consumer 对字段进行操作
*/
public static void doWithFields(Class clazz, Consumer consumer) {
Arrays.stream(getFields(clazz)).forEach(consumer);
}
/**
* 获取字段值
*
* @param field 字段
* @param target 字段所属实例对象
* @return 字段值
*/
public static Object getFieldValue(Field field, Object target) {
makeAccessible(field);
try {
return field.get(target);
} catch (Exception e) {
throw new IllegalStateException(String.format("获取%s对象的%s字段值错误!"
, target.getClass().getName(), field.getName()), e);
}
}
// 获取类全部属性的值(可以获取默认值)
@SneakyThrows
public static Map getFieldsDefaultValue(Class clazz) {
Map map=new HashMap<>();
Object o = clazz.newInstance();
for (Field declaredField : clazz.getDeclaredFields()) {
declaredField.setAccessible(true);
map.put(declaredField.getName(), declaredField.get(o));
}
return map;
}
/**
* 获取对象中指定field值
*
* @param obj 对象
* @param fieldName 字段名
* @return 字段值
*/
public static Object getFieldValue(Object obj, String fieldName) {
Assert.notNull(obj, "obj不能为空!");
if (ObjIsUtil.isWrapperOrPrimitive(obj)) {
return obj;
}
return getFieldValue(getField(obj.getClass(), fieldName), obj);
}
/**
* 设置字段为可见
*
* @param field
*/
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);
}
}
/**
* 设置字段值
*
* @param field 字段
* @param target 字段所属对象实例
* @param value 需要设置的值
*/
public static void setFieldValue(Field field, Object target, Object value) {
makeAccessible(field);
try {
field.set(target, value);
} catch (Exception e) {
throw new IllegalStateException(String.format("设置%s对象的%s字段值错误!"
, target.getClass().getName(), field.getName()), e);
}
}
/**
* 获取指定对象中指定字段路径的值(类似js访问对象属性)
* 如：Product p = new Product(new User())
* 可使用ReflectionUtils.getValueByFieldPath(p, "user.name")获取到用户的name属性
*
* @param obj 取值对象
* @param fieldPath 字段路径(形如 user.name)
* @return 字段value
*/
public static Object getValueByFieldPath(Object obj, String fieldPath) {
String[] fieldNames = fieldPath.split("\\.");
Object result = null;
for (String fieldName : fieldNames) {
result = getFieldValue(obj, fieldName);
if (result == null) {
return null;
}
obj = result;
}
return result;
}
}