快捷導(dǎo)航

Java對(duì)象字段拷貝最佳實(shí)踐分享

更新時(shí)間：2025年03月03日 08:29:15 作者：碼農(nóng)研究僧

文章介紹了幾種常見(jiàn)的對(duì)象字段拷貝方法,包括手動(dòng)set、BeanUtils.copyProperties、Lombok的@Builder和MapStruct,每種方法都有其優(yōu)缺點(diǎn)和適用場(chǎng)景,推薦使用MapStruct,因?yàn)樗诰幾g期生成代碼,性能最優(yōu),支持復(fù)雜對(duì)象映射,需要的朋友可以參考下

前言

一開(kāi)始在線表和歷史表都是一張表，只不過(guò)字段設(shè)置不一樣，顯示不一樣

但后續(xù)數(shù)據(jù)越來(lái)越多，為了不影響在線表，數(shù)據(jù)最終得落入歷史表，不影響在線表的CRUD

以下章節(jié)圍繞如何克隆在線表的數(shù)據(jù)

對(duì)象字段拷貝的需求，比如從數(shù)據(jù)庫(kù)查詢出的對(duì)象需要轉(zhuǎn)換成 DTO，或者在審核流程中更新一張表的同時(shí)寫(xiě)入歷史表等

如果手動(dòng) set 字段，代碼會(huì)變得繁瑣，難以維護(hù)

1. 傳統(tǒng)set（不推薦）

最簡(jiǎn)單的方法是手動(dòng)賦值，但是當(dāng)字段較多時(shí)，代碼冗長(zhǎng)且容易遺漏。

示例代碼：

CheckBoxDetailDO checkBoxDetailDO = new CheckBoxDetailDO();
checkBoxDetailDO.setCheckStatus(1L);
checkBoxDetailDO.setCntr(checkBox.getCntr());
checkBoxDetailDO.setImgCntrF(checkBox.getImgCntrF());
checkBoxDetailDO.setCreateTime(checkBox.getCreateTime());

缺點(diǎn)：

代碼冗長(zhǎng)：如果 CheckBoxDO有幾十個(gè)字段，手寫(xiě) set 非常麻煩
易出錯(cuò)：如果 CheckBoxDO結(jié)構(gòu)變化，必須手動(dòng)修改所有 set 邏輯，維護(hù)成本高

適用場(chǎng)景：

字段較少（少于 3 個(gè)字段）

除了set，還有一種跟他很像，我也放在這個(gè)章節(jié)

Lombok 的 @Builder，可以使用 builder() 方法來(lái) 鏈?zhǔn)劫x值，提高可讀性（但我感覺(jué)沒(méi)啥差異）

CheckBoxDetailDO checkBoxDetailDO = CheckBoxDetailDO.builder()
        .checkStatus(1L)
        .cntr(checkBox.getCntr())
        .imgCntrF(checkBox.getImgCntrF())
        .createTime(checkBox.getCreateTime())
        .build();

2. copyProperties（有局限）

CheckBoxDetailDO checkBoxDetailDO = new CheckBoxDetailDO();
BeanUtils.copyProperties(checkBox, checkBoxDetailDO);
checkBoxDetailDO.setCheckStatus(1L); // 額外賦值

優(yōu)點(diǎn)：

代碼簡(jiǎn)潔，自動(dòng)拷貝相同字段，避免手動(dòng) set
無(wú)需額外依賴，Spring 內(nèi)置

缺點(diǎn)：

性能一般，使用了反射，比手動(dòng) set 慢
字段名必須完全匹配，如果 CheckBoxDetailDO 和 CheckBoxDO字段名不一樣，無(wú)法拷貝
不支持復(fù)雜轉(zhuǎn)換，比如數(shù)據(jù)類(lèi)型不同（int vs String）、默認(rèn)值設(shè)置等

適用場(chǎng)景：

字段名和類(lèi)型完全匹配的簡(jiǎn)單拷貝
項(xiàng)目已經(jīng)使用 Spring，避免額外依賴

3. MapStruct（推薦）

