『MapStruct』POJO 映射转换框架指南

已于 2023-11-11 21:11:10 修改
阅读量1k 收藏 38
点赞数 41
分类专栏： Java SE 文章标签： MapStruct 实体映射 Java Bean Bean 指南
于 2023-11-06 10:40:20 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_63748493/article/details/134241205
版权

前言

本文将会主要讲解后端开发中 VO、DTO、Entity 相互转化方式，并且针对其中比较成熟的框架 MapStruct 进行解读和教学

下载

问题

微服务架构下，服务拆分会产生 VO、DTO、Entity 三类 POJO

  • VO 用于前端接口参数传递，例如用于 http 接口接收请求参数。可以继承扩展 DTO，或者直接使用 DTO
  • DTO 用于 rpc 接口参数传递。单独定义，或者继承扩展其他 rpc 接口的 DTO
  • Entity（PO） 用于 orm 映射处理，与表结构对应，只在服务内部使用，不能对外

注：对于 POJO 的解释可以查看文章后面的 补充 章节

微服务架构面向不同场景的 POJO 定义，引入前端请求处理问题，也就是三者之间的转换：

  • 请求：VO => DTO => Entity
  • 返回：Entity => DTO => VO

结构

Entity

@Data
@TableName(value = "orders", schema = "crazy1984")
public class Order {
    @TableId(type = IdType.AUTO)
    private int id;
    private String orderId;
    private String orderType;
    private int orderStatus;
    private Date createdAt;
    private Date updatedAt;
}

DTO

@Data
public class OrderDTO {
    private String orderId;
    private String orderType;
    private int orderStatus;
    private Date createdAt;
}

VO

@Data
public class OrderVO extends OrderDTO{
    private String orderTypeName;
    private String orderStatusName;
}

手动转换

我们可以使用最直接的方法，通过代码对 POJO 属性进行逐个拷贝

但是这样的方式太低效，给开发人员增加许多低效的重复劳动，也不易维护（比如新增字段时，所有相关处都要同步修改）

OrderDTO dto = new OrderDTO();
dto.setOrderId(entity.getOrderId());
dto.setOrderType(entity.getOrderType());
dto.setOrderStatus(entity.getOrderStatus());
dto.setCreatedAt(entity.getCreatedAt());

工具类转换

改进方法为，使用工具类进行同名属性的自动拷贝，例如使用 Spring 的 BeanUtils

OrderDTO dto = new OrderDTO();
BeanUtils.copyProperties(entity, dto);

这样可以减少大量工作，但是会带来如下不足：

  • 不支持属性名映射，属性名必须完全相同
  • 不支持自动类型转换，Spring 的 BeanUtils 要求源属性与目标属性的类型是相互 assignable 的
  • 性能损耗大，属性拷贝中的属性名匹配、类型检查、写权限检查都是动态判断，有性能损耗

除此之外，还有很多工具类，下图为各类工具类对比：

拷贝工具使用效率
Spring BeanUtils使用方便，效率中等
Cglib BeanCopier使用方便，效率最高
Apache BeanUtils使用方便，效率低，原因为该工具做了很多校验，兼容，日志打印等，导致性能下降（阿里约束规范中禁止使用该工具）
Apache PropertyUtils使用方便，效率低
Hutool BeanUtil使用方便，封装完善，效率较高

映射框架转换

目前有很多开源成熟的 mapping 框架：

以上框架均支持不同属性名的映射，自动类型转换，递归映射自定义对象属性

实现原理为基于反射机制，实现类属性的 get，set 调用，基于注解、配置，来实现不同属性名的映射和类型转化

框架的性能对比，MapStruct 和 JMapper 性能较好。因为他们的映射过程是静态化的，所以实际性能和自己手写 get、set 一样

并且在开发过程中，可以通过检查生成的代码来确保映射转换没有错误，相比 ModelMapper 的黑盒实现更加可靠。对于 grpc 协议 protobuf 对象和 entity 的互相转换，也能很好的支持

下面我们将会详细讲解 MapStruct 框架的使用

MapStruct

简介

官方仓库：mapstruct/mapstruct: An annotation processor for generating type-safe bean mappers (github.com)

官方文档：MapStruct – Java bean mappings, the easy way!

MapStruct 是代码生成器，基于约定而不是配置，极大地简化 Java Bean 类型之间映射的实现

安装

