【开发规范】Mapstruct 转换器使用教程

2024-04-17 19:36
文章标签 使用 教程 开发 mapstruct 规范 转换器

本文主要是介绍【开发规范】Mapstruct 转换器使用教程，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

【开发规范】Mapstruct 转换器使用教程

  • 一、对象转化
  • 二、推荐使用 MapStruct
  • 三、MapStruct 介绍
    • 3.1 概念
    • 3.2 特点
    • 3.3 使用场景
    • 3.4 使用教程
      • 3.4.1 导入依赖
      • 3.4.2 编写 Entity 和 DetailInfo
      • 3.4.3 编写转换器（※）
      • 3.4.4 使用转换器
      • 3.4.5 结果
      • 3.4.6 扩展（MapStruct 其他常用参数）

在这里插入图片描述

一、对象转化

在业务应用中，我们的代码结构往往是多层次的，不同层次之间经常涉及到对象的转化，虽然很简单，但实际上繁琐且容易出错。

  • 反例 1（手动编写方法进行 set）：
public class UserConverter {public static UserDTO toDTO(UserDO userDO) {UserDTO userDTO = new UserDTO();userDTO.setAge(userDO.getAge());// 问题 1: 自己赋值给自己userDTO.setName(userDTO.getName());return userDTO;}@Datapublic static class UserDO {private String name;private Integer age;// 问题 2: 新增字段未赋值private String address;}@Datapublic static class UserDTO {private String name;private Integer age;}
}
  • 反例2（使用copyProperties）：
public class UserBeanCopyConvert {public UserDTO toDTO(UserDO userDO) {UserDTO userDTO = new UserDTO();// 用反射复制不同类型对象.// 1. 重构不友好, 当我要删除或修改 UserDO 的字段时, 无法得知该字段是否通过反射被其他字段依赖BeanUtils.copyProperties(userDO, userDTO);return userDTO;}
}

二、推荐使用 MapStruct

Mapstruct 使用编译期代码生成技术，根据注解、入参、出参自动生成转化代码，并且支持各种高级特性，比如：

  1. 未映射字段的处理策略，在编译期发现映射问题；
  2. 复用工具，方便字段类型转化；
  3. 生成 Spring Component 注解，通过 spring 管理；
  4. 等等其他特性；
// 注意此处的 Mapper 是 org.mapstruct.Mapper 包下的
@Mapper(componentModel = "spring",unmappedSourcePolicy = ReportingPolicy.ERROR,unmappedTargetPolicy = ReportingPolicy.ERROR,// convert 逻辑依赖 DateUtil 做日期转化uses = DateUtil.class
)
public interface UserConvertor {UserDTO toUserDTO(UserDO userDO);@Dataclass UserDO {private String name;private Integer age;//private String address;private Date birthDay;}@Dataclass UserDTO {private String name;private Integer age;private String birthDay;}}public class DateUtil {public static String format(Date date) {SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd");return simpleDateFormat.format(date);}
}

使用示例：

@RequiredArgsConstructor
@Component
public class UserService {private final UserDao userDao;private final UserCovertor userCovertor;public UserDTO getUser(String userId){UserDO userDO = userDao.getById(userId);return userCovertor.toUserDTO(userDO);}
}

编译期校验：

生成的代码：

@Generated(value = "org.mapstruct.ap.MappingProcessor",date = "2023-12-18T20:17:00+0800",comments = "version: 1.3.1.Final, compiler: javac, environment: Java 11.0.12 (GraalVM Community)"
)
@Component
public class UserConvertorImpl implements UserConvertor {@Overridepublic UserDTO toUserDTO(UserDO userDO) {if ( userDO == null ) {return null;}UserDTO userDTO = new UserDTO();userDTO.setName( userDO.getName() );userDTO.setAge( userDO.getAge() );userDTO.setBirthDay( DateUtil.format( userDO.getBirthDay() ) );return userDTO;}
}

三、MapStruct 介绍

3.1 概念

MapStruct 是一个代码生成器，它基于约定优于配置的方法，极大地简化了 Java bean 类型之间的映射实现。
生成的映射代码使用普通的方法调用，因此速度快、类型安全且易于理解。
MapStruct 是一种注释处理器，可插入 Java 编译器，并可用于命令行构建（Maven、Gradle 等）以及您喜欢的集成开发环境。

MapStruct 使用合理的默认设置，但在需要配置或实施特殊行为时，MapStruct 会自动退出。

3.2 特点

  1. 配置灵活：MapStruct支持通过配置文件或注解来定义映射规则。开发人员可以根据具体需求选择更适合的配置方式。
  2. 集成简单：MapStruct可以与Spring、CDI等常用的Java框架无缝集成。它与其他框架的兼容性良好，使用起来非常方便。
  3. 性能优越：MapStruct通过在编译时生成映射代码，避免了运行时的反射操作，从而提升了映射的性能。它生成的映射代码非常高效，可以满足大部分应用场景的性能需求。

3.3 使用场景

