使用MapStruct实现Java对象映射的示例代码

2025-09-25 12:50

本文主要是介绍使用MapStruct实现Java对象映射的示例代码,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《使用MapStruct实现Java对象映射的示例代码》本文主要介绍了使用MapStruct实现Java对象映射的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,...

在分层架构的开发中,经常遇到以下场景:将 DAO 查询出的 Entity 对象,转换为返回给前端的 VO 对象;或者将前端传来的 DTO 对象,转换为要存入数据库的 Entity 对象。

每当两个对象的字段很多时,用get和set的方法完成“数据搬运”的过程就比较麻烦,接下来介绍一下使用MapStruct的方法。

一、什么是 MapStruct?

MapStruct 是一个 Java 注解处理器,用于在编译时自动生成类型安全、高性能的对象映射代码。 请注意这里的几个关键词:

编译时生成代码:它不是像 `BeanUtils.copyProperties` 那样在运行时使用反射,所以性能极高,与你手写的 `get/set` 代码完全一样。

类型安全:它在编译期间就会对字段类型进行检查。如果源对象和目标对象的字段类型不兼容,编译会直接报错,让你能尽早发现问题。

注解驱动:你只需要定义一个简单的 Java 接口并添加注解,MapStruct 就会在幕后为你完成所有繁重的工作。

二、实战演练:三步集成 MapStruct

让我们通过一个将 `DataProductItemDto` (DTO) 转换为 `DataProduct` (Entity) 的实例,来看看 MapStruct 的使用方法。

第一步:添加 Maven 依赖 (`pom.xml`)

这是整个集成的基础。需要告诉 Maven 项目要使用 MapStruct,并配置好编译器。

<!-- 1. 在 <properties> 中统一定义版本号 -->
<properties>
    <org.mapstruct.version>1.5.5.Final</org.mapstruct.version>
    <lombok.version>1.18.30</lombok.version>
    <lombok-mapstruct-binding.version>0.2.0</lombok-mapstruct-binding.version>
</properties>
 
<!-- 2. 在 <dependencies> 中添加核心库 -->
<dependencies>
    <!-- MapStruct 核心库 -->
    <dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>${org.mapstruct.version}</version>
    </dependency>
 
    <!-- (如果使用Lombok) 这是让 MapStruct 和 Lombok 和谐共处的关键 -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok-mapstruct-binding</artifactId>
        <version>${lombok-mapstruct-binding.version}</version>
    </dependency>
</dependencies>
 
<!-- 3. 在 <build><plugins> 中配置注解处理器 (最关键的部分) -->
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <source>1.8</source> <!-- 或你的 Java 版本 -->
                <target>1.8</target> <!-- 或你的 Java 版本 -->
                <annotationProcessorPaths>
                    <!-- 必须确保 Lombok 在 MapStruct 之前执行 -->
                    <path>
                        <groupId>org.projectlombok</groupId>
                        <artifactId>lombok</artif编程actId>
                        <version>${lombok.version}</version>
                    </path>
                    <path>
                        <groupId>org.mapstruct</groupId>
                        <artifactId>mapstruct-processor</artifactId>
                        <version>${org.mapstruct.version}</version>
                    </path>
                    <path>
                        <groupId>org.projectlombok</groupId>
                        <artifactId>lomboChina编程k-mapstruct-binding</artifactId>
                        <version>${lombok-mapstruct-binding.version}</version>
                    </path>
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>

配置要点:annotationProcessorPaths 里的顺序非常重要,确保了 Lombok 先为你的类生成 getter/setter,然后 MapStruct 才能找到并使用它们。

修改完 pom.xml 后,务必重新构建你的 Maven 项目

第二步:创建 Mapper 接口

现在需要定义“翻译规则”。你只需要创建一个接口,剩下的交给 MapStruct。

package com.cmgii.trust.third.dtcp.converter;// 建议放在专门的 converter 包下

import com.cmgii.trust.third.dtcp.domain.DataProduct;
import com.cmgii.trust.third.dtcp.domain.vo.respVO.DataProductItemDto;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.factory.Mappers;

import java.util.List;

@Mapper
public interface DataProductConverter {

    //提供一个全局唯一的翻译官实例
    DataProductConverter INSTANCE = Mappers.http://www.chinasem.cngetMapper(DataProductConverter.class);

    /**
     * 将单个 DTO 转换为实体。
     * MapStruct 会自动映射所有同名、同类型的字段。
     * 我们只需为有特殊转换需求的字段(如日期格式)添加规则。
     * @param dto 源 DTO 对象
     * @return 转换后的实体对象
     */
    @Mapping(source = "listTime", target = "listTime", dateFormat = "yyyy-MM-dd'T'HH:mm:ss")
    DataProduct toDataProduct(DataProductItemDto dto);

    /**
     * 将 DTO 列表转换为实体列表。
     * MapStruct 会自动复用上面的 toEntity 方法来处理列表中的每一个元素。
     *
     * @param dtoList 源 DTO 列表
     * @return 转换后的实体列表
     */
    List<DataProduct> toDataProductList(List<DataProductItemDto> dtoList);
} 

1. @Mapper 注解

  • 作用:这是 MapStruct 的核心注解。它告诉 MapStruct 的代码生成器:“嘿,这个接口不是一个普通的接口,它是一份映射规则的蓝图。请在编译时,为我自动生成一个实现了这个接口的 ...Impl 类。

2. DataProductConverter INSTANCE = ... (单例模式)

  • 作用:这是获取 Mapper 实例的经典方式(当不使用 Spring 注入时)。
  • Mappers.getMapper(...): 这是 MapStruct 提供的一个工厂方法,它会找到并返回 MapStruct 在编译时为您自动生成的那个 DataProductConverterImpl 类的单例实例
  • 用法:在应用的任何地方,都可以通过 DataProductConverter.INSTANCE 来获取到这个唯一的、线程安全的“翻译官”,然后调用他的翻译方法。

