Java对象的属性拷贝BeanUtils

关键字：BeanUtils.copyProperties、Java、属性拷贝、属性赋值、对象拷贝、对象属性赋值、复制对象

简介

BeanUtils提供对Java反射和自省API的包装。其主要目的是利用反射机制对JavaBean的属性进行处理。

使用场景

当我们如果有两个具有很多相同属性的JavaBean，User1Bean,User2Bean，我想吧User1Bean的属性全部赋值给User2Bean。

传统方式赋值：

user2Bean.setName(user1Bean.getName());
…3个属性，set,get 3次，我要是10000个属性呢？你会写10000次吗？
所以改进赋值方式

反射方式赋值

通过反射获取到user2Bean对象的属性set方法，user1Bean对象的get方法，循环user2Bean对象的属性，执行user2Bean.setProperty(user1Bean.getProtpry());
详细代码：说实话我不想写，你想写吗？对，你不想。

//此处省略10000行

面向对象BeanUtils

依照能用别人的，就不自己写原则（面向对象），我们开始使用BeanUtils。

//准备两个bean
UserBean user1 = new UserBean();
user1.setName("张三");
user1.setAge("38");
user1.setSex("看着来吧");
UserBean user2 = new UserBean();
//使用
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.copyProperties(user2, user1);
//好了，代码写完了...
//没错写完了，你后边想怎么蹂躏 user2 都行了 [斜眼笑]

你可能在疑问，我为什么不用BeanUtils.copyProperties(user2, user1);
是我在提醒你考虑bean中存在BigDecimal、Date属性的情况，直接copyProperties会出错。
详情：请看【使用BeanUtils有几个要注意的地方：】

• List item

但是有几点我们需要注意：

targetObj：被赋值的目标对象
srcObj ： 具备数据的对象
BeanUtils.copyProperties(targetObj, srcObj);

1. srcObj中的存在的属性，targetObj中一定要有，但是targetObj中可以有多余的属性；
2. targetObj中与srcObj中相同的属性都会被替换，不管是否有值；
3. targetObj、 srcObj中的属性要名字相同，才能被赋值，不然的话需要手动赋值；
4. Spring的BeanUtils的CopyProperties方法需要对应的属性有getter和setter方法；
5. 如果存在属性完全相同的内部类，但是不是同一个内部类，即分别属于各自的内部类，则spring会认为属性不同，不会copy；
6. spring和apache的copy属性的方法源和目的参数的位置正好相反，所以导包和调用的时候都要注意一下。

BeanUtils.copyProperties VS PropertyUtils.copyProperties

两者最大的区别是：

BeanUtils.copyProperties会进行类型转换，而PropertyUtils.copyProperties不会

既然进行了类型转换，那BeanUtils.copyProperties的速度比不上PropertyUtils.copyProperties。

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

使用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); 
 } 
}

参考:
https://blog.csdn.net/dfshsdr/article/details/90513676
https://www.jb51.net/article/186524.htm

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);  
 	}  
} 

本文参考了：
全站工程师：https://javaforall.cn