【开发规范】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: 指定生成的实现类的名称。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/626460.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

MySQL死锁与死锁检测

MySQL死锁与死锁检测

一、什么是MySQL死锁 MySQL中死锁是指两个或多个事务在互相等待对方释放资源&#xff0c;导致无法继续执行的情况。 MySQL系统中当两个或多个事务在并发执行时&#xff0c;就可能会遇到每项事务都持有某些资源同时又请求其他事务持有的资源&#xff0c;从而形成事务之间循环等…
阅读更多...
java学习之路-多态

java学习之路-多态

文章目录 目录 文章目录 前言 1.多态 1.1 多态的概念 1.2 多态实现条件&#xff08;重点&#xff09; 多态实现的栗子 1.3重写 重写的规则 重写和重载的区别 1.4静态和动态绑定 1.5向上转型和向下转型 1.向上转型 2.向下转型 1.6多态的优点 前言 本文内容&#xff1a;多…
阅读更多...
OpenHarmony开源三方库的cmake在IDE上直接引用的问题

OpenHarmony开源三方库的cmake在IDE上直接引用的问题

前言 DevEco Studio的native工程的C/C部分当前只支持cmake脚本的编译&#xff0c;工程的目录结构如下图所示 在工程中引用第三方库有如下三种方式&#xff0c; 一、find_package模式 通过find_package&#xff0c;可以在指定目录下去搜索已安装的库&#xff08;三方库构建完后…
阅读更多...
【Linux】详解如何利用共享内存实现进程间通信

【Linux】详解如何利用共享内存实现进程间通信

一、共享内存&#xff08;Shared Memory&#xff09;的认识 共享内存&#xff08;Shared Memory&#xff09;是多进程间共享的一部分物理内存。它允许多个进程访问同一块内存空间&#xff0c;从而在不同进程之间共享和传递数据。这种方式常常用于加速进程间的通信&#xff0c;因…
阅读更多...
Linux - 线程

Linux - 线程

目录 一.Linux线程的概念 1.1什么是线程 1.2 线程的优点 1.3 线程的缺点 1.4 线程异常 1.5 线程用途 二. Linux进程VS线程 2.1 进程和线程 三. Linux线程控制 3.1 POSIX线程库 3.2 创建线程 3.3 进程ID和线程ID 3.4 线程ID及进程地址空间布局 3.5 线程终止 3.6 线…
阅读更多...
SASE：打造数据安全保障新模式

SASE：打造数据安全保障新模式

在企业纷纷拥抱数字业务的过程中&#xff0c;由于边缘计算、云服务、混合网络的逐渐兴起&#xff0c;使得本就漏洞百出的传统网络安全架构更加岌岌可危&#xff0c;而且远远无法满足企业数字业务的需要。 伴随企业全球化发展&#xff0c;企业的数据中心不再是用户与设备访问需…
阅读更多...
全球7大指纹浏览器排行榜：哪个最适合你？

全球7大指纹浏览器排行榜：哪个最适合你？

在数字时代&#xff0c;我们每一次上网都会留下独特的数字足迹&#xff0c;被称为“浏览器指纹”。为了保护这些私人信息不被滥用&#xff0c;指纹浏览器成为了一个重要工具。但是&#xff0c;并非所有的指纹浏览器都是一样的&#xff0c;它们各有特点&#xff0c;适用于不同的…
阅读更多...
【春季发布】LinkSLA智能运维V6.0发布 聚焦架构升级 新增带外管理

【春季发布】LinkSLA智能运维V6.0发布 聚焦架构升级 新增带外管理

LinkSLA智能运维为企业IT部门提供覆盖资源管理、监控告警、IT服务台、日志管理、MOC值守服务等多项功能为一体的运维平台&#xff0c;通过打通各业务单元、贯穿各技术栈&#xff0c;以故障定位和全生命周期管理为核心&#xff0c;持续保障业务连续性。 本次V6.0版本全面升级&a…
阅读更多...
最佳AI实践｜如何在 Dify 用 Workflow 构建一个 Blog SEO AI 应用？

最佳AI实践｜如何在 Dify 用 Workflow 构建一个 Blog SEO AI 应用？

最佳AI实践&#xff5c;如何在 Dify 用 Workflow 构建一个 Blog SEO AI 应用&#xff1f; 文章目录 最佳AI实践&#xff5c;如何在 Dify 用 Workflow 构建一个 Blog SEO AI 应用&#xff1f;常见的内容写作场景如何持续提升 AI 的写作能力&#xff1f;开始设计 Workflow确立 Wo…
阅读更多...
Linux系统中LVM与磁盘配额

Linux系统中LVM与磁盘配额

目录 一、LVM逻辑卷管理 二、LVM的管理命令 物理卷管理 卷组管理 逻辑卷管理 *创建并使用LVM步骤 三、磁盘配额概述 实现磁盘限额的条件 Linux 磁盘限额的特点 四、磁盘配额管理 磁盘限额 一、LVM逻辑卷管理 能够在保持现有数据不变的情况下动态调整磁盘容量&#…
阅读更多...
git 分支-变基

git 分支-变基

在git中&#xff0c;将一个分支的更改集成到另一个分支有两种主要方式&#xff1a;合并&#xff08;merge&#xff09;和变基&#xff08;rebase&#xff09;。在本节中&#xff0c;将学习什么是变基&#xff0c;如何执行变基操作&#xff0c;为什么它是一个非常强大的工具&…
阅读更多...
js脚本解决因挂VPN导致boss上高德地图无法正常规划公交路线问题

js脚本解决因挂VPN导致boss上高德地图无法正常规划公交路线问题

​ 情况说明&#xff1a; 最开始一直以为boss上的查询自己所在地点到面试地点的公交的功能有bug,总是规划路线失败&#xff0c;结果这个一调试&#xff0c;发现是自己的经纬度有问题导致的。 程序猿嘛&#xff0c;开机VPN必须是挂着的&#xff0c;这就导致了boss获取到了错误…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023