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

更新时间：2021年09月18日 08:39:33 作者：机智的爆爆哥

MapStruct 是一个代码生成器，简化了不同的 Java Bean 之间映射的处理，所谓的映射指的就是从一个实体变化成一个实体。接下来通过本文给大家介绍SpringBoot + MapStruct 属性映射工具的使用,需要的朋友可以参考下

1. MapStruct 是什么？

截取下官方的原话我给翻译了一下说白了当你的对象A有几十个属性而另一个对象B 与A比较只有一些细微的差别

那么这时候只需要映射过去即可而不需要疯狂的调用set方法进行属性的拷贝这就是这个工具给我们带来的最大便利

官方github链接点击跳转

2. 引入依赖

采用Mapstruct的最新版本 1.4.2.Final

SpringBoot版本不要选新版的我对比了下 2.3.0 和 2.5.4 后者会出现属性映射为null的情况

已经将问题反馈了具体不知道是和原因所以先用老版本吧

下面的插件最好与我的保持一致否则会导致一些问题

 <properties>
        <java.version>1.8</java.version>
        <mapstruct.version>1.4.2.Final</mapstruct.version>
    </properties>
    
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct</artifactId>
            <version>${mapstruct.version}</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
      <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                    <annotationProcessorPaths>
                        <!-- 引入 mapstruct-processor -->
                        <path>
                            <groupId>org.mapstruct</groupId>
                            <artifactId>mapstruct-processor</artifactId>
                            <version>${mapstruct.version}</version>
                        </path>
                        <!-- 引入 lombok-processor -->
                        <path>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                            <version>${lombok.version}</version>
                        </path>
                    </annotationProcessorPaths>
                </configuration>
            </plugin>
        </plugins>
    </build>

3.当两个对象属性完全相同时 User 类

新建 User 类随便加点属性进去

@Data
@Accessors(chain = true)
public class User {

    private String name;
    private String password;
    private String money;
}

UserVo 类

再新建一个我们需要拷贝过去的对象 UserVo 属性完全相同

@Data
@Accessors(chain = true)
public class UserVo {

    private String name;
    private String password;
    private String money;
}

转换接口 UserConvert

@Mapper// 注意 这里的注解是org.mapstruct包下的
public interface UserConvert {
    //默认写法 调用getMapper 获取对应的实体类 编译后会生成对应的实现类
    UserConvert INSTANCE = Mappers.getMapper(UserConvert.class);

    UserVo convert(User user);
}

我们将代码编译一下在 target目录下找到对应的实现类 UserConvertImpl

可以发现他其实就是将对应的属性设置到了 Vo对象中罢了只不过这是自动生成的

public class UserConvertImpl implements UserConvert {
    public UserConvertImpl() {
    }

    public UserVo convert(User user) {
        if (user == null) {
            return null;
        } else {
            UserVo userVo = new UserVo();
            userVo.setName(user.getName());
            userVo.setPassword(user.getPassword());
            userVo.setMoney(user.getMoney());
            return userVo;
        }
    }
}

测试属性赋值

在对应的测试类里转化打印

    @Test
    void contextLoads() {
        User user = new User().setName("爆爆").setPassword("123").setMoney("500");
        UserVo userVo = UserConvert.INSTANCE.convert(user);
        System.out.println(userVo);
    }

打印结果如下

UserVo(name=爆爆, password=123, money=500)

4. 当对象属性有所差别时 UserVo2

对应的User 不变新增一个 UserVo2

将原先的name改成了UserName

@Data
@Accessors(chain = true)
public class UserVo2 {
    //name--->userName
    private String userName;
    private String password;
    private String money;
}

这时候我们要将User的属性值直接赋予其实是不会报错的只不过name不会映射给UserName 而已

修改转换类

@Mapper// 注意 这里的注解是org.mapstruct包下的
public interface UserConvert {
    //默认写法 调用getMapper 获取对应的实体类 编译后会生成对应的实现类
    UserConvert INSTANCE = Mappers.getMapper(UserConvert.class);

    UserVo convert(User user);
	//新增一个方法
    UserVo2 convert2(User user);

}

再次测试

@Test
    void contextLoads() {
        User user = new User().setName("爆爆").setPassword("123").setMoney("500");
        UserVo2 userVo2 = UserConvert.INSTANCE.convert2(user);
        System.out.println(userVo2);
    }

打印结果

UserVo2(userName=null, password=123, money=500)

如果要要将 name 赋值给 userName 其实也很简单操作如下

新增 @Mappings 与@Mapping注解指明对应哪个属性赋值给哪个就可以了

@Mapper// 注意 这里的注解是org.mapstruct包下的
public interface UserConvert {
    //默认写法 调用getMapper 获取对应的实体类 编译后会生成对应的实现类
    UserConvert INSTANCE = Mappers.getMapper(UserConvert.class);

    UserVo convert(User user);

    @Mappings({
            //对应 source指向的是User targer指向的是UserVo2
            @Mapping(source = "name",target = "userName")
    })
    UserVo2 convert2(User user);

}

再次运行测试类

打印结果发现没有问题

UserVo2(userName=爆爆, password=123, money=500)

5. IDEA插件

mapstrut有对应的idea插件其实我觉得作用一般吧还是放上吧

插件链接

由于自己研究的也不多暂时写到这里

我们执着于那些遗憾，并非那些事情有多重要，而是那些时光里的自己，是真诚坦率且可爱的，也许这才是我们执着的意义。

到此这篇关于SpringBoot + MapStruct 属性映射工具的使用的文章就介绍到这了,更多相关SpringBoot属性映射工具内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

SpringBoot使用AOP+注解实现简单的权限验证的方法
这篇文章主要介绍了SpringBoot使用AOP+注解实现简单的权限验证的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2019-05-05
Spring注入Map集合实现策略模式详解
这篇文章主要介绍了Spring注入Map集合实现策略模式详解,Spring提供通过@Resource注解将相同类型的对象注入到Map集合,并将对象的名字作为key,对象作为value封装进入Map,需要的朋友可以参考下
2023-11-11
springboot省去配置Tomcat的步骤问题
这篇文章主要介绍了springboot省去配置Tomcat的步骤问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-06-06
举例解析Java多线程编程中需要注意的一些关键点
这篇文章主要介绍了Java多线程编程中需要注意的一些关键点,包括ThreadLocal变量与原子更新等一些深层次的内容,需要的朋友可以参考下
2015-11-11
JAVA十大排序算法之堆排序详解
这篇文章主要介绍了java中的冒泡排序，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考
2021-08-08
关于JSCH使用自定义连接池的说明
这篇文章主要介绍了关于JSCH使用自定义连接池的说明，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-09-09
一文带你深入了解Java TreeMap
TreeMap是Map家族中的一员，也是用来存放key-value键值对的。平时在工作中使用的可能并不多。本文将基于jdk8对其做一个讲解，感兴趣的可以了解一下
2022-09-09
Spring Boot集成 Spring Boot Admin 监控
这篇文章主要介绍了Spring Boot集成 Spring Boot Admin 监控，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-08-08
java文件的重命名与移动操作实例代码
这篇文章主要介绍了java文件的重命名与移动操作实例代码，具有一定借鉴价值,需要的朋友可以参考下
2017-12-12
Java中的动态代理和静态代理详细解析
这篇文章主要介绍了Java中的动态代理和静态代理详细解析,Java中的代理可以帮助被代理者完成一些前期的准备工作和后期的善后工作,但是核心的业务逻辑仍然是由被代理者完成,需要的朋友可以参考下
2023-11-11