官方文档：Installation – MapStruct

首先我们需要向 pom.xml 中添加如下内容

注：本文使用 Maven 为例，Gradle 用户可以参照上方的官方文档

...
<properties>
    <org.mapstruct.version>1.5.5.Final</org.mapstruct.version>
</properties>
...
<dependencies>
    <dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>${org.mapstruct.version}</version>
    </dependency>
</dependencies>
...
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <source>1.8</source> <!-- depending on your project -->
                <target>1.8</target> <!-- depending on your project -->
                <annotationProcessorPaths>
                    <path>
                        <groupId>org.mapstruct</groupId>
                        <artifactId>mapstruct-processor</artifactId>
                        <version>${org.mapstruct.version}</version>
                    </path>
                    <!-- other annotation processors -->
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>

示例

官方示例代码：mapstruct-examples/mapstruct-mapper-repo at main · mapstruct/mapstruct-examples (github.com)

我们可以直接单独下载上面对应 demo 的项目文件夹，具体方法参照文末 补充 章节

您也可以自行创建 Spring 项目，然后依次安装 MapStruct 后，创建如下文件

Car.java

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Car {

    private String make;
    private int numberOfSeats;
    private CarType type;
    
}

CarType.java

public enum CarType {
    SPORTS, OTHER;
}

CarDto.java

@Data
@AllArgsConstructor
@NoArgsConstructor
public class CarDto {

    private String make;
    private int seatCount;
    private String type;

}

CarMapper.java

@Mapper
public interface CarMapper {
 
    CarMapper INSTANCE = Mappers.getMapper( CarMapper.class );
 
    @Mapping(source = "numberOfSeats", target = "seatCount")
    CarDto carToCarDto(Car car);
}

TestMapperRepo.java

public class TestMapperRepo {
    @Test
    public void shouldMapCarToDto() {
        //given
        Car car = new Car("Morris", 5, CarType.SPORTS);

        //when
        CarDto carDto = CarMapper.INSTANCE.carToCarDto(car);

        //then
        assertThat(carDto).isNotNull();
        assertThat(carDto.getMake()).isEqualTo("Morris");
        assertThat(carDto.getSeatCount()).isEqualTo(5);
        assertThat(carDto.getType()).isEqualTo("SPORTS");
    }
}

但是 MapStruct 默认是和 Lombok 冲突的，无法识别，会出现属性找不到错误，您可以将 Lombok 注释替换为对应代码，或者是 pom.xml 替换如下

<properties>
    <org.projectlombok.version>1.18.16</org.projectlombok.version>
    <org.mapstruct.version>1.5.5.Final</org.mapstruct.version>
    <lombok-mapstruct-binding.version>0.2.0</lombok-mapstruct-binding.version>
</properties>

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

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

<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.projectlombok</groupId>
                        <artifactId>lombok</artifactId>
                        <version>${org.projectlombok.version}</version>
                    </path>
                    <!-- This is needed when using Lombok 1.18.16 and above -->
                    <path>
                        <groupId>org.projectlombok</groupId>
                        <artifactId>lombok-mapstruct-binding</artifactId>
                        <version>${lombok-mapstruct-binding.version}</version>
                    </path>
                    <!-- Mapstruct should follow the lombok path(s) -->
                    <path>
                        <groupId>org.mapstruct</groupId>
                        <artifactId>mapstruct-processor</artifactId>
                        <version>${org.mapstruct.version}</version>
                    </path>
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>

我们需要确保 Lombok 最低版本为 1.18.16，同时 annotationProcessorPaths 中，mapstruct-processor 的配置要在 lombok 之后

补充

POJO

POJO vs Java Beans - GeeksforGeeks

简介

POJO（Plain Old Java Object） 字面翻译为 “纯洁老式的 Java 对象”，但是其更加通俗的名称为 “简单 Java 对象”

内在含义：不继承或不实现任何其它 Java 框架的类或接口，没有被其它框架侵入的 Java 对象

注：里面的类和接口仅指的是其它 Java 框架中的类和接口，而不是所有类和接口

相关链接：

转换对象

我们可以辅助理解 POJO 是中间对象

该中间对象可以根据不同情况转换为 PO、DTO、VO

1 ．POJO 持久化之后 --> PO（Persistent Object）

2 ．POJO 传输过程中 --> DTO（Data Transfer Object）

