Java中的MapStruct的使用方法代碼實(shí)例

更新時(shí)間：2023年10月21日 09:45:08 作者：浪浪山的猿

這篇文章主要介紹了Java中的MapStruct的使用方法代碼實(shí)例,mapstruct是一種實(shí)體類映射框架,能夠通過Java注解將一個(gè)實(shí)體類的屬性安全地賦值給另一個(gè)實(shí)體類,有了mapstruct,只需要定義一個(gè)映射器接口,聲明需要映射的方法,需要的朋友可以參考下

一、MapStruct 簡(jiǎn)介

mapstruct是一種實(shí)體類映射框架，能夠通過Java注解將一個(gè)實(shí)體類的屬性安全地賦值給另一個(gè)實(shí)體類。有了mapstruct，只需要定義一個(gè)映射器接口，聲明需要映射的方法，在編譯過程中，mapstruct會(huì)自動(dòng)生成該接口的實(shí)現(xiàn)類，實(shí)現(xiàn)將源對(duì)象映射到目標(biāo)對(duì)象的效果。

二、MapStruct 使用

切記：使用過程中遇到問題一定要看下面的必坑指南

1.引入依賴

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

這個(gè)依賴項(xiàng)會(huì)導(dǎo)入MapStruct的核心注釋。由于MapStruct在編譯時(shí)工作，并且會(huì)集成到像Maven和Gradle這樣的構(gòu)建工具上，我們還必須在<build中/>標(biāo)簽中添加一個(gè)插件maven-compiler-plugin，并在其配置中添加annotationProcessorPaths，該插件會(huì)在構(gòu)建時(shí)生成對(duì)應(yīng)的代碼。

   <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.相同字段間映射

我們先從一些基本的映射開始。我們會(huì)創(chuàng)建一個(gè)UserInfo 對(duì)象和一個(gè)UserInfoDTO 對(duì)象，為了方便起見，它們的屬性字段都使用相同的名稱。

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

現(xiàn)在，為了在這兩者之間進(jìn)行映射，我們要?jiǎng)?chuàng)建一個(gè)UserInfoConvert接口。對(duì)該接口使用@Mapper注解，MapStruct就會(huì)知道這是兩個(gè)類之間的映射器。

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

這段代碼中創(chuàng)建了一個(gè)UserInfoConvert類型的實(shí)例INSTANCE，在生成對(duì)應(yīng)的實(shí)現(xiàn)代碼后，這就是我們調(diào)用的“入口”。

我們?cè)诮涌谥卸x了toDTO()方法，該方法接收一個(gè)UserInfo實(shí)例為參數(shù)，并返回一個(gè)UserInfoDTO實(shí)例。這足以讓MapStruct知道我們想把一個(gè)UserInfo 實(shí)例映射到一個(gè)UserInfoDTO實(shí)例。

當(dāng)我們構(gòu)建/編譯應(yīng)用程序時(shí)，MapStruct注解處理器插件會(huì)識(shí)別UserInfoConvert接口并為其生成一個(gè)實(shí)現(xiàn)類。

@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 類中包含一個(gè)toDTO()方法，將我們的UserInfo 屬性值映射到userInfoDTO 的屬性字段中。如果要將UserInfo 實(shí)例映射到一個(gè)userInfoDTO 實(shí)例，可以這樣寫：

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

2.不同字段間映射

通常，模型和DTO的字段名不會(huì)完全相同。由于團(tuán)隊(duì)成員各自指定命名，以及針對(duì)不同的調(diào)用服務(wù)，開發(fā)者對(duì)返回信息的打包方式選擇不同，名稱可能會(huì)有輕微的變化。

注意下面兩個(gè)實(shí)體中的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;
}

現(xiàn)在，我們需要讓 UserMapper 知道這里的不一致。我們可以使用 @Mapping 注解，并設(shè)置其內(nèi)部的 source 和 target 標(biāo)記分別指向不一致的兩個(gè)字段。

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

生成的實(shí)現(xiàn)類

@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();
        // 注意這里,已經(jīng)自動(dòng)轉(zhuǎn)換了
        userInfoDTO.setMyEmail( userInfo.getEmail() );
        userInfoDTO.setId( userInfo.getId() );
        userInfoDTO.setName( userInfo.getName() );
        userInfoDTO.setSex( userInfo.getSex() );
        return userInfoDTO;
    }
}

三、避坑指南

1號(hào)坑

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號(hào)坑

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

如果annotationProcessorPaths有l(wèi)ombok和mapstruct-processor，查看lombok是否放在mapstruct-processor后面，切記lombok要放在mapstruct-processor之前。

錯(cuò)誤方式：

    <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>

到此這篇關(guān)于Java中的MapStruct的使用方法代碼實(shí)例的文章就介紹到這了,更多相關(guān)MapStruct的使用方法內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: