com.xiaoleilu.hutool.util.BeanUtil Maven / Gradle / Ivy
package com.xiaoleilu.hutool.util;
import java.beans.IntrospectionException;
import java.beans.Introspector;
import java.beans.PropertyDescriptor;
import java.beans.PropertyEditor;
import java.beans.PropertyEditorManager;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Map.Entry;
import com.xiaoleilu.hutool.convert.Convert;
import com.xiaoleilu.hutool.exceptions.UtilException;
/**
* Bean工具类
*
* @author Looly
*
*/
public final class BeanUtil {
private BeanUtil() {}
/**
* 判断是否为Bean对象
* @param clazz 待测试类
* @return 是否为Bean对象
*/
public static boolean isBean(Class clazz){
if(ClassUtil.isNormalClass(clazz)){
Method[] methods = clazz.getMethods();
for (Method method : methods) {
if(method.getParameterTypes().length == 1 && method.getName().startsWith("set")){
//检测包含标准的setXXX方法即视为标准的JavaBean
return true;
}
}
}
return false;
}
public static PropertyEditor findEditor(Class type){
return PropertyEditorManager.findEditor(type);
}
/**
* 获得Bean字段描述数组
*
* @param clazz Bean类
* @return 字段描述数组
* @throws IntrospectionException
*/
public static PropertyDescriptor[] getPropertyDescriptors(Class clazz) throws IntrospectionException {
return Introspector.getBeanInfo(clazz).getPropertyDescriptors();
}
/**
* 获得字段名和字段描述Map
* @param clazz Bean类
* @return 字段名和字段描述Map
* @throws IntrospectionException
*/
public static Map getFieldNamePropertyDescriptorMap(Class clazz) throws IntrospectionException{
final PropertyDescriptor[] propertyDescriptors = getPropertyDescriptors(clazz);
Map map = new HashMap<>();
for (PropertyDescriptor propertyDescriptor : propertyDescriptors) {
map.put(propertyDescriptor.getName(), propertyDescriptor);
}
return map;
}
/**
* 获得Bean类属性描述
*
* @param clazz Bean类
* @param fieldName 字段名
* @return PropertyDescriptor
* @throws IntrospectionException
*/
public static PropertyDescriptor getPropertyDescriptor(Class clazz, final String fieldName) throws IntrospectionException {
PropertyDescriptor[] propertyDescriptors = getPropertyDescriptors(clazz);
for (PropertyDescriptor propertyDescriptor : propertyDescriptors) {
if (ObjectUtil.equal(fieldName, propertyDescriptor.getName())) {
return propertyDescriptor;
}
}
return null;
}
/**
* Map转换为Bean对象
*
* @param map {@link Map}
* @param beanClass Bean Class
* @param isIgnoreError 是否忽略注入错误
* @return Bean
*/
public static T mapToBean(Map map, Class beanClass, boolean isIgnoreError) {
return fillBeanWithMap(map, ClassUtil.newInstance(beanClass), isIgnoreError);
}
/**
* Map转换为Bean对象
* 忽略大小写
*
* @param map Map
* @param beanClass Bean Class
* @param isIgnoreError 是否忽略注入错误
* @return Bean
*/
public static T mapToBeanIgnoreCase(Map map, Class beanClass, boolean isIgnoreError) {
return fillBeanWithMapIgnoreCase(map, ClassUtil.newInstance(beanClass), isIgnoreError);
}
/**
* 使用Map填充Bean对象
*
* @param map Map
* @param bean Bean
* @param isIgnoreError 是否忽略注入错误
* @return Bean
*/
public static T fillBeanWithMap(final Map map, T bean, final boolean isIgnoreError) {
return fillBean(bean, new ValueProvider(){
@Override
public Object value(String name) {
return map.get(name);
}
@Override
public boolean isIgnoreError() {
return isIgnoreError;
}
});
}
/**
* 使用Map填充Bean对象，可配置将下划线转换为驼峰
*
* @param map Map
* @param bean Bean
* @param isToCamelCase 是否将下划线模式转换为驼峰模式
* @param isIgnoreError 是否忽略注入错误
* @return Bean
*/
public static T fillBeanWithMap(Map map, T bean, boolean isToCamelCase, boolean isIgnoreError) {
if(isToCamelCase){
final Map map2 = new HashMap();
for (Entry entry : map.entrySet()) {
final Object key = entry.getKey();
if (null != key && key instanceof String) {
final String keyStr = (String) key;
map2.put(StrUtil.toCamelCase(keyStr), entry.getValue());
} else {
map2.put(key, entry.getValue());
}
}
return fillBeanWithMap(map2, bean, isIgnoreError);
}
return fillBeanWithMap(map, bean, isIgnoreError);
}
/**
* 使用Map填充Bean对象，忽略大小写
*
* @param map Map
* @param bean Bean
* @param isIgnoreError 是否忽略注入错误
* @return Bean
*/
public static T fillBeanWithMapIgnoreCase(Map map, T bean, final boolean isIgnoreError) {
final Map map2 = new HashMap();
for (Entry entry : map.entrySet()) {
final Object key = entry.getKey();
if (key instanceof String) {
final String keyStr = (String) key;
map2.put(keyStr.toLowerCase(), entry.getValue());
} else {
map2.put(key, entry.getValue());
}
}
return fillBean(bean, new ValueProvider(){
@Override
public Object value(String name) {
return map2.get(name.toLowerCase());
}
@Override
public boolean isIgnoreError() {
return isIgnoreError;
}
});
}
/**
* ServletRequest 参数转Bean
*
* @param request ServletRequest
* @param beanClass Bean Class
* @param isIgnoreError 是否忽略注入错误
* @return Bean
*/
public static T requestParamToBean(javax.servlet.ServletRequest request, Class beanClass, boolean isIgnoreError) {
return fillBeanWithRequestParam(request, ClassUtil.newInstance(beanClass), isIgnoreError);
}
/**
* ServletRequest 参数转Bean
*
* @param request ServletRequest
* @param bean Bean
* @param isIgnoreError 是否忽略注入错误
* @return Bean
*/
public static T fillBeanWithRequestParam(final javax.servlet.ServletRequest request, T bean, final boolean isIgnoreError) {
final String beanName = StrUtil.lowerFirst(bean.getClass().getSimpleName());
return fillBean(bean, new ValueProvider(){
@Override
public Object value(String name) {
String value = request.getParameter(name);
if (StrUtil.isEmpty(value)) {
// 使用类名前缀尝试查找值
value = request.getParameter(beanName + StrUtil.DOT + name);
if (StrUtil.isEmpty(value)) {
// 此处取得的值为空时跳过，包括null和""
value = null;
}
}
return value;
}
@Override
public boolean isIgnoreError() {
return isIgnoreError;
}
});
}
/**
* ServletRequest 参数转Bean
*
* @param
* @param beanClass Bean Class
* @param valueProvider 值提供者
* @return Bean
*/
public static T toBean(Class beanClass, ValueProvider valueProvider) {
return fillBean(ClassUtil.newInstance(beanClass), valueProvider);
}
/**
* 填充Bean
*
* @param
* @param bean Bean
* @param valueProvider 值提供者
* @return Bean
*/
public static T fillBean(T bean, ValueProvider valueProvider) {
if (null == valueProvider) {
return bean;
}
Class beanClass = bean.getClass();
try {
PropertyDescriptor[] propertyDescriptors = getPropertyDescriptors(beanClass);
String propertyName;
Object value;
for (PropertyDescriptor property : propertyDescriptors) {
propertyName = property.getName();
value = valueProvider.value(propertyName);
if (null == value) {
// 此处取得的值为空时跳过
continue;
}
try {
property.getWriteMethod().invoke(bean, Convert.convert(property.getPropertyType(), value));
} catch (Exception e) {
if(valueProvider.isIgnoreError()){
// StaticLog.warn("Inject [{}] error: {}", property.getName(), e.getMessage());
continue;
}else{
throw new UtilException(e, "Inject [{}] error!", property.getName());
}
}
}
} catch (Exception e) {
throw new UtilException(e);
}
return bean;
}
/**
* 对象转Map，不进行驼峰转下划线，不忽略值为空的字段
*
* @param bean bean对象
* @return Map
*/
public static Map beanToMap(T bean) {
return beanToMap(bean, false, false);
}
/**
* 对象转Map
*
* @param bean bean对象
* @param isToUnderlineCase 是否转换为下划线模式
* @param ignoreNullValue 是否忽略值为空的字段
* @return Map
*/
public static Map beanToMap(T bean, boolean isToUnderlineCase, boolean ignoreNullValue) {
if (bean == null) {
return null;
}
Map map = new HashMap();
try {
final PropertyDescriptor[] propertyDescriptors = getPropertyDescriptors(bean.getClass());
for (PropertyDescriptor property : propertyDescriptors) {
String key = property.getName();
// 过滤class属性
if (false == key.equals("class")) {
// 得到property对应的getter方法
Method getter = property.getReadMethod();
Object value = getter.invoke(bean);
if (false == ignoreNullValue || null != value) {
map.put(isToUnderlineCase ? StrUtil.toUnderlineCase(key) : key, value);
}
}
}
} catch (Exception e) {
throw new UtilException(e);
}
return map;
}
/**
* 复制Bean对象属性
* @param source 源Bean对象
* @param target 目标Bean对象
*/
public static void copyProperties(Object source, Object target) {
copyProperties(source, target, CopyOptions.create());
}
/**
* 复制Bean对象属性
* 限制类用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类
* @param source 源Bean对象
* @param target 目标Bean对象
* @param ignoreProperties 不拷贝的的属性列表
*/
public static void copyProperties(Object source, Object target, String... ignoreProperties) {
copyProperties(source, target, CopyOptions.create().setIgnoreProperties(ignoreProperties));
}
/**
* 复制Bean对象属性
* 限制类用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类
* @param source 源Bean对象
* @param target 目标Bean对象
* @param copyOptions 拷贝选项，见 {@link CopyOptions}
*/
public static void copyProperties(Object source, Object target, CopyOptions copyOptions) {
if(null == copyOptions){
copyOptions = new CopyOptions();
}
Class actualEditable = target.getClass();
if (copyOptions.editable != null) {
//检查限制类是否为target的父类或接口
if (!copyOptions.editable.isInstance(target)) {
throw new IllegalArgumentException(StrUtil.format("Target class [{}] not assignable to Editable class [{}]", target.getClass().getName(), copyOptions.editable.getName()));
}
actualEditable = copyOptions.editable;
}
PropertyDescriptor[] targetPds = null;
Map sourcePdMap;
try {
sourcePdMap = getFieldNamePropertyDescriptorMap(source.getClass());
targetPds = getPropertyDescriptors(actualEditable);
} catch (IntrospectionException e) {
throw new UtilException(e);
}
HashSet ignoreSet = copyOptions.ignoreProperties != null ? CollectionUtil.newHashSet(copyOptions.ignoreProperties) : null;
for (PropertyDescriptor targetPd : targetPds) {
Method writeMethod = targetPd.getWriteMethod();
if (writeMethod != null && (ignoreSet == null || false == ignoreSet.contains(targetPd.getName()))) {
PropertyDescriptor sourcePd = sourcePdMap.get(targetPd.getName());
if (sourcePd != null) {
Method readMethod = sourcePd.getReadMethod();
// 源对象字段的getter方法返回值必须可转换为目标对象setter方法的第一个参数
if (readMethod != null && ClassUtil.isAssignable(writeMethod.getParameterTypes()[0], readMethod.getReturnType())) {
try {
Object value = ClassUtil.setAccessible(readMethod).invoke(source);
if(null != value || false == copyOptions.isIgnoreNullValue){
ClassUtil.setAccessible(writeMethod).invoke(target, value);
}
} catch (Throwable ex) {
if(copyOptions.isIgnoreError){
// StaticLog.warn("Copy property [{}] to [{}] error: {}", sourcePd.getName(), targetPd.getName(), ex.getMessage());
continue;
}
throw new UtilException(ex, "Copy property [{}] to [{}] error: {}", sourcePd.getName(), targetPd.getName(), ex.getMessage());
}
}
}
}
}
}
/**
* 值提供者，用于提供Bean注入时参数对应值得抽象接口
* 继承或匿名实例化此接口
* 在Bean注入过程中，Bean获得字段名，通过外部方式根据这个字段名查找相应的字段值，然后注入Bean
*
* @author Looly
*
*/
public static interface ValueProvider {
/**
* 获取值
*
* @param name Bean对象中参数名
* @return 对应参数名的值
*/
public Object value(String name);
/**
* 是否忽略字段的注入错误
*/
public boolean isIgnoreError();
}
/**
* 属性拷贝选项
* 包括：
* 1、限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类
* 2、是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
* 3、忽略的属性列表，设置一个属性列表，不拷贝这些属性值
*
* @author Looly
*/
public static class CopyOptions {
/** 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类 */
private Class editable;
/** 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null */
private boolean isIgnoreNullValue;
/** 忽略的属性列表，设置一个属性列表，不拷贝这些属性值 */
private String[] ignoreProperties;
/** 是否忽略字段注入错误 */
private boolean isIgnoreError;
/**
* 创建拷贝选项
* @return 拷贝选项
*/
public static CopyOptions create(){
return new CopyOptions();
}
/**
* 创建拷贝选项
* @param editable 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性
* @param isIgnoreNullValue 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
* @param ignoreProperties 忽略的属性列表，设置一个属性列表，不拷贝这些属性值
* @return 拷贝选项
*/
public static CopyOptions create(Class editable, boolean isIgnoreNullValue, String... ignoreProperties){
return new CopyOptions(editable, isIgnoreNullValue, ignoreProperties);
}
/**
* 构造拷贝选项
*/
public CopyOptions() {
}
/**
* 构造拷贝选项
* @param editable 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性
* @param isIgnoreNullValue 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
* @param ignoreProperties 忽略的属性列表，设置一个属性列表，不拷贝这些属性值
*/
public CopyOptions(Class editable, boolean isIgnoreNullValue, String... ignoreProperties) {
this.editable = editable;
this.isIgnoreNullValue = isIgnoreNullValue;
this.ignoreProperties = ignoreProperties;
}
/**
* 设置限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性
* @param editable 限制的类或接口
* @return CopyOptions
*/
public CopyOptions setEditable(Class editable){
this.editable = editable;
return this;
}
/**
* 设置是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
* @param isIgnoreNullVall 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
* @return CopyOptions
*/
public CopyOptions setIgnoreNullValue(boolean isIgnoreNullVall){
this.isIgnoreNullValue = isIgnoreNullVall;
return this;
}
/**
* 设置忽略的属性列表，设置一个属性列表，不拷贝这些属性值
* @param ignoreProperties 忽略的属性列表，设置一个属性列表，不拷贝这些属性值
* @return CopyOptions
*/
public CopyOptions setIgnoreProperties(String... ignoreProperties){
this.ignoreProperties = ignoreProperties;
return this;
}
/**
* 设置是否忽略字段的注入错误
* @param isIgnoreError 是否忽略
*/
public void setIgnoreError(boolean isIgnoreError) {
this.isIgnoreError = isIgnoreError;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy