别再用 BeanUtils 了，这款 PO VO DTO 转换神器不香么？

转x33g5p2x  于2021-11-28 转载在 其他  
字(6.8k)|赞(0)|评价(0)|浏览(384)

老铁们是不是经常为写一些实体转换的原始代码感到头疼，尤其是实体字段特别多的时候。介绍一个开源项目 mapstruct ，可以轻松优雅的进行转换，简化你的代码。

当然有的人喜欢写get set，或者用BeanUtils 进行复制，代码只是工具，本文只是提供一种思路。

先贴下官网地址吧：https://mapstruct.org/

废话不多说，上代码：

pom 配置：

  1. <properties>
  2.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  3.         <maven.compiler.source>1.8</maven.compiler.source>
  4.         <maven.compiler.target>1.8</maven.compiler.target>
  5.         <org.mapstruct.version>1.4.1.Final</org.mapstruct.version>
  6.         <org.projectlombok.version>1.18.12</org.projectlombok.version>
  7. </properties>
  9. <dependencies>
  10.         <dependency>
  11.             <groupId>org.mapstruct</groupId>
  12.             <artifactId>mapstruct</artifactId>
  13.             <version>${org.mapstruct.version}</version>
  14.         </dependency>
  16.         <!-- lombok dependencies should not end up on classpath -->
  17.         <dependency>
  18.             <groupId>org.projectlombok</groupId>
  19.             <artifactId>lombok</artifactId>
  20.             <version>${org.projectlombok.version}</version>
  21.             <scope>provided</scope>
  22.         </dependency>
  24.         <!-- idea 2018.1.1 之前的版本需要添加下面的配置，后期的版本就不需要了，可以注释掉， 我自己用的2019.3 -->
  25.      <dependency>
  26.             <groupId>org.mapstruct</groupId>
  27.             <artifactId>mapstruct-processor</artifactId>
  28.             <version>${org.mapstruct.version}</version>
  29.             <scope>provided</scope>
  30.         </dependency>
  32. </dependencies>
  34. <build>
  35.         <plugins>
  36.             <plugin>
  37.                 <groupId>org.apache.maven.plugins</groupId>
  38.                 <artifactId>maven-compiler-plugin</artifactId>
  39.                 <version>3.8.1</version>
  40.                 <configuration>
  41.                     <source>1.8</source>
  42.                     <target>1.8</target>
  43.                     <annotationProcessorPaths>
  44.                         <path>
  45.                             <groupId>org.projectlombok</groupId>
  46.                             <artifactId>lombok</artifactId>
  47.                             <version>${org.projectlombok.version}</version>
  48.                         </path>
  49.                         <path>
  50.                             <groupId>org.mapstruct</groupId>
  51.                             <artifactId>mapstruct-processor</artifactId>
  52.                             <version>${org.mapstruct.version}</version>
  53.                         </path>
  54.                     </annotationProcessorPaths>
  55.                 </configuration>
  56.             </plugin>
  57.         </plugins>
  58.     </build>

关于lombok和mapstruct的版本兼容问题多说几句，maven插件要使用3.6.0版本以上、lombok使用1.16.16版本以上，另外编译的lombok mapstruct的插件不要忘了加上。否则会出现下面的错误：No property named "aaa" exists in source parameter(s). Did you mean "null"?

这种异常就是lombok编译异常导致缺少get setter方法造成的。还有就是缺少构造函数也会抛异常。学习资料：Java进阶视频资源

  1. @Data
  2. @Builder
  3. @AllArgsConstructor
  4. @NoArgsConstructor
  5. public class Student {
  7.     private String name;
  8.     private int age;
  9.     private GenderEnum gender;
  10.     private Double height;
  11.     private Date birthday;
  13. }
  14. public enum GenderEnum {
  15.     Male("1", "男"),
  16.     Female("0", "女");
  18.     private String code;
  19.     private String name;
  21.     public String getCode() {
  22.         return this.code;
  23.     }
  25.     public String getName() {
  26.         return this.name;
  27.     }
  29.     GenderEnum(String code, String name) {
  30.         this.code = code;
  31.         this.name = name;
  32.     }
  33. }
  34. @Data
  35. @Builder
  36. @AllArgsConstructor
  37. @NoArgsConstructor
  38. public class StudentVO {
  39.     private String name;
  40.     private int age;
  41.     private String gender;
  42.     private Double height;
  43.     private String birthday;
  44. }
  45. @Mapper
  46. public interface StudentMapper {
  48.     StudentMapper INSTANCE = Mappers.getMapper(StudentMapper.class);
  50.     @Mapping(source = "gender.name", target = "gender")
  51.     @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")
  52.     StudentVO student2StudentVO(Student student);
  54. }

实体类是开发过程少不了的，就算是用工具生成肯定也是要有的，需要手写的部分就是这个Mapper的接口，编译完成后会自动生成相应的实现类