  1. 数据库中的字段和对接的A部门、B部门的入参字段不一致的情况。
  2. 涉及到一些入参和出参值的转换，比如：性别、日期等。

3.4 使用教程

3.4.1 导入依赖

<!--mapStruct依赖-->
<dependency><groupId>org.mapstruct</groupId><artifactId>mapstruct</artifactId><version>1.4.2.Final</version>
</dependency>
<dependency><groupId>org.mapstruct</groupId><artifactId>mapstruct-processor</artifactId><version>1.4.2.Final</version><scope>provided</scope>
</dependency>

3.4.2 编写 Entity 和 DetailInfo

我这块的 Entity 相当于是 DO，DetailInfo 相当于是（DTO）

import com.alibaba.fastjson.JSONObject;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import com.baomidou.mybatisplus.core.handlers.MybatisEnumTypeHandler;
import com.haoma.webpgsqldemo.enums.GenderEnum;
import com.haoma.webpgsqldemo.typehandler.JSONObjectTypeHandler;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;import java.time.LocalDate;
import java.time.LocalDateTime;
import java.util.Date;/*** @author Zoom* @Date 2024/4/17* @Description 用户详细信息实体类* @Version 1.0*/
@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName(value="test_user", autoResultMap = true)
public class TestUserEntity {@TableId(value = "id", type = IdType.AUTO)private Integer id;private String name;private Integer age;// 枚举类型@TableField(value = "gender", typeHandler = MybatisEnumTypeHandler.class)private GenderEnum gender;@TableField(value = "address", typeHandler = JSONObjectTypeHandler.class)private JSONObject address;private String phone;private LocalDate createTime;}
import com.alibaba.fastjson.JSONObject;
import com.haoma.webpgsqldemo.enums.GenderEnum;
import lombok.Data;import java.util.Date;/*** @Author Zoom* @Date 2024/4/17* @Description 用户详细信息实体类* @Version 1.0*/
@Data
public class TestUserDetailInfo {private Integer id;private String name;private Integer age;private GenderEnum gender;private JSONObject address;private String phone;private String createTime;}

3.4.3 编写转换器（※）

现在需要实现 Entity 转换成 DetailInfo，我们来编写一个 Convertor

import com.haoma.webpgsqldemo.entity.TestUserDetailInfo;
import com.haoma.webpgsqldemo.entity.TestUserEntity;
import com.haoma.webpgsqldemo.utils.DateUtil;
import org.mapstruct.Mapper;
import org.mapstruct.ReportingPolicy;/*** @Author Zoom* @Date 2024/4/17* @Description 用户转换器* @Version 1.0*/
@Mapper(componentModel = "spring",unmappedSourcePolicy = ReportingPolicy.ERROR,unmappedTargetPolicy = ReportingPolicy.ERROR,uses = DateUtil.class
)
public interface TestUserConvertor {TestUserDetailInfo toUserDetailInfo(TestUserEntity userEntity);}

参数解释：

  • componentModel = "spring"：使用 spring 作为组件模型，这意味着 MapStruct 将会生成一个由 Spring 容器管理的实现类。
  • unmappedSourcePolicy：设置了为映射源属性的策略，这里设为ERROR表示如果有为映射属性则会报错。
  • unmappedTargetPolicy：设置了未映射目标属性的策略，这里设为ERROR表示如果有为映射属性则会报错。
  • uses = DateUtil.class：声明了在转换过程中使用的辅助类 DateUtil，进行日期格式化处理。
import java.text.SimpleDateFormat;
import java.time.LocalDate;/*** @Author Zoom* @Date 2024/4/17* @Description 日期工具类* @Version 1.0*/
public class DateUtil {public static String format(LocalDate localDate){SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");return simpleDateFormat.format(localDate);}}

3.4.4 使用转换器

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.haoma.webpgsqldemo.convertor.TestUserConvertor;
import com.haoma.webpgsqldemo.entity.TestUserDetailInfo;
import com.haoma.webpgsqldemo.entity.TestUserEntity;
import com.haoma.webpgsqldemo.mapper.TestUserMapper;
import com.haoma.webpgsqldemo.service.TestUserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;/*** @Author Zoom* @Date 2024/4/17* @Description 用户服务实现类* @Version 1.0*/
@Service
public class TestUserServiceImpl extends ServiceImpl<TestUserMapper, TestUserEntity> implements TestUserService {@Autowiredprivate TestUserConvertor testUserConvertor;@Overridepublic TestUserDetailInfo getUserDetailInfo(TestUserEntity entity) {LambdaQueryWrapper<TestUserEntity> queryWrapper = new QueryWrapper<TestUserEntity>().lambda();queryWrapper.eq(TestUserEntity::getId, entity.getId());if(entity.getGender()!= null){queryWrapper.eq(TestUserEntity::getGender, entity.getGender());}TestUserEntity userEntity = getOne(queryWrapper);// 将 UserEntity 转换成 UserDetailInforeturn testUserConvertor.toUserDetailInfo(userEntity);}}

3.4.5 结果

调用接口测试：
image.png

3.4.6 扩展（MapStruct 其他常用参数）

