BeanUtils.copyProperties使用笔记

BeanUtils.copyProperties VS PropertyUtils.copyProperties

两者最大的区别是：
BeanUtils.copyProperties会进行类型转换，而PropertyUtils.copyProperties不会。
既然进行了类型转换，那BeanUtils.copyProperties的速度比不上PropertyUtils.copyProperties。

因此，PropertyUtils.copyProperties应用的范围稍为窄一点，它只对名字和类型都一样的属性进行copy，如果名字一样但类型不一样，它会报错。

关于两者区别，http://caoyaojun1988-163-com.iteye.com/blog/1871316这篇文章总结了很多。

下面主要谈谈BeanUtils。

使用BeanUtils有几个要注意的地方：
1.对于类型为Boolean/Short/Integer/Float/Double的属性，它会转换为0：

public class User {

    private Integer intVal;
    
    private Double doubleVal;
    
    private Short shortVal;
    
    private Long longVal;
    
    private Float floatVal;
    
    private Byte byteVal;
    
    private Boolean booleanVal;
}

User src = new User();
User dest = new User();
BeanUtils.copyProperties(dest, src);
System.out.println(src);
System.out.println(dest);

//输出	
User [intVal=null, doubleVal=null, shortVal=null, longVal=null, floatVal=null, byteVal=null, booleanVal=null]
User [intVal=0, doubleVal=0.0, shortVal=0, longVal=0, floatVal=0.0, byteVal=0, booleanVal=false]

在stackoverflow上有人解释说是因为这几个类型都有对应的基本类型，在进行类型转换时，有可能遇到类似Integer -> int的转换，此时显然不能对int类型的属性赋值为null，因此统一转换为0。

如何让它不要转为0呢？可以这样：

import org.apache.commons.beanutils.converters.IntegerConverter;

IntegerConverter converter = new IntegerConverter(null); 	//默认为null，而不是0
BeanUtilsBean beanUtilsBean = new BeanUtilsBean();
beanUtilsBean.getConvertUtils().register(converter, Integer.class);

2.对于java.util.Date/BigDecimal/java.sql.Date/java.sql.Timestamp/java.sql.Time这几个类，如果值为null，则在copy时会抛异常，需要使用对应的Conveter：

public class User2 {

    private java.util.Date javaUtilDateVal;
    
    private java.sql.Date javaSqlDateVal;
    
    private java.sql.Timestamp javaSqlTimeStampVal;
    
    private BigDecimal bigDecimalVal;

    private java.sql.Time javaSqlTime;

}

User2 src = new User2();
User2 dest = new User2();

BeanUtilsBean beanUtilsBean = new BeanUtilsBean();

//如果没有下面几行，则在转换null时会抛异常，例如：org.apache.commons.beanutils.ConversionException: No value specified for 'BigDecimal'
//在org.apache.commons.beanutils.converters这个包下面有很多的Converter，可以按需要使用
beanUtilsBean.getConvertUtils().register(new org.apache.commons.beanutils.converters.BigDecimalConverter(null), BigDecimal.class);
beanUtilsBean.getConvertUtils().register(new org.apache.commons.beanutils.converters.DateConverter(null), java.util.Date.class);

beanUtilsBean.getConvertUtils().register(new org.apache.commons.beanutils.converters.SqlTimestampConverter(null), java.sql.Timestamp.class);
beanUtilsBean.getConvertUtils().register(new org.apache.commons.beanutils.converters.SqlDateConverter(null), java.sql.Date.class);
beanUtilsBean.getConvertUtils().register(new org.apache.commons.beanutils.converters.SqlTimeConverter(null), java.sql.Time.class);

beanUtilsBean.copyProperties(dest, src);
System.out.println(src);
System.out.println(dest);

使用BeanUtils还会经常碰到这样变态的需求：
假设是从A复制到B：
需求1：如果B中某字段有值（不为null），则该字段不复制；也就是B中该字段没值时，才进行复制，适合于对B进行补充值的情况。
需求2：如果A中某字段没值（为null），则该字段不复制，也就是不要把null复制到B当中。

对于需求1，可以这样：

import org.apache.commons.beanutils.BeanUtilsBean;
import org.apache.commons.beanutils.PropertyUtils;

