实体映射解决方案-MapStruct

2024-05-02 17:52
文章标签 解决方案 映射 mapstruct 实体

本文主要是介绍实体映射解决方案-MapStruct，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

序言

本文给大家介绍 MapStruct。

一、问题引入

在我们的日常开发过程中，我们经常会将 VO、DTO、PO …… 等对象相互进行映射。实现的方式可能有以下几种：

  1. 自己手动进行转换
  2. 利用诸如 Spring 或 Apache 提供的 BeanUtils 等工具类

如果自己手动进行转换，这将会增加开发人员的工作量。如果利用上述的这些工具类通常会存在性能问题（因为这些工具类通常使用的是反射机制）。

二、MapStruct

image.png

MapStruct 是一个用于生成类型安全的 bean 映射类的 Java 注解处理器。开发人员通过定义一个映射器接口，该接口声明任何所需的映射方法。在编译过程中，MapStruct 将生成此接口的实现。

三、快速入门

3.1 导入依赖

<dependency><groupId>org.mapstruct</groupId><artifactId>mapstruct</artifactId><version>1.5.5.Final</version>
</dependency><!--此依赖必须位于 Lombok 依赖的下面-->
<dependency><groupId>org.mapstruct</groupId><artifactId>mapstruct-processor</artifactId><version>1.5.5.Final</version>
</dependency>

3.2 定义接口

@Mapper
public interface UserMapper {// 固定写法UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);// 参数是 User 实体类，返回 UserDTOUserDTO userToUserDTO(User user);
}

3.3 使用

@Test
public void test() {User user = new User(1, "zs");// 直接调用定义好的接口方法// User 实体类转换成 UserDTOUserDTO userDTO = UserMapper.INSTANCE.userToUserDTO(user);System.out.println(userDTO);
}

测试效果：

image.png

四、映射器

在快速入门的例子中，User 和 UserDTO 的字段都是相对应的。如果需要映射字段是不相同的呢？MapperStruct 提供了映射器可以帮助我们解决这些问题。

4.1 基本映射

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {private int id;private String name;
}@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserDTO {private int id;private String username;
}

如果我们需要将 User 的 name 字段映射到 username，只需要按如下方式简单的添加一个注解就行了。

@Mapper
public interface UserMapper {UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);// 使用 @Mapping 表示映射关系@Mapping(target = "username", source = "name")UserDTO userToUserDTO(User user);
}

4.2 组合注解

为了能够让开发者更加方便的使用，MapStrut 提供了自定义组合注解的方式。

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {private int id;private String name;
}@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserDTO {private int id;private String name;private String username;
}

如果我们想要将 User 的 name 都映射到 UserDTO 的 name 和 username，我们可以采用以下的方式：

  1. 定义一个组合注解

    	@Retention(RetentionPolicy.CLASS)@Mapping(target = "username", source = "name")public @interface Composition {}

  2. 使用组合注解

    	@Mapperpublic interface UserMapper {UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);@CompositionUserDTO userToUserDTO(User user);}

    组合注解可以达到与直接使用 @Mapping 注解相同的效果：

    image.png

五、映射方法

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {private int id;private String name;
}@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserDTO {private int id;private String name;private int nameLen;
}

在开发的过程中，有时映射逻辑可能比较复杂。MapStruct 提供的注解映射器可能无法满足。例如：我们需要在映射时将上面 name 的长度映射到 nameLen。
MapStruct 可以使用接口默认方法解决特殊的映射需求。

@Mapper
public interface UserMapper {UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);default UserDTO userToUserDTO(User user) {UserDTO userDTO = new UserDTO();userDTO.setId(user.getId());userDTO.setName(user.getName());userDTO.setNameLen(user.getName().length());return userDTO;}
}

测试效果：

image.png

六、装饰器类

上面的映射方法其实就是手动实现映射关系。但是，开发人员可能只想修改几个特殊的字段映射，这时可以利用装饰器类来处理映射。

