BeanUtils 如何拷貝 List？

2020-02-01 17:04:10 技術宅愛Java

一、背景

我們在DO、Model、VO層數據間可能經常轉換數據:

Entity對應的是持久層數據結構（一般是數據庫表的映射模型）;
Model 對應的是業務層的數據結構;
VO 就是Controller和客戶端交互的數據結構。

例如：數據庫查詢出來的用戶信息(表的映射模型)是UserDO，但是我們需要傳遞給客戶端的是UserVO,這時候就需要把UserDO實例的屬性一個一個賦值到UserVO實例中。

在這些數據結構之間很大一部分屬性都可能會相同，也可能不同。

二、數據拷貝

2.1、數據模型

UserDO.java

<code>@Data
public class UserDO {

    private Long userId;
    private String userName; 

    private Integer age;
    private Integer sex;
    public UserDO() {

    }

    public UserDO(Long userId, String userName, Integer age, Integer sex) {
        this.userId = userId;
        this.userName = userName;
        this.age = age;
        this.sex = sex;
    }
}/<code>

UserVO.java

<code>@Data
public class UserVO {
    private Long userId;
    private String userName;
    private Integer age;
    private String sex;
}/<code>

注意： UserDO.java 和UserVO.java 最後一個字段sex類型不一樣，分別是：Integer/String

2.2、常規使用-BeanUtils

Spring 提供了 org.springframework.beans.BeanUtils 類進行快速賦值。

例如：我們把數據庫查詢出來的UserDO.java 拷貝到 UserVO.java

<code>@Test
public void commonCopy() {
    UserDO userDO = new UserDO(1L, "Van", 18, 1);
    UserVO userVO = new UserVO();
    BeanUtils.copyProperties(userDO, userVO);
    log.info("userVO:{}",userVO);
}/<code>

日誌打印：

<code>.... userVO:UserVO(userId=1, userName=Van, age=18, sex=null)/<code>

通過打印結果我們可以發現：除了類型不同的sex，其他數值都成功拷貝。

2.3、集合拷貝

剛剛拷貝的是一個對象，但是有時候我們想拷貝一組UerDO.java，是一個集合的時候就不能這樣直接賦值了。如果還按照這種邏輯，如下：

<code>@Test
public void listCopyFalse() {
    List<userdo> userDOList = new ArrayList();
    userDOList.add(new UserDO(1L, "Van", 18, 1));
    userDOList.add(new UserDO(2L, "VanVan", 18, 2));
    List<uservo> userVOList = new ArrayList();
    BeanUtils.copyProperties(userDOList, userVOList);
    log.info("userVOList:{}",userVOList);
}/<uservo>/<userdo>/<code>

日誌打印如下：

<code>.... userVOList:[]/<code>

通過日誌可以發現，直接拷貝集合是無效的，那麼怎麼解決呢？

三、集合拷貝

3.1、暴力拷貝（不推薦）

將需要拷貝的集合遍歷，暴力拷貝。

測試方式

<code>@Test
public void listCopyCommon() {
    List<userdo> userDOList = new ArrayList();
    userDOList.add(new UserDO(1L, "Van", 18, 1));
    userDOList.add(new UserDO(2L, "VanVan", 20, 2));
    List<uservo> userVOList = new ArrayList();
    userDOList.forEach(userDO ->{
        UserVO userVO = new UserVO();
        BeanUtils.copyProperties(userDO, userVO);
        userVOList.add(userVO);
    });
    log.info("userVOList:{}",userVOList);
}/<uservo>/<userdo>/<code>

拷貝結果

<code>.... userVOList:[UserVO(userId=1, userName=Van, age=18, sex=null), UserVO(userId=2, userName=VanVan, age=20, sex=null)]/<code>

雖然該方式可以解決，但是一點都不優雅，特別是寫起來麻煩。

3.2、優雅拷貝（本文推薦）

通過JDK 8 的函數式接口封裝org.springframework.beans.BeanUtils

定義一個函數式接口

