脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → MapStruct的使用方法

Java中的MapStruct的使用方法代码实例

 更新时间：2023年10月21日 09:45:08   作者：浪浪山的猿  
这篇文章主要介绍了Java中的MapStruct的使用方法代码实例,mapstruct是一种实体类映射框架,能够通过Java注解将一个实体类的属性安全地赋值给另一个实体类,有了mapstruct,只需要定义一个映射器接口,声明需要映射的方法,需要的朋友可以参考下

一、MapStruct 简介

mapstruct是一种实体类映射框架，能够通过Java注解将一个实体类的属性安全地赋值给另一个实体类。有了mapstruct，只需要定义一个映射器接口，声明需要映射的方法，在编译过程中，mapstruct会自动生成该接口的实现类，实现将源对象映射到目标对象的效果。

二、MapStruct 使用

切记：使用过程中遇到问题一定要看下面的必坑指南

1.引入依赖

        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct</artifactId>
            <version>1.5.2.Final</version>
        </dependency>

这个依赖项会导入MapStruct的核心注释。由于MapStruct在编译时工作，并且会集成到像Maven和Gradle这样的构建工具上，我们还必须在<build中/>标签中添加一个插件maven-compiler-plugin，并在其配置中添加annotationProcessorPaths，该插件会在构建时生成对应的代码。

   <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
              <!--以下为mapstruct所需配置--> 
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.5.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <annotationProcessorPaths>
                        <path>
                            <groupId>org.mapstruct</groupId>
                            <artifactId>mapstruct-processor</artifactId>
                            <version>1.5.2.Final</version>
                        </path>
                    </annotationProcessorPaths>
                </configuration>
            </plugin>
        </plugins>
    </build>

2. 基本映射

1.相同字段间映射

我们先从一些基本的映射开始。我们会创建一个UserInfo 对象和一个UserInfoDTO 对象，为了方便起见，它们的属性字段都使用相同的名称。

@Data
@TableName(value = "user_info")
public class UserInfo {
    private String id;
    private String name;
    private String sex;
    private String email;
}
@Data
public class UserInfoDTO {
    private String id;
    private String name;
    private String sex;
    private String email;
}

现在，为了在这两者之间进行映射，我们要创建一个UserInfoConvert接口。对该接口使用@Mapper注解，MapStruct就会知道这是两个类之间的映射器。

@Mapper
public interface UserInfoConvert {
    UserInfoConvert INSTANCE = Mappers.getMapper(UserInfoConvert.class);
    UserInfoDTO toDTO(UserInfo userInfo);
}

这段代码中创建了一个UserInfoConvert类型的实例INSTANCE，在生成对应的实现代码后，这就是我们调用的“入口”。

我们在接口中定义了toDTO()方法，该方法接收一个UserInfo实例为参数，并返回一个UserInfoDTO实例。这足以让MapStruct知道我们想把一个UserInfo 实例映射到一个UserInfoDTO实例。

当我们构建/编译应用程序时，MapStruct注解处理器插件会识别UserInfoConvert接口并为其生成一个实现类。

@Generated(
    value = "org.mapstruct.ap.MappingProcessor",
    date = "2022-07-19T14:15:05+0800",
    comments = "version: 1.5.2.Final, compiler: javac, environment: Java 1.8.0_181 (Oracle Corporation)"
)
public class UserInfoConvertImpl implements UserInfoConvert {
    @Override
    public UserInfoDTO toDTO(UserInfo userInfo) {
        if ( userInfo == null ) {
            return null;
        }
        UserInfoDTO userInfoDTO = new UserInfoDTO();
        return userInfoDTO;
    }
}

UserInfoConvertImpl 类中包含一个toDTO()方法，将我们的UserInfo 属性值映射到userInfoDTO 的属性字段中。如果要将UserInfo 实例映射到一个userInfoDTO 实例，可以这样写：

     UserInfoDTO userInfoDTO = UserInfoConvert.INSTANCE.toDTO(userInfo);

2.不同字段间映射

通常，模型和DTO的字段名不会完全相同。由于团队成员各自指定命名，以及针对不同的调用服务，开发者对返回信息的打包方式选择不同，名称可能会有轻微的变化。

注意下面两个实体中的email字段不一致

public class UserInfo {
    private String id;
    private String name;
    private String sex;
    private String email;
}
@Data
public class UserInfoDTO {
    private String id;
    private String name;
    private String sex;
    private String myEmail;
}

现在，我们需要让 UserMapper 知道这里的不一致。我们可以使用 @Mapping 注解，并设置其内部的 source 和 target 标记分别指向不一致的两个字段。

@Mapper
public interface UserInfoConvert {
    UserInfoConvert INSTANCE = Mappers.getMapper(UserInfoConvert.class);
    @Mapping(target = "myEmail", source = "email")
    UserInfoDTO toDTO(UserInfo userInfo);
}

生成的实现类

@Generated(
    value = "org.mapstruct.ap.MappingProcessor",
    date = "2022-07-19T15:22:09+0800",
    comments = "version: 1.5.2.Final, compiler: javac, environment: Java 1.8.0_181 (Oracle Corporation)"
)
public class UserInfoConvertImpl implements UserInfoConvert {
    @Override
    public UserInfoDTO toDTO(UserInfo userInfo) {
        if ( userInfo == null ) {
            return null;
        }
        UserInfoDTO userInfoDTO = new UserInfoDTO();
        // 注意这里,已经自动转换了
        userInfoDTO.setMyEmail( userInfo.getEmail() );
        userInfoDTO.setId( userInfo.getId() );
        userInfoDTO.setName( userInfo.getName() );
        userInfoDTO.setSex( userInfo.getSex() );
        return userInfoDTO;
    }
}

