BeanUtils.copyProperties使用总结以及注意事项说明

 更新时间:2021年08月31日 10:36:41   作者:啊~~噙!  
这篇文章主要介绍了BeanUtils.copyProperties使用总结以及注意事项说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

1.前言

开发过程中,讲一个对象的属性和值赋值到另一个对象上,大量使用了get、set方法,看着很臃肿,思考下肯定不只有我有这种想法,所以技术上肯定有方法能解决这个问题,所以查阅了一些资料发现了BeanUtils.copyProperties这个方法以下是这次所有的总结以及使用时的注意事项。

使用org.springframework.beans.BeanUtils.copyProperties方法进行对象之间属性的赋值,避免通过get、set方法一个一个属性的赋值。

2.一般使用

BeanUtils是这个包里比较常用的一个工具类,该方法定义如下:

public static void copyProperties(java.lang.Object dest,java.lang.Object orig)
   throws java.lang.IllegalAccessException,
      java.lang.reflect.InvocationTargetException

如 果你有两个具有很多相同属性的JavaBean,一个很常见的情况就是Struts里的PO对象(持久对象)和对应的ActionForm,例如 Teacher和TeacherForm。我们一般会在Action里从ActionForm构造一个PO对象,传统的方式是使用类似下面的语句对属性逐 个赋值:

//1得到TeacherForm
TeacherForm teacherForm=(TeacherForm)form;
//2构造Teacher对象
Teacher teacher=new Teacher();
//3赋值
teacher.setName(teacherForm.getName());
teacher.setAge(teacherForm.getAge());
teacher.setGender(teacherForm.getGender());
teacher.setMajor(teacherForm.getMajor());
teacher.setDepartment(teacherForm.getDepartment());
//4持久化Teacher对象到数据库
HibernateDAO=;
HibernateDAO.save(teacher);

而使用BeanUtils后,代码就大大改观了,如下所示:

//1得到TeacherForm
TeacherForm teacherForm=(TeacherForm)form;
//2构造Teacher对象
Teacher teacher=new Teacher();
//3赋值
BeanUtils.copyProperties(teacher,teacherForm);
//4持久化Teacher对象到数据库
HibernateDAO=;
HibernateDAO.save(teacher);

如 果Teacher和TeacherForm间存在名称不相同的属性,则BeanUtils不对这些属性进行处理,需要程序员手动处理。

例如 Teacher包含modifyDate(该属性记录最后修改日期,不需要用户在界面中输入)属性而TeacherForm无此属性,那么在上面代码的 copyProperties()后还要加上一句:

teacher.setModifyDate(new Date());

3.拷贝属性时忽略空值

使用BeanUtils.copyProperties有一个问题就是当src对象的键值为Null时

就会把target对象的对应键值覆盖成空了,这明显不是我们想要的,以下这个方法可以解决

/**
 * 复制属性,过滤掉不复制的属性
 */
public static void copyBeanProperties(
    final Object source,//1,待复制的原始对象
    final Object target,//2,复制后的结果对象
    //3,获取保存你不需要复制的属性名
    final Collection<String> excludes = new ArrayList<String>();
    final PropertyDescriptor[] propertyDescriptors = BeanUtils.getPropertyDescriptors(source.getClass());
    for(final PropertyDescriptor propertyDescriptor : propertyDescriptors){
        String propName = propertyDescriptor.getName();
        if(!includes.contains(propName)){
            excludes.add(propName);
        }
    }
    //4,复制操作
    BeanUtils.copyProperties(source, target, excludes.toArray(new String[excludes.size()]));
}

使用案例

public static String[] getNullPropertyNames (Object source) {
        final BeanWrapper src = new BeanWrapperImpl(source);
        java.beans.PropertyDescriptor[] pds = src.getPropertyDescriptors();
        Set<String> emptyNames = new HashSet<String>();
        for(java.beans.PropertyDescriptor pd : pds) {
            Object srcValue = src.getPropertyValue(pd.getName());
            if (srcValue == null) emptyNames.add(pd.getName());
        }
        String[] result = new String[emptyNames.size()];
        return emptyNames.toArray(result);
    }
    public static void copyPropertiesIgnoreNull(Object src, Object target){
        BeanUtils.copyProperties(src, target, getNullPropertyNames(src));
    }

4.使用注意事项(1)

Property.copyProperties()和BeanUtils.copyProperties()

除BeanUtils外还有一个名为PropertyUtils的工具类,它也提供copyProperties()方法

  • 1.无论是org.springframework.beans或者org.apache.commons.beanutils,与get/set方式相比,都存在性能问题。
  • 2.效率由高到底:get/set 》PropertyUtils 》BeanUtils。
  • 3.PropertyUtils和BeanUtils两个工具类都是对bean之间存在属性名相同的属性进行处理,无论是源bean或者是目标bean中多出来的属性均不处理。
  • 4.具体来说:BeanUtils.copyProperties()可以在一定范围内进行类型转换,同时还要注意一些不能转换时候,会将默认null值转化成0;Property.copyProperties()则是严格的类型转化,必须类型和属性名完全一致才转化。对于null的处理:PropertyUtils支持为null的场景;BeanUtils对部分属性不支持null,具体如下:
    • a. java.util.Date类型不支持,但是它的自雷java.sql.Date是被支持的。java.util.Date直接copy会报异常;
    • b. Boolean,Integer,Long等不支持,会将null转化为0;
    • c. String支持,转化后依然为null。
  • 5.BeanUtils的高级功能org.apache.commons.beanutils.Converter接口可以自定义类型转化,也可以对部分类型数据的null值进行特殊处理,如ConvertUtils.register(new DateConverter(null), java.util.Date.class);但是PropertyUtils没有。

