自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

干掉 BeanUtils！試試這款 Bean 自動映射工具，真心強大?。?/h1>

作者： 棧長
開發(fā) 開發(fā)工具
服務(wù)通過接口對外提供數(shù)據(jù)，或者服務(wù)之間進(jìn)行數(shù)據(jù)交互，首先查詢數(shù)據(jù)庫并映射成數(shù)據(jù)對象（XxxDO）。

[[422058]]

開發(fā)背景

你有沒有遇到過這樣的開發(fā)場景?

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

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

為什么不能直接提供 DO?

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

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

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

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

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

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

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

這種開發(fā)場景又實在是太常見了，那有沒有一種 Java bean 自動映射工具?

沒錯——正是 MapStruct!!

MapStruct 簡介

官網(wǎng)地址：

https://mapstruct.org/

開源地址：

https://github.com/mapstruct/mapstruct

Java bean mappings, the easy way!

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

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

MapStruct 的優(yōu)勢：

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

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

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

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

5、易于理解;

支持的方式：

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

MapStruct 實戰(zhàn)

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

基本準(zhǔn)備

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

一個用戶主類，一個用戶擴展類。

  1. /** 
  2.  * 微信公眾號：Java技術(shù)棧 
  3.  * @author 棧長 
  4.  */ 
  5. @Data 
  6. public class UserDO { 
  7.  
  8.     private String name; 
  9.  
  10.     private int sex; 
  11.  
  12.     private int age; 
  13.  
  14.     private Date birthday; 
  15.  
  16.     private String phone; 
  17.  
  18.     private boolean married; 
  19.  
  20.     private Date regDate; 
  21.  
  22.     private Date loginDate; 
  23.  
  24.     private String memo; 
  25.  
  26.     private UserExtDO userExtDO; 
  27.  
  28.  
  29. } 
  1. /** 
  2.  * 微信公眾號：Java技術(shù)棧 
  3.  * @author 棧長 
  4.  */ 
  5. @Data 
  6. public class UserExtDO { 
  7.  
  8.     private String regSource; 
  9.  
  10.     private String favorite; 
  11.  
  12.     private String school; 
  13.  
  14.     private int kids; 
  15.  
  16.     private String memo; 
  17.  
  18. } 

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

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

  1. /** 
  2.  * 微信公眾號：Java技術(shù)棧 
  3.  * @author 棧長 
  4.  */ 
  5. @Data 
  6. public class UserShowDTO { 
  7.  
  8.     private String name; 
  9.  
  10.     private int sex; 
  11.  
  12.     private boolean married; 
  13.  
  14.     private String birthday; 
  15.  
  16.     private String regDate; 
  17.  
  18.     private String registerSource; 
  19.  
  20.     private String favorite; 
  21.  
  22.     private String memo; 
  23.  
  24. } 

開始實戰(zhàn)

重點來了，不要 get/set，不要 BeanUtils，怎么把兩個用戶對象的數(shù)據(jù)封裝到 DTO 對象?

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

引入 MapStruct 依賴：

  1. <dependencies> 
  2.     <dependency> 
  3.         <groupId>org.mapstruct</groupId> 
  4.         <artifactId>mapstruct</artifactId> 
  5.         <version>${org.mapstruct.version}</version> 
  6.     </dependency> 
  7. </dependencies> 

 

 

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

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

  1. <build> 
  2.     <plugins> 
  3.         <plugin> 
  4.             <groupId>org.apache.maven.plugins</groupId> 
  5.             <artifactId>maven-compiler-plugin</artifactId> 
  6.             <version>3.8.1</version> 
  7.             <configuration> 
  8.                 <source>1.8</source> 
  9.                 <target>1.8</target> 
  10.                 <annotationProcessorPaths> 
  11.                     <path> 
  12.                         <groupId>org.mapstruct</groupId> 
  13.                         <artifactId>mapstruct-processor</artifactId> 
  14.                         <version>${org.mapstruct.version}</version> 
  15.                     </path> 
  16.                     <!-- 使用 Lombok 需要添加 --> 
  17.                     <path> 
  18.                         <groupId>org.projectlombok</groupId> 
  19.                         <artifactId>lombok</artifactId> 
  20.                         <version>${org.projectlombok.version}</version> 
  21.                     </path> 
  22.                     <!-- Lombok 1.18.16 及以上需要添加，不然報錯 --> 
  23.                     <path> 
  24.                         <groupId>org.projectlombok</groupId> 
  25.                         <artifactId>lombok-mapstruct-binding</artifactId> 
  26.                         <version>${lombok-mapstruct-binding.version}</version> 
  27.                     </path> 
  28.                 </annotationProcessorPaths> 
  29.             </configuration> 
  30.         </plugin> 
  31.     </plugins> 
  32. </build> 

 

 

 

 

 

 