三、避坑指南

1号坑

Error:(20, 5) java: No property named "***" exists in source parameter(s). Type "***" has no properties.

原因： annotationProcessorPaths中缺少lombok插件

  <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.5.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <annotationProcessorPaths>
                      <!--缺少lombok-->
                        <path>
                            <groupId>org.mapstruct</groupId>
                            <artifactId>mapstruct-processor</artifactId>
                            <version>1.5.2.Final</version>
                        </path>
                    </annotationProcessorPaths>
                </configuration>
            </plugin>
        </plugins>
    </build>

解决办法：annotationProcessorPaths中加上lombok插件

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.5.1</version>
        <configuration>
            <source>1.8</source>
            <target>1.8</target>
            <annotationProcessorPaths>
                <path>
                    <groupId>org.projectlombok</groupId>
                    <artifactId>lombok</artifactId>
                    <version>1.18.20</version>
                </path>
                <path>
                    <groupId>org.mapstruct</groupId>
                    <artifactId>mapstruct-processor</artifactId>
                    <version>1.5.2.Final</version>
                </path>
            </annotationProcessorPaths>
        </configuration>
    </plugin>

2号坑

Error:(20, 5) java: No property named "***" exists in source parameter(s). Type "***" has no properties.

如果annotationProcessorPaths有lombok和mapstruct-processor，查看lombok是否放在mapstruct-processor后面，切记lombok要放在mapstruct-processor之前。

错误方式：

    <annotationProcessorPaths>
        <path>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct-processor</artifactId>
            <version>1.5.2.Final</version>
        </path>
        <path>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.20</version>
        </path>
    </annotationProcessorPaths>

正确方式：

    <annotationProcessorPaths>
       <path>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.20</version>
        </path>
        <path>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct-processor</artifactId>
            <version>1.5.2.Final</version>
        </path>
    </annotationProcessorPaths>

到此这篇关于Java中的MapStruct的使用方法代码实例的文章就介绍到这了,更多相关MapStruct的使用方法内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • JAVA正则表达式及字符串的替换与分解相关知识总结

    JAVA正则表达式及字符串的替换与分解相关知识总结

    今天给大家带来的是关于Java的相关知识总结,文章围绕着JAVA正则表达式及字符串的替换与分解展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • SpringBoot + SpringSecurity 短信验证码登录功能实现

    SpringBoot + SpringSecurity 短信验证码登录功能实现

    这篇文章主要介绍了SpringBoot + SpringSecurity 短信验证码登录功能实现，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2018-06-06
  • 深入学习Java中的SPI机制

    深入学习Java中的SPI机制

    这篇文章主要介绍了深入学习Java中的SPI机制,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-09-09
  • Java文件大小转换的两种方式小结

    Java文件大小转换的两种方式小结

    在程序开发的过程中,文件的大小在视图呈现和数据库存储的过程不一致怎么转换呢,本文主要介绍了Java文件大小转换的两种方式小结,具有一定的参考价值,感兴趣的可以了解一下
    2024-07-07
  • java RocketMQ快速入门基础知识

    java RocketMQ快速入门基础知识

    这篇文章主要介绍了java RocketMQ快速入门基础知识，所以RocketMQ是站在巨人的肩膀上（kafka），又对其进行了优化让其更满足互联网公司的特点。它是纯Java开发，具有高吞吐量、高可用性、适合大规模分布式系统应用的特点。,需要的朋友可以参考下
    2019-06-06
  • SpringMVC实现controller中获取session的实例代码

    SpringMVC实现controller中获取session的实例代码

    本篇文章主要介绍了SpringMVC实现controller中获取session的实例代码，具有一定的参考价值，有兴趣的可以了解一下。
    2017-02-02
  • Java pdf文件书签承前缩放验证的设置方法

    Java pdf文件书签承前缩放验证的设置方法

    很多朋友不知道是什么是书签承前缩放，简单说就是可以任意改变当前pdf文档缩放比例，点击书签后不影响其缩放比率，本文给大家介绍下Java pdf文件书签承前缩放验证的设置方法，感兴趣的朋友一起看看吧
    2022-02-02
  • 详解Java Web如何限制访问的IP的两种方法

    详解Java Web如何限制访问的IP的两种方法

    这篇文章主要介绍了详解Java Web如何限制访问的IP的两种方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-10-10
  • K8S环境下如何验证RocketMQ扩缩容

    K8S环境下如何验证RocketMQ扩缩容

    文章主要内容验证了K8S环境下RocketMQ的扩缩容特性,包括序号变化、命名规则以及节点重建后序号保持不变,StatefulSet确保Pod序号在重建后保持稳定,而Deployment创建的Pod名称是随机的
    2025-01-01
  • SpringBoot2+Netty+WebSocket(netty实现websocket支持URL参数)问题记录

    SpringBoot2+Netty+WebSocket(netty实现websocket支持URL参数)问题记录

    Netty 是一个利用 Java 的高级网络的能力,隐藏其背后的复杂性而提供一个易于使用的 API 的客户端/服务器框架,这篇文章主要介绍了SpringBoot2+Netty+WebSocket(netty实现websocket,支持URL参数),需要的朋友可以参考下
    2023-12-12

最新评论