然后就可以直接用mapper进行实体的转换了

  1. public class Test {
  3.     public static void main(String[] args) {
  5.         Student student = Student.builder().name("小明").age(6).gender(GenderEnum.Male).height(121.1).birthday(new Date()).build();
  6.         System.out.println(student);
  7.         //这行代码便是实际要用的代码
  8.         StudentVO studentVO = StudentMapper.INSTANCE.student2StudentVO(student);
  9.         System.out.println(studentVO);
  11.     }
  13. }

mapper可以进行字段映射，改变字段类型，指定格式化的方式，包括一些日期的默认处理。

可以手动指定格式化的方法：

  1. @Mapper
  2. public interface StudentMapper {
  4.     StudentMapper INSTANCE = Mappers.getMapper(StudentMapper.class);
  6.     @Mapping(source = "gender", target = "gender")
  7.     @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")
  8.     StudentVO student2StudentVO(Student student);
  10.     default String getGenderName(GenderEnum gender) {
  11.         return gender.getName();
  12.     }
  14. }

上面只是最简单的实体映射处理，下面介绍一些高级用法

1.List 转换

属性映射基于上面的mapping配置

  1. @Mapper
  2. public interface StudentMapper {
  4.     StudentMapper INSTANCE = Mappers.getMapper(StudentMapper.class);
  6.     @Mapping(source = "gender.name", target = "gender")
  7.     @Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")
  8.     StudentVO student2StudentVO(Student student);
  10.     List<StudentVO> students2StudentVOs(List<Student> studentList);
  12. }
  13. public static void main(String[] args) {
  15.     Student student = Student.builder().name("小明").age(6).gender(GenderEnum.Male).height(121.1).birthday(new Date()).build();
  17.     List<Student> list = new ArrayList<>();
  18.     list.add(student);
  19.     List<StudentVO> result = StudentMapper.INSTANCE.students2StudentVOs(list);
  20.     System.out.println(result);
  21. }

2.多对象转换到一个对象

  1. @Data
  2. @Builder
  3. @AllArgsConstructor
  4. @NoArgsConstructor
  5. public class Student {
  7.     private String name;
  8.     private int age;
  9.     private GenderEnum gender;
  10.     private Double height;
  11.     private Date birthday;
  13. }
  14. @Data
  15. @AllArgsConstructor
  16. @Builder
  17. @NoArgsConstructor
  18. public class Course {
  20.     private String courseName;
  21.     private int sortNo;
  22.     private long id;
  24. }
  25. @Data
  26. @Builder
  27. @AllArgsConstructor
  28. @NoArgsConstructor
  29. public class StudentVO {
  30.     private String name;
  31.     private int age;
  32.     private String gender;
  33.     private Double height;
  34.     private String birthday;
  35.     private String course;
  36. }
  37. @Mapper
  38. public interface StudentMapper {
  40.     StudentMapper INSTANCE = Mappers.getMapper(StudentMapper.class);
  42.     @Mapping(source = "student.gender.name", target = "gender")
  43.     @Mapping(source = "student.birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")
  44.     @Mapping(source = "course.courseName", target = "course")
  45.     StudentVO studentAndCourse2StudentVO(Student student, Course course);
  47. }
  48. public class Test {
  50.     public static void main(String[] args) {
  52.         Student student = Student.builder().name("小明").age(6).gender(GenderEnum.Male).height(121.1).birthday(new Date()).build();
  53.         Course course = Course.builder().id(1L).courseName("语文").build();
  55.         StudentVO studentVO = StudentMapper.INSTANCE.studentAndCourse2StudentVO(student, course);
  56.         System.out.println(studentVO);
  57.     }
  59. }

3.默认值

  1. @Mapper
  2. public interface StudentMapper {
  4.     StudentMapper INSTANCE = Mappers.getMapper(StudentMapper.class);
  6.     @Mapping(source = "student.gender.name", target = "gender")
  7.     @Mapping(source = "student.birthday", target = "birthday", dateFormat = "yyyy-MM-dd HH:mm:ss")
  8.     @Mapping(source = "course.courseName", target = "course")
  9.     @Mapping(target = "name", source = "student.name", defaultValue = "张三")
  10.     StudentVO studentAndCourse2StudentVO(Student student, Course course);
  12. }

（完）

  1. 【推荐阅读】
  2. 实战！基于Security+JWT的单点登陆开发及原理解析
  4. 撸了个DDD项目，爽！
  6. 程序员玩‘附近的人’，妹子还没泡，先学会了个专业技能！

好文章！点个在看！

版权说明 : 本文为转载文章, 版权归原作者所有 版权申明

原文链接 : https://blog.csdn.net/MarkerHub/article/details/121586447

内容来源于网络，如有侵权，请联系作者删除！

JavaMavenandroidGradlecmake

相关文章

    查看更多

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新文章

    更多
    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com