Java 实体映射工具 MapStruct

Dear 丶 2022-09-09 09:24 186阅读 0赞

官网地址：[https://mapstruct.org/documentation/stable/reference/html/][https_mapstruct.org_documentation_stable_reference_html]

### 1 DO（Domain Object）： ###

领域对象，就是从现实世界中抽象出来的有形或无形的业务实体。

### 2 DTO（Data Transfer Object）： ###

数据传输对象，这个概念来源于J2EE的设计模式，原来的目的是为了EJB的分布式应用提供粗粒度的数据实体，以减少分布式调用的次数，从而提高分布式调用的性能和降低网络负载，但在这里，我泛指用于展示层与服务层之间的数据传输对象。

3 DO 和DTO 的转换

在应用与应用之间，单独的应用细分模块之后，DO 一般不会让外部依赖，这时候需要在提供对外接口的模块里放 DTO 用于对象传输，也即是 DO 对象对内，DTO对象对外，DTO 可以根据业务需要变更，并不需要映射 DO 的全部属性。

maven 引入：

<properties>
        <mapstruct.version>1.4.2.Final</mapstruct.version>
    </properties>
    
    <dependencies>
        <dependency>
          <groupId>org.mapstruct</groupId>
          <artifactId>mapstruct-jdk8</artifactId>
          <version>${mapstruct.version}</version>
        </dependency>
        <dependency>
          <groupId>org.mapstruct</groupId>
          <artifactId>mapstruct-processor</artifactId>
          <version>${mapstruct.version}</version>
        </dependency>
    </dependencies>

4  主要功能

@Mapper 只有在接口加上这个注解， MapStruct 才会去实现该接口
        @Mapper 里有个 componentModel 属性，主要是指定实现类的类型，一般用到两个
        default：默认，可以通过 Mappers.getMapper(Class) 方式获取实例对象
        spring：在接口的实现类上自动添加注解 @Component，可通过 @Autowired 方式注入
    @Mapping：属性映射，若源对象属性与目标对象名字一致，会自动映射对应属性
        source：源属性
        target：目标属性
        dateFormat：String 到 Date 日期之间相互转换，通过 SimpleDateFormat，该值为 SimpleDateFormat              的日期格式
        ignore: 忽略这个字段
    @Mappings：配置多个@Mapping
    @MappingTarget 用于更新已有对象
    @InheritConfiguration 用于继承配置

5  例子

MapStruct 可以将几种类型的对象映射为另外一种类型，比如将多个 DO 对象转换为 DTO

@Mapper
    public interface StudentConverter {
        StudentConverter INSTANCE = Mappers.getMapper(StudentConverter .class);
    
        @Mappings({
                @Mapping(source = "stu.id",target = "stuId"),
                @Mapping(source = "stu.code",target = "stuCode"),
                @Mapping(source = "stu.price",target = "stuPrice"),
                @Mapping(source = "class.id",target = "classId"),
                @Mapping(source = "class.title",target = "className")
        })
        StudentDTO domain2dto(Class class, StudentVO stu);
    }

[https_mapstruct.org_documentation_stable_reference_html]: https://mapstruct.org/documentation/stable/reference/html/