干掉 BeanUtils！試試這款 Bean 自動(dòng)映射工具，真心強(qiáng)大！！

作者：棧長(zhǎng) 2021-09-06 14:05:57

服務(wù)通過(guò)接口對(duì)外提供數(shù)據(jù)，或者服務(wù)之間進(jìn)行數(shù)據(jù)交互，首先查詢數(shù)據(jù)庫(kù)并映射成數(shù)據(jù)對(duì)象（XxxDO）。

[[422058]]

開(kāi)發(fā)背景

你有沒(méi)有遇到過(guò)這樣的開(kāi)發(fā)場(chǎng)景?

服務(wù)通過(guò)接口對(duì)外提供數(shù)據(jù)，或者服務(wù)之間進(jìn)行數(shù)據(jù)交互，首先查詢數(shù)據(jù)庫(kù)并映射成數(shù)據(jù)對(duì)象(XxxDO)。

正常情況下，接口是不允許直接以數(shù)據(jù)庫(kù)數(shù)據(jù)對(duì)象 XxxDO 形式對(duì)外提供數(shù)據(jù)的，而是要再封裝成數(shù)據(jù)傳輸對(duì)象(XxxDTO)提供出去。

為什么不能直接提供 DO?

1)根據(jù)單一設(shè)計(jì)原則，DO 只能對(duì)應(yīng)數(shù)據(jù)實(shí)體對(duì)象，不能承擔(dān)其他職責(zé);

2)DO 可能包含表所有字段數(shù)據(jù)，不符合接口的參數(shù)定義，數(shù)據(jù)如果過(guò)大會(huì)影響傳輸速度，也不符合數(shù)據(jù)安全原則;

3)根據(jù)《阿里 Java 開(kāi)發(fā)手冊(cè)》分層領(lǐng)域模型規(guī)約，不能一個(gè)對(duì)象走天下，需要定義成 POJO/DO/BO/DTO/VO/Query 等數(shù)據(jù)對(duì)象，完整的定義可以參考阿里開(kāi)發(fā)手冊(cè)，關(guān)注公眾號(hào)：Java技術(shù)棧，在后臺(tái)回復(fù)：手冊(cè)，可以獲取最新高清完整版。

傳統(tǒng) DO -> DTO 做法

XxxDTO 可能包含 XxxDO 大部分?jǐn)?shù)據(jù)，或者組合其他 DO 的部分?jǐn)?shù)據(jù)，傳統(tǒng)的做法有以下幾種：

get/ set
構(gòu)造器
BeanUtils 工具類
Builder 模式

我相信大部分人的做法都是這樣的，雖然很直接，但是普遍真的很 Low，耦合性又強(qiáng)，還經(jīng)常丟參數(shù)，或者搞錯(cuò)參數(shù)值，在這個(gè)開(kāi)發(fā)場(chǎng)景，我個(gè)人覺(jué)得這些都不是最佳的方式。

這種開(kāi)發(fā)場(chǎng)景又實(shí)在是太常見(jiàn)了，那有沒(méi)有一種 Java bean 自動(dòng)映射工具?

沒(méi)錯(cuò)——正是 MapStruct!!

MapStruct 簡(jiǎn)介

官網(wǎng)地址：

https://mapstruct.org/

開(kāi)源地址：

https://github.com/mapstruct/mapstruct

Java bean mappings, the easy way!

以簡(jiǎn)單的方式進(jìn)行 Java bean 映射。

MapStruct 是一個(gè)代碼生成器，它和 Spring Boot、Maven 一樣也是基于約定優(yōu)于配置的理念，極大地簡(jiǎn)化了 Java bean 之間數(shù)據(jù)映射的實(shí)現(xiàn)。

MapStruct 的優(yōu)勢(shì)：

1、MapStruct 使用簡(jiǎn)單的方法調(diào)用生成映射代碼，因此***速度非常快***;

