在日常开发中,我们经常需要给对象进行赋值,通常会调用其set/get方法,有些时候,如果我们要转换的两个对象之间属性大致相同,会考虑使用属性拷贝工具进行。
如我们经常在代码中会对一个数据结构封装成DO、SDO、DTO、VO等,而这些Bean中的大部分属性都是一样的,所以使用属性拷贝类工具可以帮助我们节省大量的set和get操作。
市面上有很多类似的工具类,比较常用的有
1、Spring BeanUtils 2、Cglib BeanCopier 3、Apache BeanUtils 4、Apache PropertyUtils 5、Dozer 6、MapStucts
这里面我比较建议大家使用的是MapStructs,我在《丢弃掉那些BeanUtils工具类吧,MapStruct真香!!!》中介绍过原因。这里就不再赘述了。
最近我们有个新项目,要创建一个新的应用,因为我自己分析过这些工具的效率,也去看过他们的实现原理,比较下来之后,我觉得MapStruct是最适合我们的,于是就在代码中引入了这个框架。
另外,因为Spring的BeanUtils用起来也比较方便,所以,代码中对于需要beanCopy的地方主要在使用这两个框架。
我们一般是这样的,如果是DO和DTO/Entity之间的转换,我们统一使用MapStruct,因为他可以指定单独的Mapper,可以自定义一些策略。
如果是同对象之间的拷贝(如用一个DO创建一个新的DO),或者完全不相关的两个对象转换,则使用Spring的BeanUtils。
刚开始都没什么问题,但是后面我在写单测的时候,发现了一个问题。
问题先来看看我们是在什么地方用的Spring的BeanUtils
我们的业务逻辑中,需要对订单信息进行修改,在更改时,不仅要更新订单的上面的属性信息,还需要创建一条变更流水。
而变更流水中同时记录了变更前和变更后的数据,所以就有了以下代码:
//从数据库中查询出当前订单,并加锁 OrderDetail orderDetail = orderDetailDao.queryForLock(); //copy一个新的订单模型 OrderDetail newOrderDetail = new OrderDetail(); BeanUtils.copyProperties(orderDetail, newOrderDetail); //对新的订单模型进行修改逻辑操作 newOrderDetail.update(); //使用修改前的订单模型和修改后的订单模型组装出订单变更流水 OrderDetailStream orderDetailStream = new OrderDetailStream(); orderDetailStream.create(orderDetail, newOrderDetail);大致逻辑是这样的,因为创建订单变更流水的时候,需要一个改变前的订单和改变后的订单。所以我们想到了要new一个新的订单模型,然后操作新的订单模型,避免对旧的有影响。
但是,就是这个BeanUtils.copyProperties的过程其实是有问题的。
因为BeanUtils在进行属性copy的时候,本质上是浅拷贝,而不是深拷贝。
浅拷贝?深拷贝?什么是浅拷贝和深拷贝?来看下概念。
1、浅拷贝:对基本数据类型进行值传递,对引用数据类型进行引用传递般的拷贝,此为浅拷贝。
2、深拷贝:对基本数据类型进行值传递,对引用数据类型,创建一个新的对象,并复制其内容,此为深拷贝。
我们举个实际例子,来看下为啥我说BeanUtils.copyProperties的过程是浅拷贝。
先来定义两个类:
public class Address { private String province; private String city; private String area; //省略构造函数和setter/getter } class User { private String name; private String password; private HomeAddress address; //省略构造函数和setter/getter }然后写一段测试代码:
User user = new User("Hollis", "hollischuang"); user.setAddress(new HomeAddress("zhejiang", "hangzhou", "binjiang")); User newUser = new User(); BeanUtils.copyProperties(user, newUser); System.out.println(user.getAddress() == newUser.getAddress());以上代码输出结果为:true
即,我们BeanUtils.copyProperties拷贝出来的newUser中的address对象和原来的user中的address对象是同一个对象。
可以尝试着修改下newUser中的address对象:
newUser.getAddress().setCity("shanghai"); System.out.println(JSON.toJSONString(user)); System.out.println(JSON.toJSONString(newUser));输出结果:
{"address":{"area":"binjiang","city":"shanghai","province":"zhejiang"},"name":"Hollis","password":"hollischuang"} {"address":{"area":"binjiang","city":"shanghai","province":"zhejiang"},"name":"Hollis","password":"hollischuang"}可以发现,原来的对象也受到了修改的影响。
这就是所谓的浅拷贝!
如何进行深拷贝发现问题之后,我们就要想办法解决,那么如何实现深拷贝呢?
1、实现Cloneable接口,重写clone()在Object类中定义了一个clone方法,这个方法其实在不重写的情况下,其实也是浅拷贝的。
如果想要实现深拷贝,就需要重写clone方法,而想要重写clone方法,就必须实现Cloneable,否则会报CloneNotSupportedException异常。