這樣的爛代碼，我實習的時候都寫不出來！

作者 l Hollis

來源 l Hollis（ID：hollischuang）

本文的內容是最近我剛剛遇到的一個問題，問題代碼是我自己寫的，也是我自己寫單元測試的時候發現的，也是我自己修復的，修復完之後，我反思了一下：這樣的問題代碼，我實習的時候都寫不出來。

可是爲什麼我就寫出來了呢？其實還是因爲有些知識沒那麼紮實了~就容易被忽略了

在日常開發中，我們經常需要給對象進行賦值，通常會調用其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 Address address;

    //省略構造函數和setter/getter

}

然後寫一段測試代碼：

User user = new User("Hollis", "hollischuang");

user.setAddress(new Address("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 Address address;

    //省略構造函數和setter/getter


    @Override

    protected Object clone() throws CloneNotSupportedException {

        User user = (User)super.clone();

        user.setAddress((Address)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);

同樣，也可以實現深拷貝啦~！

總結

當我們使用各類BeanUtils的時候，一定要注意是淺拷貝還是深拷貝，淺拷貝的結果就是兩個對象中的引用對象都是同一個地址，只要發生改變，都會有影響。

想要實現深拷貝，有很多種辦法，其中比較常用的就是實現Cloneable接口重寫clone方法，還有使用序列化+反序列化創建新對象。

好了，以上就是今天的全部內容了。

推薦閱讀：

• 漫話：如何給女朋友解釋爲什麼吳某凡會被"中間人攻擊"？

• H大又出了一本電子書，登上阿里雲頭條，免費下載！

• 字節面試官：Java中整數的絕對值一定是正數嗎？

• CPU 核數與線程數有什麼關係？
  

喜歡我可以給我設爲星標哦

好文章，我 “在看”

本文分享自微信公衆號 - 漫話編程（mhcoding）。
如有侵權，請聯繫 [email protected] 刪除。
本文參與“OSC源創計劃”，歡迎正在閱讀的你也加入，一起分享。