【开发规范】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。

相关文章

shell编程之函数与数组的使用详解

shell编程之函数与数组的使用详解

《shell编程之函数与数组的使用详解》：本文主要介绍shell编程之函数与数组的使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录shell函数函数的用法俩个数求和系统资源监控并报警函数函数变量的作用范围函数的参数递归函数shell数组获取数组的长度读取某下的
阅读更多...
使用Python开发一个带EPUB转换功能的Markdown编辑器

使用Python开发一个带EPUB转换功能的Markdown编辑器

《使用Python开发一个带EPUB转换功能的Markdown编辑器》Markdown因其简单易用和强大的格式支持,成为了写作者、开发者及内容创作者的首选格式,本文将通过Python开发一个Markd... 目录应用概览代码结构与核心组件1. 初始化与布局 (__init__)2. 工具栏 (setup_t
阅读更多...
Python虚拟环境终极(含PyCharm的使用教程)

Python虚拟环境终极(含PyCharm的使用教程)

《Python虚拟环境终极(含PyCharm的使用教程)》：本文主要介绍Python虚拟环境终极(含PyCharm的使用教程),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,... 目录一、为什么需要虚拟环境？二、虚拟环境创建方式对比三、命令行创建虚拟环境（venv）3.1 基础命令3
阅读更多...
Python Transformer 库安装配置及使用方法

Python Transformer 库安装配置及使用方法

《PythonTransformer库安装配置及使用方法》HuggingFaceTransformers是自然语言处理（NLP）领域最流行的开源库之一,支持基于Transformer架构的预训练模... 目录python 中的 Transformer 库及使用方法一、库的概述二、安装与配置三、基础使用：Pi
阅读更多...
关于pandas的read_csv方法使用解读

关于pandas的read_csv方法使用解读

《关于pandas的read_csv方法使用解读》：本文主要介绍关于pandas的read_csv方法使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录pandas的read_csv方法解读read_csv中的参数基本参数通用解析参数空值处理相关参数时间处理相关
阅读更多...
使用Node.js制作图片上传服务的详细教程

使用Node.js制作图片上传服务的详细教程

《使用Node.js制作图片上传服务的详细教程》在现代Web应用开发中,图片上传是一项常见且重要的功能,借助Node.js强大的生态系统,我们可以轻松搭建高效的图片上传服务,本文将深入探讨如何使用No... 目录准备工作搭建 Express 服务器配置 multer 进行图片上传处理图片上传请求完整代码示例
阅读更多...
SpringBoot条件注解核心作用与使用场景详解

SpringBoot条件注解核心作用与使用场景详解

《SpringBoot条件注解核心作用与使用场景详解》SpringBoot的条件注解为开发者提供了强大的动态配置能力,理解其原理和适用场景是构建灵活、可扩展应用的关键,本文将系统梳理所有常用的条件注... 目录引言一、条件注解的核心机制二、SpringBoot内置条件注解详解1、@ConditionalOn
阅读更多...
Python中使用正则表达式精准匹配IP地址的案例

Python中使用正则表达式精准匹配IP地址的案例

《Python中使用正则表达式精准匹配IP地址的案例》Python的正则表达式(re模块)是完成这个任务的利器,但你知道怎么写才能准确匹配各种合法的IP地址吗,今天我们就来详细探讨这个问题,感兴趣的朋... 目录为什么需要IP正则表达式？IP地址的基本结构基础正则表达式写法精确匹配0-255的数字验证IP地
阅读更多...
使用Python实现全能手机虚拟键盘的示例代码

使用Python实现全能手机虚拟键盘的示例代码

《使用Python实现全能手机虚拟键盘的示例代码》在数字化办公时代,你是否遇到过这样的场景：会议室投影电脑突然键盘失灵、躺在沙发上想远程控制书房电脑、或者需要给长辈远程协助操作？今天我要分享的Pyth... 目录一、项目概述：不止于键盘的远程控制方案1.1 创新价值1.2 技术栈全景二、需求实现步骤一、需求
阅读更多...
Spring LDAP目录服务的使用示例

Spring LDAP目录服务的使用示例

《SpringLDAP目录服务的使用示例》本文主要介绍了SpringLDAP目录服务的使用示例... 目录引言一、Spring LDAP基础二、LdapTemplate详解三、LDAP对象映射四、基本LDAP操作4.1 查询操作4.2 添加操作4.3 修改操作4.4 删除操作五、认证与授权六、高级特性与最佳
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2