@Mapper
// 使用装饰器
@DecoratedWith(UserMapperDecorator.class)
public interface UserMapper {UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);UserDTO userToUserDTO(User user);}// 装饰器类
public abstract class UserMapperDecorator implements UserMapper {private final UserMapper delegate;public UserMapperDecorator(UserMapper delegate) {this.delegate = delegate;}@Overridepublic UserDTO userToUserDTO(User user) {UserDTO userDTO = delegate.userToUserDTO(user);// 特殊处理 nameLen 字段映射userDTO.setNameLen(user.getName().length());return userDTO;}
}

七、依赖注入

现在，我们项目的开发一般都是采用的 Spring。MapStruct 提供了更加适合 Spring 的依赖注入方式。

// componentModel 指定使用 Spring 模式
@Mapper(componentModel = MappingConstants.ComponentModel.SPRING)
@DecoratedWith(UserMapperDecorator.class)
public interface UserMapper {UserDTO userToUserDTO(User user);
}public abstract class UserMapperDecorator implements UserMapper {// 装饰器中采用注解获取@Resourceprivate UserMapper delegate;@Overridepublic UserDTO userToUserDTO(User user) {UserDTO userDTO = delegate.userToUserDTO(user);userDTO.setNameLen(user.getName().length());return userDTO;}
}

使用方式：

// 使用注解注入
@Resource
private UserMapper userMapper;@Test
public void test() {User user = new User(1, "zs");UserDTO userDTO = userMapper.userToUserDTO(user);System.out.println(userDTO);
}

八、类型转换

在实体类映射的过程中，我们经常会遇到如下的问题：

@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserDTO {private int id;private String name;// 在 dto 中 status 字段是 boolean 类型private boolean status;
}@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserPO {private int id;private String name;// 在 po 中 status 字段是 status 类型private Integer status;
}

如果需要类型转换，可以通过以下方式处理：

// 新增一个类型映射
// 如果使用了 Spring 模式，则需要注入
@Component
public class IntBooleanMapper {public boolean intToBoolean(int value) {return value == 1;}public int booleanToInt(boolean value) {return value ? 1 : 0;}
}// 使用 uses 指定
@Mapper(componentModel = MappingConstants.ComponentModel.SPRING,uses = {IntBooleanMapper.class})
@DecoratedWith(UserMapperDecorator.class)
public interface UserMapper {UserDTO userToUserDTO(User user);UserDTO UserPOToUserDTO(UserPO userPO);}

测试类型转换：

@Resource
private UserMapper userMapper;@Test
public void test() {UserPO userPO = new UserPO(1, "ZS", 1);UserDTO userDTO = userMapper.UserPOToUserDTO(userPO);System.out.println(userDTO);
}

测试效果：

image.png

九、默认值

在 MapStruct 中，还可以指定映射的默认值。

@Mapper(componentModel = MappingConstants.ComponentModel.SPRING)
public interface UserMapper {// 使用 defaultValue 定义默认值为 default// 如果 User 的 name 为 null，那么 UserDTO 的 name 值则为 default@Mapping(target = "name", defaultValue = "default")UserDTO userToUserDTO(User user);}

十、FAQ

  1. MapStruct 依赖与 Lombok 依赖可能存在冲突的情况，在引入 MapStruct 相关依赖时要严格安装本文提供的顺序引入。
  2. MapStruct 的原理是通过定义的接口，自动帮助开发人员生成映射代码。所以当修改了接口中内容，若没有立即生效则可能需要使用 mvn clean 或 mvn compile 等命令清理一下自动生成的旧版本代码。

往期推荐