3. toDataProduct(DataProductItemDto dto) - 单个对象映射

  • 作用:定义了如何将一个 DataProductItemDto 对象,转换成一个 DataProduct 对象。
  • MapStruct 的智能自动化:DataProductItemDto 和 DataProduct 这两个类有大量同名、同类型的字段。MapStruct 会自动识别并映射这些字段,无需为它们编写任何 @Mapping 注解。
  • @Mapping(...) - 特殊规则定制:
    • source = "listTime", target = "listTime": source 指源对象(DTO)的属性,target 指目标对象(Domain)的属性。这里两者同名。
    • dateFormat = "yyyy-MM-dd'T'HH:mm:ss"这是最关键的定制规则。它告诉 MapStruct:“当你在转换 listTime 这个字段时,请注意,源对象里的 listTime 是一个字符串,而目标对象里的是一个 Date。请你使用 "yyyy-MM-dd'T'HH:mm:ss" 这个格式,将字符串解析成 Date 对象。”
    • 这完美地解决了日期格式解析问题,而且是以一种非常声明式、非常优雅的方式。

4. toDataProductList(List<DataProductItemDto> dtoList) - 集合映射

  • 作用:定义了如何将一个 DataProductItemDto 的列表,转换成一个 DataProduct 的列表
  • Mhttp://www.chinasem.cnapStruct 的进一步智能:MapStruct 足够智能,当它看到这个方法时,它会发现:“哦,我知道如何转换单个 DataProductItemDto(通过 toDataProduct 方法),那转换一个列表,我只需要对列表里的每个元素都调用一次 toDataProduct 方法就行了。”
  • 因此,不需要为这个方法编写任何额外的 @Mapping 注解。MapStruct 会自动生成一个循环遍历并逐个转换的实现。

第三步:在 Service 中使用 Mapper

可以在业务逻辑中,用一行代码替代原来繁琐的转换过程。

@Override
    @Transactional
    public void syncDataProducts() {
        // 1. 从第三方获取所有数据产品
        List<DataProductItemDto> remoteProductsDto = cmccDtcpThirdService.selectAllDataProductList();

        // 2. 将DTO转换为实体
        List<DataProduct> dataProducts = DataProductConverter.INSTANCE.toDataProductList(remoteProductsDto);

        // 3. 批量存入数据库
        if (dataProducts != null && !dataProducts.isEmpty()) {
            dataProductMapper.BATchInsertOrUpdate(dataProducts);
        }
    }

三、总结:为什么选择 MapStruct?

特性手动 get/setBeanUtils.copyPropertiesMapStruct
性能极高较低 (运行时反射)极高 (编译时生成)
类型安全编译时运行时 (可能沉默失败)编译时 (推荐)
代码简洁度极好
可维护性编程China编程极好

到此这篇关于使用MapStruct实现Java对象映射的文章就介绍到这了,更多相关MapStruct 实现 Java 对象映射内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持China编程(www.chinasem.cn)!

这篇关于使用MapStruct实现Java对象映射的示例代码的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1156021

相关文章

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

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流(parallelStream)的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS

C++中unordered_set哈希集合的实现

《C++中unordered_set哈希集合的实现》std::unordered_set是C++标准库中的无序关联容器,基于哈希表实现,具有元素唯一性和无序性特点,本文就来详细的介绍一下unorder... 目录一、概述二、头文件与命名空间三、常用方法与示例1. 构造与析构2. 迭代器与遍历3. 容量相关4

Linux join命令的使用及说明

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

Java中Redisson 的原理深度解析

《Java中Redisson的原理深度解析》Redisson是一个高性能的Redis客户端,它通过将Redis数据结构映射为Java对象和分布式对象,实现了在Java应用中方便地使用Redis,本文... 目录前言一、核心设计理念二、核心架构与通信层1. 基于 Netty 的异步非阻塞通信2. 编解码器三、

Linux jq命令的使用解读

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

C++中悬垂引用(Dangling Reference) 的实现

《C++中悬垂引用(DanglingReference)的实现》C++中的悬垂引用指引用绑定的对象被销毁后引用仍存在的情况,会导致访问无效内存,下面就来详细的介绍一下产生的原因以及如何避免,感兴趣... 目录悬垂引用的产生原因1. 引用绑定到局部变量,变量超出作用域后销毁2. 引用绑定到动态分配的对象,对象

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

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

SpringBoot基于注解实现数据库字段回填的完整方案

《SpringBoot基于注解实现数据库字段回填的完整方案》这篇文章主要为大家详细介绍了SpringBoot如何基于注解实现数据库字段回填的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以了解... 目录数据库表pom.XMLRelationFieldRelationFieldMapping基础的一些代

一篇文章彻底搞懂macOS如何决定java环境

《一篇文章彻底搞懂macOS如何决定java环境》MacOS作为一个功能强大的操作系统,为开发者提供了丰富的开发工具和框架,下面:本文主要介绍macOS如何决定java环境的相关资料,文中通过代码... 目录方法一:使用 which命令方法二:使用 Java_home工具(Apple 官方推荐)那问题来了,

Java HashMap的底层实现原理深度解析

《JavaHashMap的底层实现原理深度解析》HashMap基于数组+链表+红黑树结构,通过哈希算法和扩容机制优化性能,负载因子与树化阈值平衡效率,是Java开发必备的高效数据结构,本文给大家介绍... 目录一、概述:HashMap的宏观结构二、核心数据结构解析1. 数组(桶数组)2. 链表节点(Node