使用各類BeanUtils的時候,切記注意這個坑!

HollisChuang發表於2021-08-16

在日常開發中,我們經常需要給物件進行賦值,通常會呼叫其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異常。

將上述程式碼修改下,重寫clone方法:

public class Address implements Cloneable{
    private String province;
    private String city;
    private String area;
    //省略建構函式和setter/getter

    @Override
    public Object clone() throws CloneNotSupportedException {
        return super.clone();
    }
}

class User implements Cloneable{
    private String name;
    private String password;
    private HomeAddress address;
    //省略建構函式和setter/getter

    @Override
    protected Object clone() throws CloneNotSupportedException {
        User user = (User)super.clone();
        user.setAddress((HomeAddress)address.clone());
        return user;
    }
}

之後,在執行一下上面的測試程式碼,就可以發現,這時候newUser中的address物件就是一個新的物件了。

這種方式就能實現深拷貝,但是問題是如果我們在User中有很多個物件,那麼clone方法就寫的很長,而且如果後面有修改,在User中新增屬性,這個地方也要改。

那麼,有沒有什麼辦法可以不需要修改,一勞永逸呢?

2、序列化實現深拷貝

我們可以藉助序列化來實現深拷貝。先把物件序列化成流,再從流中反序列化成物件,這樣就一定是新的物件了。

序列化的方式有很多,比如我們可以使用各種JSON工具,把物件序列化成JSON字串,然後再從字串中反序列化成物件。

如使用fastjson實現:

User newUser = JSON.parseObject(JSON.toJSONString(user), User.class);

也可實現深拷貝。

除此之外,還可以使用Apache Commons Lang中提供的SerializationUtils工具實現。

我們需要修改下上面的User和Address類,使他們實現Serializable介面,否則是無法進行序列化的。

class User implements Serializable
class Address implements Serializable

然後在需要拷貝的時候:

User newUser = (User) SerializationUtils.clone(user);

同樣,也可以實現深拷貝啦~!

相關文章