SpringBoot + MapStruct 屬性映射工具的使用詳解

更新時間：2021年09月18日 08:39:33 作者：機(jī)智的爆爆哥

MapStruct 是一個代碼生成器，簡化了不同的 Java Bean 之間映射的處理，所謂的映射指的就是從一個實體變化成一個實體。接下來通過本文給大家介紹SpringBoot + MapStruct 屬性映射工具的使用,需要的朋友可以參考下

1. MapStruct 是什么？

截取下官方的原話我給翻譯了一下說白了當(dāng)你的對象A有幾十個屬性而另一個對象B 與A比較只有一些細(xì)微的差別

那么這時候只需要映射過去即可而不需要瘋狂的調(diào)用set方法進(jìn)行屬性的拷貝這就是這個工具給我們帶來的最大便利

官方github鏈接點擊跳轉(zhuǎn)

2. 引入依賴

采用Mapstruct的最新版本 1.4.2.Final

SpringBoot版本不要選新版的我對比了下 2.3.0 和 2.5.4 后者會出現(xiàn)屬性映射為null的情況

已經(jīng)將問題反饋了具體不知道是和原因所以先用老版本吧

下面的插件最好與我的保持一致否則會導(dǎo)致一些問題

 <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.當(dāng)兩個對象屬性完全相同時 User 類

新建 User 類隨便加點屬性進(jìn)去

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

轉(zhuǎn)換接口 UserConvert

@Mapper// 注意 這里的注解是org.mapstruct包下的
public interface UserConvert {
    //默認(rèn)寫法 調(diào)用getMapper 獲取對應(yīng)的實體類 編譯后會生成對應(yīng)的實現(xiàn)類
    UserConvert INSTANCE = Mappers.getMapper(UserConvert.class);

    UserVo convert(User user);
}

我們將代碼編譯一下在 target目錄下找到對應(yīng)的實現(xiàn)類 UserConvertImpl

可以發(fā)現(xiàn)他其實就是將對應(yīng)的屬性設(shè)置到了 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;
        }
    }
}

測試屬性賦值

在對應(yīng)的測試類里轉(zhuǎn)化打印

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

打印結(jié)果如下

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

4. 當(dāng)對象屬性有所差別時 UserVo2

對應(yīng)的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 而已

修改轉(zhuǎn)換類

@Mapper// 注意 這里的注解是org.mapstruct包下的
public interface UserConvert {
    //默認(rèn)寫法 調(diào)用getMapper 獲取對應(yīng)的實體類 編譯后會生成對應(yīng)的實現(xiàn)類
    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);
    }

打印結(jié)果

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

如果要要將 name 賦值給 userName 其實也很簡單操作如下

新增 @Mappings 與@Mapping注解指明對應(yīng)哪個屬性賦值給哪個就可以了

@Mapper// 注意 這里的注解是org.mapstruct包下的
public interface UserConvert {
    //默認(rèn)寫法 調(diào)用getMapper 獲取對應(yīng)的實體類 編譯后會生成對應(yīng)的實現(xiàn)類
    UserConvert INSTANCE = Mappers.getMapper(UserConvert.class);

    UserVo convert(User user);

    @Mappings({
            //對應(yīng) source指向的是User targer指向的是UserVo2
            @Mapping(source = "name",target = "userName")
    })
    UserVo2 convert2(User user);

}

再次運行測試類

打印結(jié)果發(fā)現(xiàn)沒有問題