2、類型安全，避免出錯(cuò)，只能映射相互映射的對(duì)象和屬性，因此不會(huì)錯(cuò)誤將用戶實(shí)體錯(cuò)誤地映射到訂單 DTO;

3、只需要 JDK 1.8+，不用其他任何依賴，自包含所有代碼;

4、易于調(diào)試;

5、易于理解;

支持的方式：

MapStruct 支持命令行編譯，如：純 javac 命令、Maven、Gradle、Ant 等等，也支持 Eclipse、IntelliJ IDEA 等 IDEs。

MapStruct 實(shí)戰(zhàn)

本文棧長(zhǎng)基于 IntelliJ IDEA、Spring Boot、Maven 進(jìn)行演示。

基本準(zhǔn)備

新增兩個(gè)數(shù)據(jù)庫(kù) DO 類：

一個(gè)用戶主類，一個(gè)用戶擴(kuò)展類。

/** 
 * 微信公眾號(hào)：Java技術(shù)棧 
 * @author 棧長(zhǎng) 
 */ 
@Data 
public class UserDO { 
 
    private String name; 
 
    private int sex; 
 
    private int age; 
 
    private Date birthday; 
 
    private String phone; 
 
    private boolean married; 
 
    private Date regDate; 
 
    private Date loginDate; 
 
    private String memo; 
 
    private UserExtDO userExtDO; 
 
 
}

/** 
 * 微信公眾號(hào)：Java技術(shù)棧 
 * @author 棧長(zhǎng) 
 */ 
@Data 
public class UserExtDO { 
 
    private String regSource; 
 
    private String favorite; 
 
    private String school; 
 
    private int kids; 
 
    private String memo; 
 
}

新增一個(gè)數(shù)據(jù)傳輸 DTO 類：

用戶展示類，包含用戶主類、用戶擴(kuò)展類的部分?jǐn)?shù)據(jù)。

/** 
 * 微信公眾號(hào)：Java技術(shù)棧 
 * @author 棧長(zhǎng) 
 */ 
@Data 
public class UserShowDTO { 
 
    private String name; 
 
    private int sex; 
 
    private boolean married; 
 
    private String birthday; 
 
    private String regDate; 
 
    private String registerSource; 
 
    private String favorite; 
 
    private String memo; 
 
}

開(kāi)始實(shí)戰(zhàn)

重點(diǎn)來(lái)了，不要 get/set，不要 BeanUtils，怎么把兩個(gè)用戶對(duì)象的數(shù)據(jù)封裝到 DTO 對(duì)象?

Spring Boot 基礎(chǔ)這篇就不介紹了，系列基礎(chǔ)教程和示例源碼可以看這里：https://github.com/javastacks/spring-boot-best-practice

引入 MapStruct 依賴：

<dependencies> 
    <dependency> 
        <groupId>org.mapstruct</groupId> 
        <artifactId>mapstruct</artifactId> 
        <version>${org.mapstruct.version}</version> 
    </dependency> 
</dependencies>

Maven 插件相關(guān)配置：

MapStruct 和 Lombok 結(jié)合使用會(huì)有版本沖突問(wèn)題，注意以下配置。

<build> 
    <plugins> 
        <plugin> 
            <groupId>org.apache.maven.plugins</groupId> 
            <artifactId>maven-compiler-plugin</artifactId> 
            <version>3.8.1</version> 
            <configuration> 
                <source>1.8</source> 
                <target>1.8</target> 
                <annotationProcessorPaths> 
                    <path> 
                        <groupId>org.mapstruct</groupId> 
                        <artifactId>mapstruct-processor</artifactId> 
                        <version>${org.mapstruct.version}</version> 
                    </path> 
                    <!-- 使用 Lombok 需要添加 --> 
                    <path> 
                        <groupId>org.projectlombok</groupId> 
                        <artifactId>lombok</artifactId> 
                        <version>${org.projectlombok.version}</version> 
                    </path> 
                    <!-- Lombok 1.18.16 及以上需要添加，不然報(bào)錯(cuò) --> 
                    <path> 
                        <groupId>org.projectlombok</groupId> 
                        <artifactId>lombok-mapstruct-binding</artifactId> 
                        <version>${lombok-mapstruct-binding.version}</version> 
                    </path> 
                </annotationProcessorPaths> 
            </configuration> 
        </plugin> 
    </plugins> 