  1. 动态切换数据源的最佳实践
  2. Gateway
  3. 缓存神器-JetCache
  4. Mybatis 缓存机制
  5. 为什么 MySQL 单表数据量最好别超过 2000w
  6. IoC 思想简单而深邃
  7. ThreadLocal

这篇关于实体映射解决方案-MapStruct的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/954828。

相关文章

js异步提交form表单的解决方案

js异步提交form表单的解决方案

1.定义异步提交表单的方法 （通用方法） /*** 异步提交form表单* @param options {form:form表单元素,success:执行成功后处理函数}* <span style="color:#ff0000;"><strong>@注意 后台接收参数要解码否则中文会导致乱码 如：URLDecoder.decode(param,"UTF-8")</strong></span>
阅读更多...
明明的随机数处理问题分析与解决方案

明明的随机数处理问题分析与解决方案

明明的随机数处理问题分析与解决方案 引言问题描述解决方案数据结构设计具体步骤伪代码C语言实现详细解释读取输入去重操作排序操作输出结果复杂度分析 引言 明明生成了N个1到500之间的随机整数，我们需要对这些整数进行处理，删去重复的数字，然后进行排序并输出结果。本文将详细讲解如何通过算法、数据结构以及C语言来解决这个问题。我们将会使用数组和哈希表来实现去重操作，再利用排序算法对结果
阅读更多...
UE5 半透明阴影 快速解决方案

UE5 半透明阴影 快速解决方案

Step 1： 打开该选项 Step 2： 将半透明材质给到模型后，设置光照的Shadow Resolution Scale，越大，阴影的效果越好
阅读更多...
MySQL主从同步延迟原理及解决方案

MySQL主从同步延迟原理及解决方案

概述 MySQL的主从同步是一个很成熟的架构，优点为： ①在从服务器可以执行查询工作(即我们常说的读功能)，降低主服务器压力; ②在从主服务器进行备份，避免备份期间影响主服务器服务; ③当主服务器出现问题时，可以切换到从服务器。 相信大家对于这些好处已经非常了解了，在项目的部署中也采用这种方案。但是MySQL的主从同步一直有从库延迟的问题，那么为什么会有这种问题。这种问题如何解决呢？ MyS
阅读更多...
安装SQL2005后SQL Server Management Studio 没有出来的解决方案

安装SQL2005后SQL Server Management Studio 没有出来的解决方案

一种情况，在安装 sqlServer2005 时 居然出现两个警告： 1 Com+ 目录要求 2 Edition change check 郁闷！网上说出现两个警告，是肯定装不成功的！我抱着侥幸的态度试了下，成功了。 安装成功后，正准备 “ 仅工具、联机丛书和示例(T)” 但是安装不了，他提示我“工作站组件”安装过了对现有组件无法更新或升级。 解决办法： 1 打开“控
阅读更多...
AI和新基建赋能智慧工地超融合管理平台解决方案

AI和新基建赋能智慧工地超融合管理平台解决方案

1. 项目背景与需求 电力行业的工程管理正朝着智慧化发展，但目前仍处于起步阶段。为满足数字化、网络化、智能化的发展需求，需要构建一个高效综合监控平台，实现对电力项目全过程的精益化管控。 2. 综合管理平台的构建 该平台集成了超融合实景监控、安全智能监测、公共安全防范、技术管理、人员管控和绿色施工等多个方面，通过BIM协同优化设计，提升项目质量和进度管理。 3. 安全智能监测的重要性 安全
阅读更多...
【解决方案】软件大屏实现整体技术解决方案

【解决方案】软件大屏实现整体技术解决方案

1.系统概述 1.1.需求分析 1.2.重难点分析 1.3.重难点解决措施 2.系统架构设计 2.1.系统架构图 2.2.关键技术 2.3.接口及要求 3.系统功能设计 3.1.功能清单列表 3.2.数据源管理 3.3.数据集管理 3.4.视图管理 3.5.仪表盘管理 3.6.移动端设计 3.1.系统权限设计 3.2.数据查询过程设计 软件全套资料部分文档清单： 工作安排任务书，可行性分
阅读更多...
基于Hypervisor智能驾舱的AUTOSAR解决方案

基于Hypervisor智能驾舱的AUTOSAR解决方案

MENTOR嵌入式管理程序 目前，通常使用两种类型的管理程序（图6）： Type 1本机管理程序：一种在硬件上本机运行的管理程序，因为它充当核心中的操作系统。Type 2托管虚拟机监控程序：此类型的虚拟机监控程序必须由另一个操作系统托管，并且仅负责使用主机操作系统可用的资源来虚拟化客户操作系统。 图6：虚拟机管理程序 虚拟化的工作原理是从硬件上运行的应用程序中抽象出物理硬件和设备。虚拟化流程管理
阅读更多...
BERN2（生物医学领域）命名实体识别与命名规范化工具

BERN2（生物医学领域）命名实体识别与命名规范化工具

BERN2: an advanced neural biomedical named entity recognition and normalization tool 《Bioinformatics》2022 1 摘要 NER和NEN：在生物医学自然语言处理中，NER和NEN是关键任务，它们使得从生物医学文献中自动提取实体（如疾病和药物）成为可能。 BERN2：BERN2是一个工具，
阅读更多...
关于iReport5.6.0无法正常启动或者闪退或者JDK8不兼容的解决方案

关于iReport5.6.0无法正常启动或者闪退或者JDK8不兼容的解决方案

我下载了iReport5.6.0 版本的，启动不起来；jdk 1.8 下载iReport5.6.0地址：https://download.csdn.net/download/u013456370/10589765 参考链接：https://blog.csdn.net/erlian1992/article/details/76359191?locationNum=6&fps=1 如果是停留在这
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2