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

相关文章

C++中detach的作用、使用场景及注意事项

C++中detach的作用、使用场景及注意事项

《C++中detach的作用、使用场景及注意事项》关于C++中的detach,它主要涉及多线程编程中的线程管理,理解detach的作用、使用场景以及注意事项,对于写出高效、安全的多线程程序至关重要,下... 目录一、什么是join()？它的作用是什么？类比一下：二、join()的作用总结三、join()怎么
阅读更多...
mybatis中resultMap的association及collectio的使用详解

mybatis中resultMap的association及collectio的使用详解

《mybatis中resultMap的association及collectio的使用详解》MyBatis的resultMap定义数据库结果到Java对象的映射规则,包含id、type等属性,子元素需... 目录1.reusltmap的说明2.association的使用3.collection的使用4.总
阅读更多...
Go语言编译环境设置教程

Go语言编译环境设置教程

《Go语言编译环境设置教程》Go语言支持高并发（goroutine）、自动垃圾回收,编译为跨平台二进制文件,云原生兼容且社区活跃,开发便捷,内置测试与vet工具辅助检测错误,依赖模块化管理,提升开发效... 目录Go语言优势下载 Go  配置编译环境配置 GOPROXYIDE 设置（VS Code）一些基本
阅读更多...
Spring Boot配置和使用两个数据源的实现步骤

Spring Boot配置和使用两个数据源的实现步骤

《SpringBoot配置和使用两个数据源的实现步骤》本文详解SpringBoot配置双数据源方法,包含配置文件设置、Bean创建、事务管理器配置及@Qualifier注解使用,强调主数据源标记、代... 目录Spring Boot配置和使用两个数据源技术背景实现步骤1. 配置数据源信息2. 创建数据源Be
阅读更多...
Java中使用 @Builder 注解的简单示例

Java中使用 @Builder 注解的简单示例

《Java中使用@Builder注解的简单示例》@Builder简化构建但存在复杂性,需配合其他注解,导致可变性、抽象类型处理难题,链式编程非最佳实践,适合长期对象,避免与@Data混用,改用@G... 目录一、案例二、不足之处大多数同学使用 @Builder 无非就是为了链式编程，然而 @Builder
阅读更多...
在MySQL中实现冷热数据分离的方法及使用场景底层原理解析

在MySQL中实现冷热数据分离的方法及使用场景底层原理解析

《在MySQL中实现冷热数据分离的方法及使用场景底层原理解析》MySQL冷热数据分离通过分表/分区策略、数据归档和索引优化,将频繁访问的热数据与冷数据分开存储,提升查询效率并降低存储成本,适用于高并发... 目录实现冷热数据分离1. 分表策略2. 使用分区表3. 数据归档与迁移在mysql中实现冷热数据分
阅读更多...
mybatis-plus QueryWrapper中or,and的使用及说明

mybatis-plus QueryWrapper中or,and的使用及说明

《mybatis-plusQueryWrapper中or,and的使用及说明》使用MyBatisPlusQueryWrapper时,因同时添加角色权限固定条件和多字段模糊查询导致数据异常展示,排查发... 目录QueryWrapper中or,and使用列表中还要同时模糊查询多个字段经过排查这就导致只要whe
阅读更多...
Python使用openpyxl读取Excel的操作详解

Python使用openpyxl读取Excel的操作详解

《Python使用openpyxl读取Excel的操作详解》本文介绍了使用Python的openpyxl库进行Excel文件的创建、读写、数据操作、工作簿与工作表管理,包括创建工作簿、加载工作簿、操作... 目录1 概述1.1 图示1.2 安装第三方库2 工作簿 workbook2.1 创建：Workboo
阅读更多...
使用Go实现文件复制的完整流程

使用Go实现文件复制的完整流程

《使用Go实现文件复制的完整流程》本案例将实现一个实用的文件操作工具：将一个文件的内容完整复制到另一个文件中,这是文件处理中的常见任务,比如配置文件备份、日志迁移、用户上传文件转存等,文中通过代码示例... 目录案例说明涉及China编程知识点示例代码代码解析示例运行练习扩展小结案例说明我们将通过标准库 os
阅读更多...
postgresql使用UUID函数的方法

postgresql使用UUID函数的方法

《postgresql使用UUID函数的方法》本文给大家介绍postgresql使用UUID函数的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录PostgreSQL有两种生成uuid的方法。可以先通过sql查看是否已安装扩展函数，和可以安装的扩展函数
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2