MapStruct是什么

简介： 在我们日常的Java开发工作中，经常会遇到模型对象的转化，例如将DTO转化为PO，进行数据模型转换的方式有很多种，与动态映射框架相比，MapStruct通过使用普通方法getter、setter方法进行快速模型转换的实现，而不是反射的形式，效率很高，这里简单介绍一下其用法。

以分页查询作为一个例子，将Req和Dto进行转换，示例所使用的的类：
UserPo:

@TableName("user")
@Data
public class UserPo extends BaseEntity implements Serializable {
    @TableId(value = "id",type = IdType.AUTO)
    private Long id;

    private String name;

    private Integer age;

}

UserDTO：

@Data
public class UserDto {

    private String name;

    private Integer age;

    private Integer pageSize;

    private Integer pageIndex;
}

UserListReq:

@Data
public class UserListReq {

    private Integer pageSize;

    private Integer pageIndex;
}

封装返回对象 PageResult

@Data
public class PageResult<T>  implements Serializable {
    private Long total;

    private Long size;

    private Long current;

    private Long pages;

    private List<T> records = Collections.emptyList();

    public void loadData(IPage<T> pageData) {
        this.setCurrent(pageData.getCurrent());
        this.setSize(pageData.getSize());
        this.setTotal(pageData.getTotal());
        this.setRecords(pageData.getRecords());
        this.setPages(pageData.getPages());
    }
}

UserService 层中的代码：

 @Override
    public PageResult<UserPo> getUserPage(UserDto userDto) {
        IPage<UserPo> userPoPage = new Page<>(userDto.getPageIndex(),userDto.getPageSize());
        IPage<UserPo> userPage = userMapper.selectPage(userPoPage, null);
        PageResult<UserPo> pageResult = new PageResult<>();
        pageResult.loadData(userPage);
        return pageResult;
    }

传统的BeanUtils的模型转换用法：
controller层中的代码，Result是封装的一个统一返回类，这里不展示：

 @GetMapping("/page")
    public Result page(@RequestBody UserListReq userListReq) {
        UserDto userDto = new UserDto();
        BeanUtils.copyProperties(userListReq,userDto);
        return Result.ok(userService.getUserPage(userDto));
    }

使用BeanUtils的方式直接进行模型转换，虽然看上去很简洁，但实际因为使用反射效率较低。

下面我们采用MapStruct的方式进行转换
基础用法：
引入依赖：

<dependencies>
        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct</artifactId>
            <version>1.4.2.Final</version>
        </dependency>
        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct-processor</artifactId>
            <version>1.4.2.Final</version>
        </dependency>
    </dependencies>

编写一个convert接口

@Mapper
public interface UserDtoConvert {
    UserDtoConvert INSTANCE = Mappers.getMapper(UserDtoConvert.class);
//    @Mapping(source = "pageIndex",target = "pageNo") 
    UserDto convertReqToUserDTO(UserListReq userListReq);
}

controller层中使用

  @GetMapping("/page")
    public Result page(@RequestBody UserListReq userListReq) {
        UserDto userDto = UserDtoConvert.INSTANCE.convertReqToUserDTO(userListReq);
        return Result.ok(userService.getUserPage(userDto));
    }

只需要调用接口方法即可，使用方式非常简介，效率也很高。

另一个可能会导致的问题：

lombok一定要在mapstruct之前，不然返回的对象属性值仍然为null
查看编译后的文件

这是lombok在mapstruct之前生成的实现类