添加 MapStruct 映射：

  1. /** 
  2.  * 微信公眾號：Java技術(shù)棧 
  3.  * @author 棧長 
  4.  */ 
  5. @Mapper 
  6. public interface UserStruct { 
  7.  
  8.     UserStruct INSTANCE = Mappers.getMapper(UserStruct.class); 
  9.  
  10.  @Mappings({ 
  11.         @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd") 
  12.         @Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))") 
  13.         @Mapping(source = "userExtDO.regSource", target = "registerSource") 
  14.         @Mapping(source = "userExtDO.favorite", target = "favorite") 
  15.         @Mapping(target = "memo", ignore = true) 
  16.     }) 
  17.     UserShowDTO toUserShowDTO(UserDO userDO); 
  18.  
  19.     List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOs); 
  20.  
  21. } 

重點說明：

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

2)使用 Mappers 添加一個 INSTANCE 實例，也可以使用 Spring 注入，后面會講到;

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

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

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

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

Java 8 修改之后：

  1. /** 
  2.  * 微信公眾號：Java技術(shù)棧 
  3.  * @author 棧長 
  4.  */ 
  5. @Mapper 
  6. public interface UserStruct { 
  7.  
  8.     UserStruct INSTANCE = Mappers.getMapper(UserStruct.class); 
  9.  
  10.     @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd") 
  11.     @Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))") 
  12.     @Mapping(source = "userExtDO.regSource", target = "registerSource") 
  13.     @Mapping(source = "userExtDO.favorite", target = "favorite") 
  14.     @Mapping(target = "memo", ignore = true) 
  15.     UserShowDTO toUserShowDTO(UserDO userDO); 
  16.  
  17.     List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOs); 
  18.  
  19. } 

測試一下：

  1. /** 
  2.  * 微信公眾號：Java技術(shù)棧 
  3.  * @author 棧長 
  4.  */ 
  5. public class UserStructTest { 
  6.  
  7.     @Test 
  8.     public void test1() { 
  9.         UserExtDO userExtDO = new UserExtDO(); 
  10.         userExtDO.setRegSource("公眾號：Java技術(shù)棧"); 
  11.         userExtDO.setFavorite("寫代碼"); 
  12.         userExtDO.setSchool("社會大學(xué)"); 
  13.  
  14.         UserDO userDO = new UserDO(); 
  15.         userDO.setName("棧長"); 
  16.         userDO.setSex(1); 
  17.         userDO.setAge(18); 
  18.         userDO.setBirthday(new Date()); 
  19.         userDO.setPhone("18888888888"); 
  20.         userDO.setMarried(true); 
  21.         userDO.setRegDate(new Date()); 
  22.         userDO.setMemo("666"); 
  23.         userDO.setUserExtDO(userExtDO); 
  24.  
  25.         UserShowDTO userShowDTO = UserStruct.INSTANCE.toUserShowDTO(userDO); 
  26.         System.out.println("=====單個對象映射====="); 
  27.         System.out.println(userShowDTO); 
  28.  
  29.         List<UserDO> userDOs = new ArrayList<>(); 
  30.         UserDO userDO2 = new UserDO(); 
  31.         BeanUtils.copyProperties(userDO, userDO2); 
  32.         userDO2.setName("棧長2"); 
  33.         userDOs.add(userDO); 
  34.         userDOs.add(userDO2); 
  35.         List<UserShowDTO> userShowDTOs = UserStruct.INSTANCE.toUserShowDTOs(userDOs); 
  36.         System.out.println("=====對象列表映射====="); 
  37.         userShowDTOs.forEach(System.out::println); 
  38.     } 
  39. } 

