spring中Mapstruct属性映射的实现

更新时间：2024年12月06日 11:36:29 作者：七禾页话

本文主要介绍了spring中Mapstruct属性映射的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

整合 Mapstruct : 简化属性映射

解决问题:当一个对象属性过多时，DO转VO需要写的字段太多了

1. 什么是 MapStruct？

MapStruct 是一个用于简化 Java Bean 映射代码的代码生成器。它可以自动生成在不同 Java 对象之间进行映射的代码，而无需手动编写复杂的转换逻辑。MapStruct 使得在 Java 应用程序中进行对象映射变得更加简单、高效、可维护。

2. 为什么要使用 MapStruct？

简化映射过程： 传统的 Java 对象映射需要编写大量的重复、繁琐的代码。MapStruct 自动生成这些映射代码，节省了开发人员的时间和精力。
类型安全性： MapStruct 是基于编译时的代码生成，因此提供了类型安全性。在编译时，它会检查源对象和目标对象的类型，避免了运行时的类型错误。
高性能： 由于 MapStruct 生成的代码是高度优化的，所以性能非常好。相比手动编写的映射代码，MapStruct 生成的代码更加高效。
可维护性： 当数据模型发生变化时，手动更新映射代码可能会非常麻烦。MapStruct 能够根据最新的数据模型自动生成新的映射代码，确保映射逻辑与数据模型保持同步。
灵活性： MapStruct 提供了丰富的配置选项和扩展点，可以满足各种复杂映射场景的需求。你可以定制生成的代码，以适应特定的业务逻辑。

3. 添加依赖

多模块中，在父工程模块的pom.xm下

    <!-- 版本号统一管理 -->
    <properties>
        // 省略...
        <mapstruct.version>1.5.5.Final</mapstruct.version>
    </properties>
    
    <!-- 统一依赖管理 -->
    <dependencyManagement>
        <dependencies>
			// 省略...

            <!-- Mapstruct 属性映射 -->
            <dependency>
                <groupId>org.mapstruct</groupId>
                <artifactId>mapstruct</artifactId>
                <version>${mapstruct.version}</version>
            </dependency>

        </dependencies>
    </dependencyManagement>
    
       <build>
        <!-- 统一插件管理 -->
        <pluginManagement>
            <plugins>
				// 省略...

                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <configuration>
                        <source>${java.version}</source> <!-- 根据你的 JDK 版本进行调整 -->
                        <target>${java.version}</target> <!-- 根据你的 JDK 版本进行调整 -->
                        <annotationProcessorPaths>
                            <path>
                                <groupId>org.projectlombok</groupId>
                                <artifactId>lombok</artifactId>
                                <version>${lombok.version}</version>
                            </path>
                            <path>
                                <groupId>org.mapstruct</groupId>
                                <artifactId>mapstruct-processor</artifactId>
                                <version>${mapstruct.version}</version> <!-- 使用时请检查最新版本 -->
                            </path>
                        </annotationProcessorPaths>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>

在需要使用的模块中添加

		<dependency>
			<groupId>org.mapstruct</groupId>
			<artifactId>mapstruct</artifactId>
		</dependency>

在入口模块添加编译插件:

    <build>
        <plugins>
			// 省略...
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

4. IDEA 配置 Mapstruct

添加好了 MapStruct 依赖后，已经可以确保项目中能够正常使用 MapStruct 了。但是，为了在开发过程中获得更好的体验，我们可以为 IDE 进行一些配置，从而支持 MapStruct 的自动代码生成、代码提示等功能。

4.1 启用注解处理器

打开 IntelliJ IDEA，并加载你的项目。
打开 File -> Settings (或 Preferences)。
在左侧导航栏中选择 Build, Execution, Deployment -> Compiler -> Annotation Processors。
勾选 Enable annotation processing。
在 Store generated sources relative to 下拉列表中选择 Module content root。
点击右下角 Apply 按钮应用设置，然后，点击 ok 按钮关闭弹框。

在这里插入图片描述

4.2添加MapStruct插件

虽然这不是必需的，但 MapStruct 插件可以为你提供一些很有用的功能，例如代码提示和自动补全。