如果 CheckBoxDO和 CheckBoxDetailDO 結(jié)構(gòu)類(lèi)似，并且字段較多，推薦使用 MapStruct 進(jìn)行自動(dòng)對(duì)象映射
MapStruct 在編譯期生成代碼，相比 BeanUtils 性能更優(yōu)，并且支持字段轉(zhuǎn)換

1、定義轉(zhuǎn)換接口

創(chuàng)建一個(gè) Mapper 接口，并用 @Mapper 注解標(biāo)識(shí)。

import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.factory.Mappers;

@Mapper(componentModel = "spring")
public interface CheckBoxConverter {
    CheckBoxConverter INSTANCE = Mappers.getMapper(CheckBoxConverter.class);

    @Mapping(target = "checkStatus", constant = "1L") // 強(qiáng)制設(shè)定 checkStatus 為 1
    CheckBoxDetailDO toDetailDO(CheckBoxDO checkBox);
}

2、調(diào)用轉(zhuǎn)換

@Resource
private ChekBoxDetailMapper chekBoxDetailMapper;

CheckBoxDetailDO checkBoxDetailDO = CheckBoxConverter.INSTANCE.toDetailDO(checkBox);
chekBoxDetailMapper.insert(checkBoxDetailDO);

優(yōu)點(diǎn)：

高性能，編譯期生成代碼，沒(méi)有反射開(kāi)銷(xiāo)
自動(dòng)映射字段，省去 set 代碼
支持類(lèi)型轉(zhuǎn)換，例如 String -> Long、Date -> LocalDateTime 等
字段名不同也能映射，可以用 @Mapping(source = “oldField”, target = “newField”) 自定義映射關(guān)系

缺點(diǎn)：

需要引入 MapStruct 依賴，但一次配置，終身受益

適用場(chǎng)景：

字段較多且映射規(guī)則較復(fù)雜
項(xiàng)目對(duì)性能要求較高（比 BeanUtils 更快）

但是會(huì)有bug：

后續(xù)發(fā)現(xiàn)id自增字段也被復(fù)刻了！

采取忽略的方式：

@Mapper
public interface CheckBoxConverter {
    CheckBoxConverter INSTANCE = Mappers.getMapper(CheckBoxConverter.class);

    @Mapping(target = "id", ignore = true) // 忽略 id 字段
    @Mapping(target = "checkStatus", constant = "1L") // 強(qiáng)制設(shè)定 checkStatus 為 1
    CheckBoxDetailDO toDetailDO(CheckBoxDO checkBox);
}

截圖如下：

這里拓展下這種方式其他的知識(shí)點(diǎn)：

使用 @BeanMapping(ignoreByDefault = true)（僅拷貝指定字段）

類(lèi)似如下代碼：

@Mapper(componentModel = "spring")
public interface CheckBoxConverter {
    CheckBoxConverter INSTANCE = Mappers.getMapper(CheckBoxConverter.class);

    @BeanMapping(ignoreByDefault = true)
    @Mapping(target = "cntr", source = "cntr")
    @Mapping(target = "imgCntrF", source = "imgCntrF")
    @Mapping(target = "createTime", source = "createTime")
    @Mapping(target = "checkStatus", constant = "1L")
    CheckBoxDetailDO toDetailDO(CheckBox checkBox);
}

如果不想修改代碼：

CheckBoxDetailDO checkBoxDetailDO = CheckBoxConverter.INSTANCE.toDetailDO(checkBox);
checkBoxDetailDO.setId(null); // 手動(dòng)清除 id

最后，不要忘記insert，否則它只是一個(gè)對(duì)象，沒(méi)有存儲(chǔ)

CheckBoxDetailDO checkBoxDetailDO = CheckBoxConverter.INSTANCE.toDetailDO(checkBox);
checkBoxDetailMapper.insert(checkBoxDetailDO); // 插入數(shù)據(jù)庫(kù)

4. 總結(jié)

方案	代碼簡(jiǎn)潔度	性能	適用場(chǎng)景
手動(dòng) set	? 差	?	快
BeanUtils.copyProperties	? 好	?一般	字段完全匹配，簡(jiǎn)單拷貝
Lombok @Builder	? 好	? 快	代碼可讀性強(qiáng)，構(gòu)建新對(duì)象
MapStruct	? 最優(yōu)	? 最優(yōu)	復(fù)雜對(duì)象映射，性能高