Java对象属性复制组件-Mapstruct的项目改造指南

// pom.xml
        <dependency>
            <groupId>org.MapStruct</groupId>
            <artifactId>MapStruct</artifactId>
            <version>1.4.1.Final</version>
        </dependency>

// pom.xml
// 为了防止lombok和MapStruct的冲突，在pom.xml加入如下配置
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>${plugin.compiler.version}</version>
            <configuration>
                <source>1.8</source>             
                <target>1.8</target>
                <annotationProcessorPaths>
                    <path>
                        <groupId>org.MapStruct</groupId>
                        <artifactId>MapStruct-processor</artifactId>
                        <version>${MapStruct.version}</version>
                    </path>
                    <path>
                        <groupId>org.projectlombok</groupId>
                        <artifactId>lombok</artifactId>
                        <version>${lombok.version}</version>
                    </path>
                    <!-- other annotation processors -->
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>

/**
 * componentModel = "spring"：表明该类是一个 spring 组件,之后调用处只需要使用@Autowired，即可引入该类实例
 * NullValuePropertyMappingStrategy.IGNORE：如果遇到旧对象属性为null，则跳过该属性赋值给新对象
 */
@Mapper(componentModel = "spring", nullValuePropertyMappingStrategy = NullValuePropertyMappingStrategy.IGNORE)
public interface UserTransMapper {
    /**
     * 这个对象可用于非Spring环境下获取当前对象实例。如果在Spring环境下，该行代码可删除
     */
    UserTransMapper INSTANCE = Mappers.getMapper(UserTransMapper.class);
    
    /**
     * 将Userinfo对象中非null的属性转化为UserDto的对象
     * @param userInfo 从数据库读取的用户信息
     * @return
     */
    UserDto userInfo2userDto(UserInfo userInfo);

    /**
     * 将Userinfo对象中非null的属性更新到UserDto的对象
     * @param userInfo 从数据库读取的用户信息
     * @param userDto 用户信息的dto
     * 如果改void为UserDto，则函数会返回更新后的UserDto对象
     */
    void updateUserInfo2userDto(UserInfo userInfo, @MappingTarget UserDto userDto);

    /**
     * 将UserDto对象中非null的属性转化为LoginEventDto的对象
     * @param userDto 用户信息的dto
     * @return LoginEventDto继承UserDto
     */
    LoginEventDto userDto2loginEventDto(UserDto userDto);
}

@Mapper(componentModel = "spring", nullValuePropertyMappingStrategy = NullValuePropertyMappingStrategy.IGNORE)
public interface UserTransMapper {

    /**
     * UserDto对象中非null的属性转化为UserInfoVo的对象
     * @param userDto 用户信息的dto
     * @return UserInfoVo继承与UserBaseInfoVo，都是用了@Data，没有异常报错。
     */
    UserInfoVo userDto2userVo(UserDto userDto);

    /**
     * 直接写嵌套List等集合类，同样可以生效
     * @param userDtoList
     * @return
     */
    List<UserInfoVo> userDto2userVo(List<UserDto> userDtoList);

    /**
     * 如果UserDto存在成员变量是类UserSubDto，而UserInfoVo存在成员变量是类UserSubVo，想在上面转化的同时，让这两个成员变量进行赋值，只需要定义下面的函数即可。
     *
     * @param userSubDto 用户信息的dto中的成员变量，类型为UserSubDto
     * @return
     */
    UserSubVo userSubDto2userSubVo(UserSubDto userSubDto);

    /**
     * UserDto对象和FollowInfoDto对象中非null的属性转化为UserInfoVo的对象
     * @param userDto 用户信息的dto
     * @param followInfoDto 关注粉丝的dto
     * @param hn 房子数量
     * @return
     */
    @Mappings({
            @Mapping(source = "userDto.regionId",target = "regionId"),
            @Mapping(source = "followInfoDto.price", target = "price", numberFormat = "0.00"),
            @Mapping(source = "hn",target = "houseNumber")
    })
    /**
     * @Mapping也就是手动映射字段的操作，使用简单，读者可自行研究
     */
    UserInfoVo userDto2userVo(UserDto userDto, FollowInfoDto followInfoDto, Integer hn);
    /**
     * 假设从映射Person到PersonDto需要一些MapStruct无法生成的特殊逻辑，可以定义一个default函数
     */
    default PersonDto personToPersonDto(Person person) {
        // 手动写映射逻辑
    }
}