3 ．POJO 用作表示层 --> VO（View Object）

4 ．POJO 用作业务逻辑层 --> BO（Business Object）

注：BO 主要作用是把业务逻辑封装为对象，这个对象可以包括一个或多个其它的对象，BO 通过调用 DAO 方法，结合 PO，VO 进行业务操作

GitHub 单独下载文件夹

单独下载文件不必多说，我们点击进入 GitHub 的文件之后右上角会有 raw 文件下载按钮，点击即可下载源文件

如果是下载文件夹的话，有以下方式

GitZip

下载谷歌插件 GitZip

链接：GitZip for github - Chrome 应用商店 (google.com)

安装之后我们双击对应的文件夹，然后点击右下角的下载按钮即可下载

image-20231104112214588

DownGit

网站地址：DownGit (minhaskamal.github.io)

参考链接

本文由博客一文多发平台 OpenWrite 发布！

白木Channel
关注
  • 41
    点赞
  • 踩
  • 38
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 78
    评论
专栏目录
效率提升-简化java开发中pojo的转换（mapstruct）
感性企鹅的专栏
04-03 601
背景 在java的web开发中，pojo转换难以避免，mapstruct工具帮我们进行了简化，本wiki将进行实践。 实践过程 简易实践 创建一个hello项目（最简单的maven项目即可）。 pom文件添加依赖 <properties> <mapstruct.version>1.2.0.Final</mapstruct.version&gt...
java项目实体类转换实例
02-18
java项目实体类转换实例
java Pojo转Map
11-18
jsp上使用object[]看不懂吧？写vo太烦琐了？ok，都交给map吧、本工具类的使命就是让map代替所有的vo，让编程变得更美好。 附有详细的使用例子。 java精英团队十年编程精华。
Mapstruct（java代码简洁之道）Mapstruct助力pojo之间的花式转换
weixin_53209288的博客
07-12 499
一、mapstruct简介 1、官网：https://mapstruct.org/，使用的版本1.3.1.Final 2、使用场景 ：pojo（参考lombok）之间的相互转化。 3、不同的convert解决方案 二、Mapstruct的使用 2.1不使用框架的缺点 1、多而杂的代码与业务逻辑耦合,不能突出业务逻辑的重点 2、重复的劳动 2.2@Mapper 1、默认映射规则 同类型且同名的属性，会自动映射 2、mapstruct会自动类型转换 8种基本类型和他们对应的包装.
java 中实体类值转换
fight_man8866的博客
11-21 1019
public class ConvertModelHelper { /** * 转换模型对象类型 * * @param source 要转换的源对象 * @param clzTarget 转换后的类型 * @param <T> 转换后的类型 * @return 转换后的对象 * @depr...
POJO转Map.txt
01-28
POJO转Map代码，POJO转Map代码POJO转Map代码POJO转Map代码
java递归菜单树转换成pojo对象
09-05
介绍了java递归菜单树转换成pojo对象的具体实现，有需要的朋友可以参考一下
数据转换为pojo类
04-05
作者daniel-martins-IR，源码Specter，Specter是一个简单的方法来有效数据转换为pojo类，也是一个实现了数据转移到Pojo
hyberbin 框架 POJO类自动生成工具
08-07
3.POJO类中的成员变量类型必需为封装类。 4.seter和geter方法方法名就是在成员变量名首字母大写后加上set或get。 5.如果要使用延迟加载，POJO类必需继承com.jplus.basetable.BaseTable。 6.如果要使用延迟加载，...
Java中Json对象与POJO(java对象，JavaBean)的相互转换
清欢Viki的博客
08-16 2542
概述 使用Maven依赖和工具类集成的方式，可以在代码中直接调用工具类进行转换 方法 Maven依赖 <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <ver...
使用Reflect运行时进行Map和POJO的互相转换
千山独行
09-23 347
对于java.lang.reflect.Field来说，也就是一个类的域实例，可以通过以下方式来获得： [code] Field[] fields = clazz.getDeclaredFields() ; Field[] fields = clazz.getFields() ; [/code] getDeclaredFields方法可以获得类中任何可见性的属性但不包括父类，而get...
POJO与JSON的序列化与反序列化
baidu_zhongce的博客
04-27 1万+
0x00 定义以及相关概念POJO，Plain Old Java Object，是一种简单的Java对象，一般就是有一些private属性及其属性getter、setter方法的类。这种对象只能用来装载数据，作为数据存储的载体，而不具有业务逻辑处理的能力。JSON，Javascript Object Notation，是一种轻量级的数据交换格式，易于人阅读和编写，同时也易于机器解析和生成。其主要构建
JSON和JAVA的POJO的相互转换工具类
tlimited的博客
05-16 1993
import java.io.IOException; import java.util.ArrayList; import java.util.HashMap; import java.util.Iterator; import java.util.List; import java.util.Map; import net.sf.json.JSONArray; import net.sf.j...
各种POJO相互转换（反射+Cglib）
qq_18453581的博客
08-07 539
工具类方法 public static <T> T newByCglib(Class<T> tClass) { Enhancer enhancer = new Enhancer(); enhancer.setSuperclass(tClass); enhancer.setCallback((MethodInterceptor) (o, method, objects, methodProxy) -> {
JAVA-实现POJO 到XML的相互转换
u013490490的专栏
06-17 2037
Marshaller 类    ---由POJO 转换成 XML Unmarshaller 类---由XML转换成POJO 示例 import java.util.Date; import java.util.Set; import javax.xml.bind.annotation.XmlAttribute; import javax.xml.bind.annotation.Xm
java pojo 转 map_如何将POJO对象转换成MAP
weixin_42596011的博客
02-13 1959
展开全部很多情况需要将取得的POJO对象转换成其他表现形式,如Key-Value的Map形式,用于数据展现.本文介绍如何e5a48de588b662616964757a686964616f31333337376262将取得的POJO对象实例后如何转换成Map对象.代码如下1、类分析器代码，主要是分析类的构造取得类定义的属性和get/set方法import java.lang.reflect.Fie...
Java实体类之间的相互转换
热门推荐
微笑的博客
08-04 1万+
在pom.xml配置文件中添加依赖 <dependency> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> <version>23.4-jre</version> </dependency> 创建第一个实体类School public class School { pr
java实体类放在哪个包下_java的(PO,VO,TO,BO,DAO,POJO)类名包名解释
weixin_30438795的博客
02-13 8388
java的(PO,VO,TO,BO,DAO,POJO)解释action包顾名思义请求，主要是和view 即我们所说的视图就是页面打交道，action类 是 操作方法，对于页 面Form 表单的操作方法，具体操作方法的实现就在Action 类里面。bean 就是基本的JavaBean ,多为实体dao包 就是和数据库打交道的，crud 即增删改查，对于数据库的增删改查的操作都在这里。model ...
mapstruct类型转换
最新发布
09-09
对于MapStruct类型转换，您可以按照以下步骤进行操作： 1. 首先，在您的项目中添加MapStruct依赖。您可以在Maven或Gradle构建工具中添加相应的依赖项。 2. 创建源类型（source type）和目标类型（target type），这些类型可以是POJO（普通Java对象）。 3. 在源类型和目标类型之间创建一个Mapper接口。该接口应该使用`@Mapper`注解进行标记，并且可以定义多个转换方法。 4. 在转换方法中，使用`@Mapping`注解指定源类型和目标类型之间的映射关系。您可以使用属性名称、表达式或自定义转换器来定义映射规则。 5. 在您的代码中使用`Mapper`接口生成的实现类，通过调用转换方法进行类型转换。 下面是一个简单的示例： ```java // 源类型 public class Source { private String name; private int age; // getter和setter方法省略 } // 目标类型 public class Target { private String fullName; private int yearsOld; // getter和setter方法省略 } // Mapper接口 @Mapper public interface SourceTargetMapper { @Mapping(source = "name", target = "fullName") @Mapping(source = "age", target = "yearsOld") Target sourceToTarget(Source source); } // 使用转换器 public class Main { public static void main(String[] args) { Source source = new Source(); source.setName("John"); source.setAge(25); SourceTargetMapper mapper = Mappers.getMapper(SourceTargetMapper.class); Target target = mapper.sourceToTarget(source); System.out.println(target.getFullName()); // 输出: John System.out.println(target.getYearsOld()); // 输出: 25 } } ``` 通过以上步骤，您可以使用MapStruct进行源类型和目标类型之间的转换。请注意，MapStruct还支持更复杂的转换场景，例如集合映射和嵌套映射。您可以在MapStruct的官方文档中了解更多详细信息。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 78
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

白木Channel

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值