開發背景
你有沒有遇到過這樣的開發場景？
服務通過介面對外提供資料，或者服務之間進行資料互動，首先查詢資料庫并映射成資料物件（XxxDO），
正常情況下，介面是不允許直接以資料庫資料物件 XxxDO 形式對外提供資料的，而是要再封裝成資料傳輸物件（XxxDTO）提供出去，
為什么不能直接提供 DO？
1）根據單一設計原則，DO 只能對應資料物體物件，不能承擔其他職責；
2）DO 可能包含表所有欄位資料，不符合介面的引數定義，資料如果過大會影響傳輸速度，也不符合資料安全原則；
3）根據《阿里 Java 開發手冊》分層領域模型規約，不能一個物件走天下，需要定義成 POJO/DO/BO/DTO/VO/Query 等資料物件，完整的定義可以參考阿里開發手冊，關注公眾號：Java技術堆疊，在后臺回復：手冊，可以獲取最新高清完整版，
傳統 DO -> DTO 做法
XxxDTO 可能包含 XxxDO 大部分資料，或者組合其他 DO 的部分資料，傳統的做法有以下幾種：
- get/ set
- 構造器
- BeanUtils 工具類
- Builder 模式
我相信大部分人的做法都是這樣的，雖然很直接，但是普遍真的很 Low，耦合性又強，還經常丟引數，或者搞錯引數值，在這個開發場景，我個人覺得這些都不是最佳的方式，
這種開發場景又實在是太常見了，那有沒有一種 Java bean 自動映射工具？
沒錯——正是 MapStruct！！
MapStruct 簡介
官網地址：
https://mapstruct.org/
開源地址：
https://github.com/mapstruct/mapstruct
Java bean mappings, the easy way!
以簡單的方式進行 Java bean 映射，
MapStruct 是一個代碼生成器，它和 Spring Boot、Maven 一樣也是基于約定優于配置的理念，極大地簡化了 Java bean 之間資料映射的實作，
MapStruct 的優勢：
1、MapStruct 使用簡單的方法呼叫生成映射代碼，因此速度非常快；
2、型別安全，避免出錯，只能映射相互映射的物件和屬性，因此不會錯誤將用戶物體錯誤地映射到訂單 DTO；
3、只需要 JDK 1.8+，不用其他任何依賴，自包含所有代碼；
4、易于除錯；
5、易于理解；
支持的方式：
MapStruct 支持命令列編譯，如：純 javac 命令、Maven、Gradle、Ant 等等，也支持 Eclipse、IntelliJ IDEA 等 IDEs，
MapStruct 實戰
本文堆疊長基于 IntelliJ IDEA、Spring Boot、Maven 進行演示，
基本準備
新增兩個資料庫 DO 類：
一個用戶主類，一個用戶擴展類，
/**
* 微信公眾號：Java技術堆疊
* @author 堆疊長
*/
@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;
}
/**
* 微信公眾號：Java技術堆疊
* @author 堆疊長
*/
@Data
public class UserExtDO {
private String regSource;
private String favorite;
private String school;
private int kids;
private String memo;
}
新增一個資料傳輸 DTO 類：
用戶展示類，包含用戶主類、用戶擴展類的部分資料，
/**
* 微信公眾號：Java技術堆疊
* @author 堆疊長
*/
@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;
}
開始實戰
重點來了，不要 get/set，不要 BeanUtils，怎么把兩個用戶物件的資料封裝到 DTO 物件？
Spring Boot 基礎這篇就不介紹了，系列基礎教程和示例原始碼可以看這里：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 插件相關配置：
MapStruct 和 Lombok 結合使用會有版本沖突問題，注意以下配置，
<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 及以上需要添加，不然報錯 -->
<path>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-mapstruct-binding</artifactId>
<version>${lombok-mapstruct-binding.version}</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
</plugins>
</build>
添加 MapStruct 映射：
/**
* 微信公眾號：Java技術堆疊
* @author 堆疊長
*/
@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);
}
重點說明：
1）添加一個 interface 介面，使用 MapStruct 的 @Mapper 注解修飾，這里取名 XxxStruct，是為了不和 MyBatis 的 Mapper 混淆；
2）使用 Mappers 添加一個 INSTANCE 實體，也可以使用 Spring 注入，后面會講到；
3）添加兩個映射方法，回傳單個物件、物件串列；
4）使用 @Mappings + @Mapping 組合映射，如果兩個欄位名相同可以不用寫，可以指定映射的日期格式、數字格式、運算式等，ignore 表示忽略該欄位映射；
5）List 方法的映射會呼叫單個方法映射，不用單獨映射，后面看原始碼就知道了；
另外，Java 8+ 以上版本不需要 @Mappings 注解，直接使用 @Mapping 注解就行了：
Java 8 修改之后：
/**
* 微信公眾號：Java技術堆疊
* @author 堆疊長
*/
@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);
}
測驗一下：
/**
* 微信公眾號：Java技術堆疊
* @author 堆疊長
*/
public class UserStructTest {
@Test
public void test1() {
UserExtDO userExtDO = new UserExtDO();
userExtDO.setRegSource("公眾號：Java技術堆疊");
userExtDO.setFavorite("寫代碼");
userExtDO.setSchool("社會大學");
UserDO userDO = new UserDO();
userDO.setName("堆疊長");
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("=====單個物件映射=====");
System.out.println(userShowDTO);
List<UserDO> userDOs = new ArrayList<>();
UserDO userDO2 = new UserDO();
BeanUtils.copyProperties(userDO, userDO2);
userDO2.setName("堆疊長2");
userDOs.add(userDO);
userDOs.add(userDO2);
List<UserShowDTO> userShowDTOs = UserStruct.INSTANCE.toUserShowDTOs(userDOs);
System.out.println("=====物件串列映射=====");
userShowDTOs.forEach(System.out::println);
}
}
輸出結果：
來看結果，資料轉換結果成功，
什么原理？
如上我們知道，通過一個注解修飾介面就可以搞定了，是什么原理呢？
來看編譯后的目錄：
原理就是在編譯期間生成了一個該介面的實作類，
打開看下其原始碼：
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; } } }}
其實實作類就是呼叫了物件的 get/set 等其他常規操作，而 List 就是回圈呼叫的該物件的單個映射方法，這下就清楚了吧！
Spring 注入法
上面的示例創建了一個 UserStruct 實體：
UserStruct INSTANCE = Mappers.getMapper(UserStruct.class);
如 @Mapper 注解原始碼所示：
引數 componentModel 默認值是 default，也就是手動創建實體，也可以通過 Spring 注入，
Spring 修改版如下：
干掉了 INSTANCE，@Mapper 注解加入了 componentModel = "spring" 值，
/** * 微信公眾號：Java技術堆疊 * @author 堆疊長 */@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);}
測驗一下：
本文用到了 Spring Boot，所以這里就要用到 Spring Boot 的單元測驗方法，Spring Boot 單元測驗不懂的可以關注公眾號：Java技術堆疊，在后臺回復：boot，系列教程都整理好了，
/** * 微信公眾號：Java技術堆疊 * @author 堆疊長 */@RunWith(SpringRunner.class)@SpringBootTestpublic class UserSpringStructTest { @Autowired private UserSpringStruct userSpringStruct; @Test public void test1() { UserExtDO userExtDO = new UserExtDO(); userExtDO.setRegSource("公眾號：Java技術堆疊"); userExtDO.setFavorite("寫代碼"); userExtDO.setSchool("社會大學"); UserDO userDO = new UserDO(); userDO.setName("堆疊長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("=====單個物件映射====="); System.out.println(userShowDTO); List<UserDO> userDOs = new ArrayList<>(); UserDO userDO2 = new UserDO(); BeanUtils.copyProperties(userDO, userDO2); userDO2.setName("堆疊長Spring2"); userDOs.add(userDO); userDOs.add(userDO2); List<UserShowDTO> userShowDTOs = userSpringStruct.toUserShowDTOs(userDOs); System.out.println("=====物件串列映射====="); userShowDTOs.forEach(System.out::println); }}
如上所示，直接使用 @Autowired 注入就行，使用更方便，
輸出結果：
沒毛病，穩如狗，
總結
本文堆疊長只是介紹了 MapStruct 的簡單用法，使用 MapStruct 可以使代碼更優雅，還能避免出錯，其實還有很多復雜的、個性化用法，一篇難以寫完，堆疊長后面有時間會整理出來，陸續給大家分享，
感興趣的也可以參考官方檔案：
https://mapstruct.org/documentation/reference-guide/
本文實戰源代碼完整版已經上傳：
https://github.com/javastacks/spring-boot-best-practice
歡迎 Star 學習，后面 Spring Boot 示例都會在這上面提供！
好了，今天的分享就到這了，后面我還會陸續解讀更多的好玩的 Java 技術，關注公眾號Java技術堆疊第一時間推送，另外，我也將 Spring Boot 系列主流面試題和參考答案都整理好了，關注公眾號Java技術堆疊回復關鍵字 "面試" 進行刷題，
最后，覺得我的文章對你用識訓的話，動動小手，給個在看、轉發，原創不易，堆疊長需要你的鼓勵，
著作權申明：本文系公眾號 "Java技術堆疊" 原創，原創實屬不易，轉載、參考本文內容請注明出處，禁止抄襲、洗稿，請自重，尊重大家的勞動成果和知識產權，抄襲必究，
近期熱文推薦：
1.1,000+ 道 Java面試題及答案整理(2021最新版)
2.別在再滿屏的 if/ else 了，試試策略模式，真香！！
3.臥槽！Java 中的 xx ≠ null 是什么新語法？
4.Spring Boot 2.5 重磅發布，黑暗模式太炸了！
5.《Java開發手冊（嵩山版）》最新發布，速速下載！
覺得不錯，別忘了隨手點贊+轉發哦！
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/297988.html
標籤：其他