輸出結(jié)果：

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

什么原理?

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

來看編譯后的目錄：

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

打開看下其源碼：

  1. public class UserStructImpl implements UserStruct { 
  2.     public UserStructImpl() { 
  3.     } 
  4.  
  5.     public UserShowDTO toUserShowDTO(UserDO userDO) { 
  6.         if (userDO == null) { 
  7.             return null; 
  8.         } else { 
  9.             UserShowDTO userShowDTO = new UserShowDTO(); 
  10.             if (userDO.getBirthday() != null) { 
  11.                 userShowDTO.setBirthday((new SimpleDateFormat("yyyy-MM-dd")).format(userDO.getBirthday())); 
  12.             } 
  13.  
  14.             userShowDTO.setRegisterSource(this.userDOUserExtDORegSource(userDO)); 
  15.             userShowDTO.setFavorite(this.userDOUserExtDOFavorite(userDO)); 
  16.             userShowDTO.setName(userDO.getName()); 
  17.             userShowDTO.setSex(userDO.getSex()); 
  18.             userShowDTO.setMarried(userDO.isMarried()); 
  19.             userShowDTO.setRegDate(DateFormatUtils.format(userDO.getRegDate(), "yyyy-MM-dd HH:mm:ss")); 
  20.             return userShowDTO; 
  21.         } 
  22.     } 
  23.  
  24.     public List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOs) { 
  25.         if (userDOs == null) { 
  26.             return null; 
  27.         } else { 
  28.             List<UserShowDTO> list = new ArrayList(userDOs.size()); 
  29.             Iterator var3 = userDOs.iterator(); 
  30.  
  31.             while(var3.hasNext()) { 
  32.                 UserDO userDO = (UserDO)var3.next(); 
  33.                 list.add(this.toUserShowDTO(userDO)); 
  34.             } 
  35.  
  36.             return list; 
  37.         } 
  38.     } 
  39.  
  40.     private String userDOUserExtDORegSource(UserDO userDO) { 
  41.         if (userDO == null) { 
  42.             return null; 
  43.         } else { 
  44.             UserExtDO userExtDO = userDO.getUserExtDO(); 
  45.             if (userExtDO == null) { 
  46.                 return null; 
  47.             } else { 
  48.                 String regSource = userExtDO.getRegSource(); 
  49.                 return regSource == null ? null : regSource; 
  50.             } 
  51.         } 
  52.     } 
  53.  
  54.     private String userDOUserExtDOFavorite(UserDO userDO) { 
  55.         if (userDO == null) { 
  56.             return null; 
  57.         } else { 
  58.             UserExtDO userExtDO = userDO.getUserExtDO(); 
  59.             if (userExtDO == null) { 
  60.                 return null; 
  61.             } else { 
  62.                 String favorite = userExtDO.getFavorite(); 
  63.                 return favorite == null ? null : favorite; 
  64.             } 
  65.         } 
  66.     } 
  67. } 

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

Spring 注入法

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

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

如 @Mapper 注解源碼所示：

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

Spring 修改版如下：

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

  1. /** 
  2.  * 微信公眾號：Java技術(shù)棧 
  3.  * @author 棧長 
  4.  */ 
  5. @Mapper(componentModel = "spring") 
  6. public interface UserSpringStruct { 
  7.  
  8.     @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd") 
  9.     @Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))") 
  10.     @Mapping(source = "userExtDO.regSource", target = "registerSource") 
  11.     @Mapping(source = "userExtDO.favorite", target = "favorite") 
  12.     @Mapping(target = "memo", ignore = true) 
  13.     UserShowDTO toUserShowDTO(UserDO userDO); 
  14.  
  15.     List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOS); 
  16.  
  17. } 