函數式接口裡是可以包含默認方法，這裡我們定義默認回調方法。

<code>@FunctionalInterface
public interface BeanCopyUtilCallBack  {

    /**
     * 定義默認回調方法 

     * @param t
     * @param s
     */
    void callBack(S t, T s);
}/<code>

封裝一個數據拷貝工具類 BeanCopyUtil.java

<code>public class BeanCopyUtil extends BeanUtils {

    /**
     * 集合數據的拷貝
     * @param sources: 數據源類
     * @param target: 目標類::new(eg: UserVO::new)
     * @return
     */
    public static  List copyListProperties(List sources, Supplier target) {
        return copyListProperties(sources, target, null);
    }


    /**
     * 帶回調函數的集合數據的拷貝（可自定義字段拷貝規則）
     * @param sources: 數據源類
     * @param target: 目標類::new(eg: UserVO::new)
     * @param callBack: 回調函數
     * @return
     */
    public static  List copyListProperties(List sources, Supplier target, BeanCopyUtilCallBack callBack) {
        List list = new ArrayList<>(sources.size());
        for (S source : sources) { 

            T t = target.get();
            copyProperties(source, t);
            list.add(t);
            if (callBack != null) {
                // 回調
                callBack.callBack(source, t);
            }
        }
        return list;
    }
}/<code>

簡單拷貝測試

<code>@Test
public void listCopyUp() {
    List<userdo> userDOList = new ArrayList();
    userDOList.add(new UserDO(1L, "Van", 18, 1));
    userDOList.add(new UserDO(2L, "VanVan", 20, 2));
    List<uservo> userVOList = BeanCopyUtil.copyListProperties(userDOList, UserVO::new);
    log.info("userVOList:{}",userVOList);
}/<uservo>/<userdo>/<code>

打印結果：

<code>.... userVOList:[UserVO(userId=1, userName=Van, age=18, sex=null), UserVO(userId=2, userName=VanVan, age=20, sex=null)]/<code>

通過如上方法，我們基本實現了集合的拷貝，但是從返回結果我們可以發現：屬性不同的字段無法拷貝。所以，我們這裡需要藉助剛定義的回調方法實現自定義轉換。

性別枚舉類

<code>public enum SexEnum {
    UNKNOW("未設置",0),
    MEN("男生", 1),
    WOMAN("女生",2),

    ;
    private String desc;
    private int code;

    SexEnum(String desc, int code) {
        this.desc = desc;
        this.code = code;
    }

    public static SexEnum getDescByCode(int code) {
        SexEnum[] typeEnums = values();
        for (SexEnum value : typeEnums) {
            if (code == value.getCode()) {
                return value;
            }
        }
        return null;
    }

    public String getDesc() {
        return desc;
    }

    public void setDesc(String desc) {
        this.desc = desc;
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }
}/<code>

帶回調函數的拷貝

<code>@Test
public void listCopyUpWithCallback() {
    List<userdo> userDOList = new ArrayList();
    userDOList.add(new UserDO(1L, "Van", 18, 1));
    userDOList.add(new UserDO(2L, "VanVan", 20, 2));
    List<uservo> userVOList = BeanCopyUtil.copyListProperties(userDOList, UserVO::new, (userDO, userVO) ->{
        // 這裡可以定義特定的轉換規則
        userVO.setSex(SexEnum.getDescByCode(userDO.getSex()).getDesc());
    });
    log.info("userVOList:{}",userVOList);
}/<uservo>/<userdo>/<code>

打印結果：

<code>... userVOList:[UserVO(userId=1, userName=Van, age=18, sex=男生), UserVO(userId=2, userName=VanVan, age=20, sex=女生)]/<code>

通過打印結果可以發現，UserDO.java 中Integer類型的sex複製到UserVO.java成了String類型的男生/女生。

鏈接：https://juejin.im/post/5e1b18b1f265da3e140fa377

分享到:

閱讀更多 技術宅愛Java 的文章

關鍵字: 拷貝數據結構如何