</build>

添加 MapStruct 映射：

/** 
 * 微信公眾號(hào)：Java技術(shù)棧 
 * @author 棧長(zhǎng) 
 */ 
@Mapper 
public interface UserStruct { 
 
    UserStruct INSTANCE = Mappers.getMapper(UserStruct.class); 
 
 @Mappings({ 
        @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd") 
        @Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))") 
        @Mapping(source = "userExtDO.regSource", target = "registerSource") 
        @Mapping(source = "userExtDO.favorite", target = "favorite") 
        @Mapping(target = "memo", ignore = true) 
    }) 
    UserShowDTO toUserShowDTO(UserDO userDO); 
 
    List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOs); 
 
}

重點(diǎn)說(shuō)明：

1)添加一個(gè) interface 接口，使用 MapStruct 的 @Mapper 注解修飾，這里取名 XxxStruct，是為了不和 MyBatis 的 Mapper 混淆;

2)使用 Mappers 添加一個(gè) INSTANCE 實(shí)例，也可以使用 Spring 注入，后面會(huì)講到;

3)添加兩個(gè)映射方法，返回單個(gè)對(duì)象、對(duì)象列表;

4)使用 @Mappings + @Mapping 組合映射，如果兩個(gè)字段名相同可以不用寫，可以指定映射的日期格式、數(shù)字格式、表達(dá)式等，ignore 表示忽略該字段映射;

5)List 方法的映射會(huì)調(diào)用單個(gè)方法映射，不用單獨(dú)映射，后面看源碼就知道了;

另外，Java 8+ 以上版本不需要 @Mappings 注解，直接使用 @Mapping 注解就行了：

Java 8 修改之后：

/** 
 * 微信公眾號(hào)：Java技術(shù)棧 
 * @author 棧長(zhǎng) 
 */ 
@Mapper 
public interface UserStruct { 
 
    UserStruct INSTANCE = Mappers.getMapper(UserStruct.class); 
 
    @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd") 
    @Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))") 
    @Mapping(source = "userExtDO.regSource", target = "registerSource") 
    @Mapping(source = "userExtDO.favorite", target = "favorite") 
    @Mapping(target = "memo", ignore = true) 
    UserShowDTO toUserShowDTO(UserDO userDO); 
 
    List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOs); 
 
}

測(cè)試一下：

/** 
 * 微信公眾號(hào)：Java技術(shù)棧 
 * @author 棧長(zhǎng) 
 */ 
public class UserStructTest { 
 
    @Test 
    public void test1() { 
        UserExtDO userExtDO = new UserExtDO(); 
        userExtDO.setRegSource("公眾號(hào)：Java技術(shù)棧"); 
        userExtDO.setFavorite("寫代碼"); 
        userExtDO.setSchool("社會(huì)大學(xué)"); 
 
        UserDO userDO = new UserDO(); 
        userDO.setName("棧長(zhǎng)"); 
        userDO.setSex(1); 
        userDO.setAge(18); 
        userDO.setBirthday(new Date()); 
        userDO.setPhone("18888888888"); 
        userDO.setMarried(true); 
        userDO.setRegDate(new Date()); 
        userDO.setMemo("666"); 
        userDO.setUserExtDO(userExtDO); 
 
        UserShowDTO userShowDTO = UserStruct.INSTANCE.toUserShowDTO(userDO); 
        System.out.println("=====單個(gè)對(duì)象映射====="); 
        System.out.println(userShowDTO); 
 
        List<UserDO> userDOs = new ArrayList<>(); 
        UserDO userDO2 = new UserDO(); 
        BeanUtils.copyProperties(userDO, userDO2); 
        userDO2.setName("棧長(zhǎng)2"); 
        userDOs.add(userDO); 
        userDOs.add(userDO2); 
        List<UserShowDTO> userShowDTOs = UserStruct.INSTANCE.toUserShowDTOs(userDOs); 
        System.out.println("=====對(duì)象列表映射====="); 
        userShowDTOs.forEach(System.out::println); 
    } 
}