public class CopyWhenNullBeanUtilsBean extends BeanUtilsBean{

    @Override
    public void copyProperty(Object bean, String name, Object value)
            throws IllegalAccessException, InvocationTargetException {
        try {
            Object destValue = PropertyUtils.getSimpleProperty(bean, name);
            if (destValue == null) {
                super.copyProperty(bean, name, value);
            }
        } catch (NoSuchMethodException e) {
            throw new RuntimeException(e);
        }
    }

}

对于需求2，可以这样：

import org.apache.commons.beanutils.BeanUtilsBean;

public class CopyFromNotNullBeanUtilsBean extends BeanUtilsBean {

    @Override
    public void copyProperty(Object bean, String name, Object value) throws IllegalAccessException, InvocationTargetException {
        if (value == null) {
            return;
        }
        super.copyProperty(bean, name, value);
    }
}

评论

1 楼 byyuyi 2015-07-22  

南总，求解释~~

import java.beans.PropertyDescriptor;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.math.BigDecimal;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.BeansException;
import org.springframework.beans.FatalBeanException;
import org.springframework.util.Assert;

import com.smy.framework.core.util.MathUtil;

public abstract class EnhanceBeanUtil extends BeanUtils {
	public static void copyProperties(Object source, Object target)
			throws BeansException {
		Assert.notNull(source, "Source must not be null");
		Assert.notNull(target, "Target must not be null");
		Class actualEditable = target.getClass();
		PropertyDescriptor[] targetPds = getPropertyDescriptors(actualEditable);
		for (PropertyDescriptor targetPd : targetPds)
			if (targetPd.getWriteMethod() != null) {
				PropertyDescriptor sourcePd = getPropertyDescriptor(source.getClass(), targetPd.getName());
				if ((sourcePd == null) || (sourcePd.getReadMethod() == null))
					continue;
				try {
					Method readMethod = sourcePd.getReadMethod();
					if (!(Modifier.isPublic(readMethod.getDeclaringClass().getModifiers()))) {
						readMethod.setAccessible(true);
					}
					Object srcValue = readMethod.invoke(source, new Object[0]);
					if (srcValue != null) {
						Object value = srcValue;

						if ((sourcePd.getPropertyType().isAssignableFrom(Double.class))
								&& (targetPd.getPropertyType().isAssignableFrom(BigDecimal.class))) {
							value = new BigDecimal(((Double) srcValue).doubleValue());
						}
						if ((sourcePd.getPropertyType().isAssignableFrom(BigDecimal.class))
								&& (targetPd.getPropertyType().isAssignableFrom(Double.class))) {
							value = Double.valueOf(((BigDecimal) srcValue).doubleValue());
						}

						if ((sourcePd.getPropertyType().isAssignableFrom(Long.class))
								&& (targetPd.getPropertyType().isAssignableFrom(BigDecimal.class))) {
							value = new BigDecimal(((Long) srcValue).longValue());
						}
						if ((sourcePd.getPropertyType().isAssignableFrom(BigDecimal.class))
								&& (targetPd.getPropertyType().isAssignableFrom(Long.class))) {
							value = Long.valueOf(((BigDecimal) srcValue).longValue());
						}

						if ((sourcePd.getPropertyType().isAssignableFrom(String.class))
								&& (targetPd.getPropertyType().isAssignableFrom(BigDecimal.class))) {
							String srcValueStr = (String) srcValue;
							if (srcValueStr.matches("^(([1-9]{1}\\d*)|([0]{1}))(\\.(\\d){2})$")) {
								value = new BigDecimal((String) srcValue);
							}
						}
						if ((sourcePd.getPropertyType().isAssignableFrom(BigDecimal.class))
								&& (targetPd.getPropertyType().isAssignableFrom(String.class))) {
							value = MathUtil.roundTwoScale((BigDecimal) srcValue).toString();
						}

						if (value != null) {
							Method writeMethod = targetPd.getWriteMethod();
							if (!(Modifier.isPublic(writeMethod.getDeclaringClass().getModifiers()))) {
								writeMethod.setAccessible(true);
							}
							writeMethod.invoke(target, new Object[] { value });
						}
					}
				} catch (Throwable ex) {
					throw new FatalBeanException(
							"Could not copy properties from source to target",
							ex);
				}
			}
	}
}