java Beanutils.copyProperties( )用法详解

这是一篇开发自辩甩锅稿~~~~

昨天测试小姐姐将我的一个bug单重开了，emmmm....内心OS：就调整下对象某个属性类型这么简单的操作，我怎么可能会出错呢，一定不是我的锅！！but再怎么抗拒，bug还是要改的，毕竟晚上就要发版本了~~

老老实实将我前天改的部分跟了一遍，恩，完美，没有任何的缺失~~but本应success的测试数据，接口返还的结果确实是false来着，那还是老老实实debug吧。

一步步跟下来，恩，多么顺畅，就说一定不是我的锅~~诶？不对不对，这里的ID值，为啥是null？传过来有值的呀！！发现原来是别人在修复bug时用了Beanutils.copyProperties( obj1,obj2)，but 因为obj1中属性名称id，obj2中属性名称afterId，因为Beanutils.copyProperties( )要求处理的两个对象的属性名称相同时才可以正常赋值，那好吧，我们今天就好好讲讲关于Beanutils.copyProperties( )吧~

1、简介

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

2、用法

如果有两个具有很多相同属性的JavaBean，一个很常见的情况就是Struts里的PO对象（持久对象）和对应的ActionForm。例如：一个用户注册页面，有一个User实体类和一个UserActionForm实体类，我们一般会在Action里从ActionForm构造一个PO对象，传统的方式是使用类似下面的语句对属性逐个赋值：

// 获取 ActionForm 表单数据
 UserActionForm uForm = (UserActionForm) form; 

// 构造一个User对象
User user = new User(); 

// 逐一赋值
user.setUsername(uForm.getUsername);
user.setPassword(uForm.getPassword);
user.setAge(uForm.getAge);
...........
........... 

// 然后调用JDBC、或操作Hibernate 持久化对象User到数据库
... 

通过这样的方法如果表单属性字段很多，达到了100、1000甚至更多，那我们不是要写100、1000行set、get了。谁都不愿意这样做。

而我们使用 BeanUtils.copyProperties() 方法以后，代码量大大的减少，而且整体程序看着也简洁明朗，代码如下：

// 获取 ActionForm 表单数据
UserActionForm uForm = (UserActionForm) form; 

// 构造一个User对象
User user = new User(); 

// 赋值
BeanUtils.copyProperties(user, uForm); 

// 然后调用JDBC、或操作Hibernate 持久化对象User到数据库
....... 

注：如果User和UserActionForm 间存在名称不相同的属性，则BeanUtils不对这些属性进行处理，需要手动处理。例如：
User类里面有个createDate 创建时间字段，而UserActionForm里面无此字段。BeanUtils.copyProperties()不会对此字段做任何处理。必须要自己手动处理。
用法总结如下：

[java] view plain copy print?

BeanUtils.copyProperties("要转换的类", "转换后的类");
[java] view plain copy print?

PropertyUtils.copyProperties("要转换的类", "转换后的类");

用法其实很简单，第一个参数是要转换的类，第二个参数是转换后的类。

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

到此这篇关于java Beanutils.copyProperties( )用法详解的文章就介绍到这了,更多相关java Beanutils.copyProperties 内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！