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

Z时代
2024-01-10
分类：IT

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);
}

再次运行测试类

打印结果发现没有问题