使用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实现为PDF设置背景色和背景图片

《Java实现为PDF设置背景色和背景图片》在日常的文档处理中,PDF格式因其稳定性和跨平台兼容性而广受欢迎,本文将深入探讨如何利用Spire.PDFforJava库,以简洁高效的方式为你的PDF文档... 目录库介绍与安装步骤Java 给 PDF 设置背景颜色Java 给 PDF 设置背景图片总结在日常的

C#中通过Response.Headers设置自定义参数的代码示例

《C#中通过Response.Headers设置自定义参数的代码示例》:本文主要介绍C#中通过Response.Headers设置自定义响应头的方法,涵盖基础添加、安全校验、生产实践及调试技巧,强... 目录一、基础设置方法1. 直接添加自定义头2. 批量设置模式二、高级配置技巧1. 安全校验机制2. 类型

Python屏幕抓取和录制的详细代码示例

《Python屏幕抓取和录制的详细代码示例》随着现代计算机性能的提高和网络速度的加快,越来越多的用户需要对他们的屏幕进行录制,:本文主要介绍Python屏幕抓取和录制的相关资料,需要的朋友可以参考... 目录一、常用 python 屏幕抓取库二、pyautogui 截屏示例三、mss 高性能截图四、Pill

Java中的Schema校验技术与实践示例详解

《Java中的Schema校验技术与实践示例详解》本主题详细介绍了在Java环境下进行XMLSchema和JSONSchema校验的方法,包括使用JAXP、JAXB以及专门的JSON校验库等技术,本文... 目录1. XML和jsON的Schema校验概念1.1 XML和JSON校验的必要性1.2 Sche

C++读写word文档(.docx)DuckX库的使用详解

《C++读写word文档(.docx)DuckX库的使用详解》DuckX是C++库,用于创建/编辑.docx文件,支持读取文档、添加段落/片段、编辑表格,解决中文乱码需更改编码方案,进阶功能含文本替换... 目录一、基本用法1. 读取文档3. 添加段落4. 添加片段3. 编辑表格二、进阶用法1. 文本替换2

Java抽象类Abstract Class示例代码详解

《Java抽象类AbstractClass示例代码详解》Java中的抽象类(AbstractClass)是面向对象编程中的重要概念,它通过abstract关键字声明,用于定义一组相关类的公共行为和属... 目录一、抽象类的定义1. 语法格式2. 核心特征二、抽象类的核心用途1. 定义公共接口2. 提供默认实

PyQt6 键盘事件处理的实现及实例代码

《PyQt6键盘事件处理的实现及实例代码》本文主要介绍了PyQt6键盘事件处理的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起... 目录一、键盘事件处理详解1、核心事件处理器2、事件对象 QKeyEvent3、修饰键处理(1)、修饰键类

Java轻松实现PDF转换为PDF/A的示例代码

《Java轻松实现PDF转换为PDF/A的示例代码》本文将深入探讨Java环境下,如何利用专业工具将PDF转换为PDF/A格式,为数字文档的永续保存提供可靠方案,文中的示例代码讲解详细,感兴趣的小伙伴... 目录为什么需要将PDF转换为PDF/A使用Spire.PDF for Java进行转换前的准备通过

Rust 智能指针的使用详解

《Rust智能指针的使用详解》Rust智能指针是内存管理核心工具,本文就来详细的介绍一下Rust智能指针(Box、Rc、RefCell、Arc、Mutex、RwLock、Weak)的原理与使用场景,... 目录一、www.chinasem.cnRust 智能指针详解1、Box<T>:堆内存分配2、Rc<T>:

SpringBoot集成WebService(wsdl)实践

《SpringBoot集成WebService(wsdl)实践》文章介绍了SpringBoot项目中通过缓存IWebService接口实现类的泛型入参类型,减少反射调用提升性能的实现方案,包含依赖配置... 目录pom.XML创建入口ApplicationContextUtils.JavaJacksonUt