輸出結(jié)果：

來(lái)看結(jié)果，數(shù)據(jù)轉(zhuǎn)換結(jié)果成功。

什么原理?

如上我們知道，通過(guò)一個(gè)注解修飾接口就可以搞定了，是什么原理呢?

來(lái)看編譯后的目錄：

原理就是在編譯期間生成了一個(gè)該接口的實(shí)現(xiàn)類。

打開(kāi)看下其源碼：

public class UserStructImpl implements UserStruct { 
    public UserStructImpl() { 
    } 
 
    public UserShowDTO toUserShowDTO(UserDO userDO) { 
        if (userDO == null) { 
            return null; 
        } else { 
            UserShowDTO userShowDTO = new UserShowDTO(); 
            if (userDO.getBirthday() != null) { 
                userShowDTO.setBirthday((new SimpleDateFormat("yyyy-MM-dd")).format(userDO.getBirthday())); 
            } 
 
            userShowDTO.setRegisterSource(this.userDOUserExtDORegSource(userDO)); 
            userShowDTO.setFavorite(this.userDOUserExtDOFavorite(userDO)); 
            userShowDTO.setName(userDO.getName()); 
            userShowDTO.setSex(userDO.getSex()); 
            userShowDTO.setMarried(userDO.isMarried()); 
            userShowDTO.setRegDate(DateFormatUtils.format(userDO.getRegDate(), "yyyy-MM-dd HH:mm:ss")); 
            return userShowDTO; 
        } 
    } 
 
    public List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOs) { 
        if (userDOs == null) { 
            return null; 
        } else { 
            List<UserShowDTO> list = new ArrayList(userDOs.size()); 
            Iterator var3 = userDOs.iterator(); 
 
            while(var3.hasNext()) { 
                UserDO userDO = (UserDO)var3.next(); 
                list.add(this.toUserShowDTO(userDO)); 
            } 
 
            return list; 
        } 
    } 
 
    private String userDOUserExtDORegSource(UserDO userDO) { 
        if (userDO == null) { 
            return null; 
        } else { 
            UserExtDO userExtDO = userDO.getUserExtDO(); 
            if (userExtDO == null) { 
                return null; 
            } else { 
                String regSource = userExtDO.getRegSource(); 
                return regSource == null ? null : regSource; 
            } 
        } 
    } 
 
    private String userDOUserExtDOFavorite(UserDO userDO) { 
        if (userDO == null) { 
            return null; 
        } else { 
            UserExtDO userExtDO = userDO.getUserExtDO(); 
            if (userExtDO == null) { 
                return null; 
            } else { 
                String favorite = userExtDO.getFavorite(); 
                return favorite == null ? null : favorite; 
            } 
        } 
    } 
}

其實(shí)實(shí)現(xiàn)類就是調(diào)用了對(duì)象的 get/set 等其他常規(guī)操作，而 List 就是循環(huán)調(diào)用的該對(duì)象的單個(gè)映射方法，這下就清楚了吧!

Spring 注入法

上面的示例創(chuàng)建了一個(gè) UserStruct 實(shí)例：

UserStruct INSTANCE = Mappers.getMapper(UserStruct.class);

如 @Mapper 注解源碼所示：

參數(shù) componentModel 默認(rèn)值是 default，也就是手動(dòng)創(chuàng)建實(shí)例，也可以通過(guò) Spring 注入。

Spring 修改版如下：