  1. componentModel：指映射器的组件模型，常用的取值有：
    1. default：使用默认的组件模型，在编译时生成的 Mapper 实现类是独立的，不依赖于任何外部框架。
    2. spring：使用 Spring 作为组件模型，生成的 Mapper 实现类会被 Spring 容器管理。
    3. cdi：使用 CDI（Contexts and Dependency Injection）作为组件模型。
    4. jsr330：使用 JSR-330 标准实现的组件模型。
  2. uses：指定在转换过程中使用的工具类。
  3. unmappedSourcePolicy：未映射源属性的策略，可选值包括：
    1. IGNORE：忽略未映射源属性。
    2. WARN：警告为映射源属性。
    3. ERROR：报错，未映射源属性会触发编译错误。
  4. unmappedTargetPolicy: 未映射目标属性的策略，可选值和含义和unmappedSourcePolicy类似。
  5. mapping: 可以通过@Mapping注解进行自定义映射，包括属性名映射、表达式映射等。
  6. implementationName: 指定生成的实现类的名称。

这篇关于【开发规范】Mapstruct 转换器使用教程的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


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

相关文章

Java中流式并行操作parallelStream的原理和使用方法

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流（parallelStream）的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS
阅读更多...
Linux join命令的使用及说明

Linux join命令的使用及说明

《Linuxjoin命令的使用及说明》`join`命令用于在Linux中按字段将两个文件进行连接,类似于SQL的JOIN,它需要两个文件按用于匹配的字段排序,并且第一个文件的换行符必须是LF,`jo... 目录一. 基本语法二. 数据准备三. 指定文件的连接key四.-a输出指定文件的所有行五.-o指定输出
阅读更多...
Linux jq命令的使用解读

Linux jq命令的使用解读

《Linuxjq命令的使用解读》jq是一个强大的命令行工具,用于处理JSON数据,它可以用来查看、过滤、修改、格式化JSON数据,通过使用各种选项和过滤器,可以实现复杂的JSON处理任务... 目录一. 简介二. 选项2.1.2.2-c2.3-r2.4-R三. 字段提取3.1 普通字段3.2 数组字段四.
阅读更多...
Linux kill正在执行的后台任务 kill进程组使用详解

Linux kill正在执行的后台任务 kill进程组使用详解

《Linuxkill正在执行的后台任务kill进程组使用详解》文章介绍了两个脚本的功能和区别,以及执行这些脚本时遇到的进程管理问题,通过查看进程树、使用`kill`命令和`lsof`命令,分析了子... 目录零. 用到的命令一. 待执行的脚本二. 执行含子进程的脚本，并kill2.1 进程查看2.2 遇到的
阅读更多...
详解SpringBoot+Ehcache使用示例

详解SpringBoot+Ehcache使用示例

《详解SpringBoot+Ehcache使用示例》本文介绍了SpringBoot中配置Ehcache、自定义get/set方式,并实际使用缓存的过程,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录摘要概念内存与磁盘持久化存储：配置灵活性：编码示例引入依赖：配置ehcache.XML文件：配置
阅读更多...
Java 虚拟线程的创建与使用深度解析

Java 虚拟线程的创建与使用深度解析

《Java虚拟线程的创建与使用深度解析》虚拟线程是Java19中以预览特性形式引入,Java21起正式发布的轻量级线程,本文给大家介绍Java虚拟线程的创建与使用,感兴趣的朋友一起看看吧... 目录一、虚拟线程简介1.1 什么是虚拟线程？1.2 为什么需要虚拟线程？二、虚拟线程与平台线程对比代码对比示例：三
阅读更多...
k8s按需创建PV和使用PVC详解

k8s按需创建PV和使用PVC详解

《k8s按需创建PV和使用PVC详解》Kubernetes中,PV和PVC用于管理持久存储,StorageClass实现动态PV分配,PVC声明存储需求并绑定PV,通过kubectl验证状态,注意回收... 目录1.按需创建 PV（使用 StorageClass）创建 StorageClass2.创建 PV
阅读更多...
一文详解Python如何开发游戏

一文详解Python如何开发游戏

《一文详解Python如何开发游戏》Python是一种非常流行的编程语言,也可以用来开发游戏模组,：本文主要介绍Python如何开发游戏的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、python简介二、Python 开发 2D 游戏的优劣势优势缺点三、Python 开发 3D
阅读更多...
Redis 基本数据类型和使用详解

Redis 基本数据类型和使用详解

《Redis基本数据类型和使用详解》String是Redis最基本的数据类型,一个键对应一个值,它的功能十分强大,可以存储字符串、整数、浮点数等多种数据格式,本文给大家介绍Redis基本数据类型和... 目录一、Redis 入门介绍二、Redis 的五大基本数据类型2.1 String 类型2.2 Hash
阅读更多...
Redis中Hash从使用过程到原理说明

Redis中Hash从使用过程到原理说明

《Redis中Hash从使用过程到原理说明》RedisHash结构用于存储字段-值对,适合对象数据,支持HSET、HGET等命令,采用ziplist或hashtable编码,通过渐进式rehash优化... 目录一、开篇：Hash就像超市的货架二、Hash的基本使用1. 常用命令示例2. Java操作示例三
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2