另外:值得注意的是,在测试过程中发现,commons-beanutils-1.8.0.jar版本中的BeanUtils类,支持Byte到Integer或int的转化。说明实际使用过程中,我们还是要多看源码,多做测试,并且注意版本号升级带来的微小变化。

BeanUtils支持的转换类型如下:

* java.lang.BigDecimal
* java.lang.BigInteger
* boolean and java.lang.Boolean
* byte and java.lang.Byte
* char and java.lang.Character
* java.lang.Class
* double and java.lang.Double
* float and java.lang.Float
* int and java.lang.Integer
* long and java.lang.Long
* short and java.lang.Short
* java.lang.String
* java.sql.Date
* java.sql.Time
* java.sql.Timestamp

这里要注意一点,java.util.Date是不被支持的,而它的子类java.sql.Date是被支持的。因此如果对象包含时间类型的属性,且希望被转换的时候,一定要使用java.sql.Date类型。否则在转换时会提示argument mistype异常。

5.使用注意事项(2)

在Java中copyProperties() 这个方法出处有两个地方,

BeanUtils是org.springframework.beans.BeanUtils

BeanUtils是org.apache.commons.beanutils.BeanUtils

下面具体说说他们的用法和区别。这个方法在不同的包下面,而这两个类的copyProperties()方法里面传递的参数赋值是相反的。

例如:a,b为对象 BeanUtils.copyProperties(a, b);

BeanUtils是org.springframework.beans.BeanUtils
//a拷贝到b
//a1 源文件,b1 目标文件
public static void copyProperties(Object a1, Object b1)
        throws BeansException
    {
        copyProperties(a1, b1, null, (String[])null);
    }

BeanUtils是org.apache.commons.beanutils.BeanUtils

//b拷贝到a
//a2目标文件 ,b2 原始的,源文件
public static void copyProperties(Object a2, Object b2)
        throws IllegalAccessException, InvocationTargetException
    {
        BeanUtilsBean.getInstance().copyProperties(a2, b2);
    }

引用包出处不一样,意思就不一样,使用的时候一定要看清楚是哪个包下面的。

6.使用注意事项(3)

方法使用起来是不是即省事又舒服?but。。。get/set写代码省事是要付出代价的,那就是使用BeanUtils的运行成本也惊人!BeanUtils所花费的时间要超过取数 据、将其复制到对应的 value对象(通过手动调用get和set方法),以及通过串行化将其返回到远程的客户机的时间总和。所以要小心使用这种威力!有失必有得,反之亦然。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java实现的时间戳与date对象相互转换功能示例

    Java实现的时间戳与date对象相互转换功能示例

    这篇文章主要介绍了Java实现的时间戳与date对象相互转换功能,结合具体实例形式分析了java日期与时间戳类型的表示与转换相关操作技巧,需要的朋友可以参考下
    2017-06-06
  • Java设计模式之单例模式实例详解【懒汉式与饿汉式】

    Java设计模式之单例模式实例详解【懒汉式与饿汉式】

    这篇文章主要介绍了Java设计模式之单例模式,简单说明了单例模式的原理并结合具体实例形式分析了单例模式中懒汉式与饿汉式的具体实现与使用技巧,需要的朋友可以参考下
    2017-09-09
  • 详解Java拦截器以及自定义注解的使用

    详解Java拦截器以及自定义注解的使用

    这篇文章主要为大家介绍了Java拦截器以及自定义注解的使用,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助<BR>
    2021-12-12
  • dockerfile-maven-plugin极简教程(推荐)

    dockerfile-maven-plugin极简教程(推荐)

    这篇文章主要介绍了dockerfile-maven-plugin极简教程,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-10-10
  • Spring的两种事务管理机制的基本概念和demo示例

    Spring的两种事务管理机制的基本概念和demo示例

    Spring事务包括声明式事务管理和注解式事务管理,我们通过概念和小demo的形式一步一步地来一起学习这个知识点,需要的朋友可以参考下
    2023-07-07
  • SpringBoot整合thymeleaf 报错的解决方案

    SpringBoot整合thymeleaf 报错的解决方案

    这篇文章主要介绍了SpringBoot整合thymeleaf 报错的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • idea中导入项目后main方法无法Run的解决

    idea中导入项目后main方法无法Run的解决

    这篇文章主要介绍了idea中导入项目后main方法无法Run的解决方案,具有很好的参考价值,希望对大家有所帮助。
    2023-03-03
  • java中Map接口常用的方法解读

    java中Map接口常用的方法解读

    这篇文章主要介绍了java中Map接口常用的方法解读,Map接口是双列集合,它的每一个元素都包含一个键对象key和值对象Value,键和值对象之间存在一种对应关系,称为映射,需要的朋友可以参考下
    2024-01-01
  • 由ArrayList来深入理解Java中的fail-fast机制

    由ArrayList来深入理解Java中的fail-fast机制

    fail-fast俗称快速失败,是在多线程进行迭代操作时产生冲突的一种异常抛出机制,下面我们就由ArrayList来深入理解Java中的fail-fast机制.
    2016-05-05
  • Java并发编程之关键字volatile的深入解析

    Java并发编程之关键字volatile的深入解析

    提高java的并发编程,就不得不提volatile关键字,不管是在面试还是实际开发中volatile都是一个应该掌握的技能,这篇文章主要给大家介绍了关于Java并发编程之关键字volatile的相关资料,需要的朋友可以参考下
    2021-09-09

最新评论