干掉了 INSTANCE，@Mapper 注解加入了 componentModel = "spring" 值。

/** 
 * 微信公眾號(hào)：Java技術(shù)棧 
 * @author 棧長(zhǎng) 
 */ 
@Mapper(componentModel = "spring") 
public interface UserSpringStruct { 
 
    @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd") 
    @Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))") 
    @Mapping(source = "userExtDO.regSource", target = "registerSource") 
    @Mapping(source = "userExtDO.favorite", target = "favorite") 
    @Mapping(target = "memo", ignore = true) 
    UserShowDTO toUserShowDTO(UserDO userDO); 
 
    List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOS); 
 
}

測(cè)試一下：

本文用到了 Spring Boot，所以這里就要用到 Spring Boot 的單元測(cè)試方法。Spring Boot 單元測(cè)試不懂的可以關(guān)注公眾號(hào)：Java技術(shù)棧，在后臺(tái)回復(fù)：boot，系列教程都整理好了。

/** 
 * 微信公眾號(hào)：Java技術(shù)棧 
 * @author 棧長(zhǎng) 
 */ 
@RunWith(SpringRunner.class) 
@SpringBootTest 
public class UserSpringStructTest { 
 
    @Autowired 
    private UserSpringStruct userSpringStruct; 
 
    @Test 
    public void test1() { 
        UserExtDO userExtDO = new UserExtDO(); 
        userExtDO.setRegSource("公眾號(hào)：Java技術(shù)棧"); 
        userExtDO.setFavorite("寫代碼"); 
        userExtDO.setSchool("社會(huì)大學(xué)"); 
 
        UserDO userDO = new UserDO(); 
        userDO.setName("棧長(zhǎng)Spring"); 
        userDO.setSex(1); 
        userDO.setAge(18); 
        userDO.setBirthday(new Date()); 
        userDO.setPhone("18888888888"); 
        userDO.setMarried(true); 
        userDO.setRegDate(new Date()); 
        userDO.setMemo("666"); 
        userDO.setUserExtDO(userExtDO); 
 
        UserShowDTO userShowDTO = userSpringStruct.toUserShowDTO(userDO); 
        System.out.println("=====單個(gè)對(duì)象映射====="); 
        System.out.println(userShowDTO); 
 
        List<UserDO> userDOs = new ArrayList<>(); 
        UserDO userDO2 = new UserDO(); 
        BeanUtils.copyProperties(userDO, userDO2); 
        userDO2.setName("棧長(zhǎng)Spring2"); 
        userDOs.add(userDO); 
        userDOs.add(userDO2); 
        List<UserShowDTO> userShowDTOs = userSpringStruct.toUserShowDTOs(userDOs); 
        System.out.println("=====對(duì)象列表映射====="); 
        userShowDTOs.forEach(System.out::println); 
    } 
}

如上所示，直接使用 @Autowired 注入就行，使用更方便。

輸出結(jié)果：

沒(méi)毛病，穩(wěn)如狗。

總結(jié)

本文棧長(zhǎng)只是介紹了 MapStruct 的簡(jiǎn)單用法，使用 MapStruct 可以使代碼更優(yōu)雅，還能避免出錯(cuò)，其實(shí)還有很多復(fù)雜的、個(gè)性化用法，一篇難以寫完，棧長(zhǎng)后面有時(shí)間會(huì)整理出來(lái)，陸續(xù)給大家分享。

感興趣的也可以參考官方文檔：

https://mapstruct.org/documentation/reference-guide/

本文實(shí)戰(zhàn)源代碼完整版已經(jīng)上傳：

https://github.com/javastacks/spring-boot-best-practice

歡迎 Star 學(xué)習(xí)，后面 Spring Boot 示例都會(huì)在這上面提供!

本文轉(zhuǎn)載自微信公眾號(hào)「Java技術(shù)棧」，可以通過(guò)以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系Java技術(shù)棧公眾號(hào)。