測試一下：

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

  1. /** 
  2.  * 微信公眾號：Java技術(shù)棧 
  3.  * @author 棧長 
  4.  */ 
  5. @RunWith(SpringRunner.class) 
  6. @SpringBootTest 
  7. public class UserSpringStructTest { 
  8.  
  9.     @Autowired 
  10.     private UserSpringStruct userSpringStruct; 
  11.  
  12.     @Test 
  13.     public void test1() { 
  14.         UserExtDO userExtDO = new UserExtDO(); 
  15.         userExtDO.setRegSource("公眾號：Java技術(shù)棧"); 
  16.         userExtDO.setFavorite("寫代碼"); 
  17.         userExtDO.setSchool("社會大學(xué)"); 
  18.  
  19.         UserDO userDO = new UserDO(); 
  20.         userDO.setName("棧長Spring"); 
  21.         userDO.setSex(1); 
  22.         userDO.setAge(18); 
  23.         userDO.setBirthday(new Date()); 
  24.         userDO.setPhone("18888888888"); 
  25.         userDO.setMarried(true); 
  26.         userDO.setRegDate(new Date()); 
  27.         userDO.setMemo("666"); 
  28.         userDO.setUserExtDO(userExtDO); 
  29.  
  30.         UserShowDTO userShowDTO = userSpringStruct.toUserShowDTO(userDO); 
  31.         System.out.println("=====單個對象映射====="); 
  32.         System.out.println(userShowDTO); 
  33.  
  34.         List<UserDO> userDOs = new ArrayList<>(); 
  35.         UserDO userDO2 = new UserDO(); 
  36.         BeanUtils.copyProperties(userDO, userDO2); 
  37.         userDO2.setName("棧長Spring2"); 
  38.         userDOs.add(userDO); 
  39.         userDOs.add(userDO2); 
  40.         List<UserShowDTO> userShowDTOs = userSpringStruct.toUserShowDTOs(userDOs); 
  41.         System.out.println("=====對象列表映射====="); 
  42.         userShowDTOs.forEach(System.out::println); 
  43.     } 
  44. } 

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

輸出結(jié)果：

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

總結(jié)

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

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

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

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

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

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

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

 

責(zé)任編輯：武曉燕 來源： Java技術(shù)棧
工具自動映射
相關(guān)推薦

2023-08-01 07:45:52

2022-06-06 08:37:13

Linux遠(yuǎn)程桌面工具

2022-02-25 15:06:53

PowerDesig開源工具

2020-06-30 14:50:59

微服務(wù)日志架構(gòu)

2021-02-01 10:11:04

工具代碼開發(fā)

2022-03-08 13:46:22

httpClientHTTP前端

2020-02-07 09:17:54

3D打印機技術(shù)辦公

2023-03-09 07:35:35

2021-02-22 11:35:43

網(wǎng)絡(luò)數(shù)據(jù)技術(shù)

2021-01-11 14:16:19

Bean代碼Java

2022-01-06 08:34:32

數(shù)據(jù)庫Spark查詢

2021-07-08 06:47:19

JVM監(jiān)控工具

2020-07-21 15:53:18

戴爾

2024-03-26 10:30:37

Mybatis擴展庫API

2010-06-25 11:04:59

2020-08-10 10:40:03

工具類MapStructJava

2020-08-10 14:30:09

BeanUtils工具類MapStruct

2021-10-25 08:00:00

工具DataTrucker后端

2022-05-23 09:03:35

Heighliner開發(fā)者工具

2020-05-11 09:48:28

網(wǎng)絡(luò)故障路由器Linux
點贊
收藏

51CTO技術(shù)棧公眾號