打开 File -> Settings (或 Preferences)。
在左侧选择 Plugins。
在市场 (Marketplace) 中搜索 “MapStruct” 并安装它。
重启 IntelliJ IDEA。

5. 添加 convert 接口

新建一个 /convert 包，并创建一个 BlogSettingsConvert 转换接口，代码如下：

@Mapper
public interface BlogSettingsConvert {
    /**
     * 初始化 convert 实例
     */
    BlogSettingsConvert INSTANCE = Mappers.getMapper(BlogSettingsConvert.class);

    /**
     * 将 VO 转化为 DO
     * @param bean
     * @return
     */
    BlogSettingsDO convertVO2DO(UpdateBlogSettingsReqVO bean);

}

注意，接口类上添加的 @Mapper 注解，导入自 org.mapstruct.Mapper, 别搞错了哦。

6. 使用 Mapstruct 来转换

@Service
public class AdminBlogSettingsServiceImpl extends ServiceImpl<BlogSettingsMapper, BlogSettingsDO> implements AdminBlogSettingsService {

    @Override
    public Response updateBlogSettings(UpdateBlogSettingsReqVO updateBlogSettingsReqVO) {
        // VO 转 DO
        BlogSettingsDO blogSettingsDO = BlogSettingsConvert.INSTANCE.convertVO2DO(updateBlogSettingsReqVO);
        blogSettingsDO.setId(1L);

        // 保存或更新（当数据库中存在 ID 为 1 的记录时，则执行更新操作，否则执行插入操作）
        saveOrUpdate(blogSettingsDO);
        return Response.success();
    }
}
ingsDO.setId(1L);

        // 保存或更新（当数据库中存在 ID 为 1 的记录时，则执行更新操作，否则执行插入操作）
        saveOrUpdate(blogSettingsDO);
        return Response.success();
    }
}

将 VO 类转换为了 DO 类，仅需要对 VO 中没有值的字段，如 ID 字段设置一下值即可

到此这篇关于spring中Mapstruct属性映射的实现的文章就介绍到这了,更多相关spring Mapstruct属性映射内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

SpringBoot + MapStruct 属性映射工具的使用详解

JVM内存区域划分相关原理详解
这篇文章主要介绍了JVM内存区域划分相关原理详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-10-10
Spring强大事务兼容数据库多种组合解决业务需求
这篇文章主要为大家介绍了Spring强大事务兼容数据库多种组合解决业务需求示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-07-07
Java 图片与byte数组互相转换实例
下面小编就为大家带来一篇Java 图片与byte数组互相转换实例。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-02-02
一步步带你入门Java中File类
java.io.File类是文件和目录路径名的抽象表示形式,主要用于文件和目录的创建、查找和删除等操作,下面这篇文章主要给大家介绍了关于入门Java中File类的相关资料,需要的朋友可以参考下
2022-03-03
大话Java混合运算规则
这篇文章主要介绍了大话Java混合运算规则，小编觉得挺不错的，在这里分享给大家，需要的朋友可以了解下。
2017-10-10
Java在枚举类型中增加自定义方法详解
这篇文章主要介绍了Java在枚举类型中增加自定义方法详解,对于枚举类型来说,除了无法继承它以外,基本可以将它看作一个普通的类,这意味着你可以在里面增加自定义的方法,甚至可以增加一个 main() 方法,需要的朋友可以参考下
2023-11-11
Java日常练习题,每天进步一点点(21)
下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧，希望可以帮到你
2021-07-07
关于IDEA MybatisX插件的使用小技巧
这篇文章主要介绍了关于MybatisX插件的使用小技巧,MybatisX是IDEA的一款第三方插件,可以极大地提升我们的开发效率,一起来看看吧
2023-03-03
详解Java如何实现与JS相同的Des加解密算法
这篇文章主要介绍了如何在Java中实现与JavaScript相同的DES（Data Encryption Standard）加解密算法,确保在两个平台之间可以无缝地传递加密信息,希望对大家有一定的帮助
2025-04-04
[Java]详解Socket和ServerSocket学习笔记
即时类应用或者即时类的游戏，HTTP协议很多时候无法满足于我们的需求，这会，Socket对于我们来说就非常实用了。本篇文章主要介绍了Socket和ServerSocket，有兴趣的可以了解一下。
2016-12-12