Java编码辅助工具Mapstruct用法详解

首先，需要说明一下Mapstruct是一个Java编码辅助工具，用于简化Java bean之间的映射关系实现。接下来，我们对Mapstruct的用法进行详细介绍。

一、Mapstruct简介

Mapstruct是一个为Java bean之间的映射提供支持的代码生成器和框架，它类似于Lombok和Hibernate等工具。

使用Mapstruct可以自动创建Java bean之间的映射代码，而不需要我们手动完成映射代码的编写工作。此外Mapstruct还提供了一些扩展功能，比如函数调用映射、多资源映射等等。

二、Mapstruct的使用方法

下面给出Mapstruct的使用方法：

1.添加依赖

在pom.xml文件中添加如下依赖：

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

其中，最新版本可以在maven仓库中查找。

2.定义Mapper接口

定义Mapper接口其实就是定义 bean 之间的映射方法，首先需要在Mapper接口中声明注解@Mapper，并且设置componentModel为"spring"表示使用spring的依赖注入。

@Mapper(componentModel = "spring")
public interface UserMapper {
    UserDTO domain2Dto(User domain);
}

定义完Mapper接口后，就需要编写map映射方法了。方法名自定义，在映射方法中使用@Mapping配置声明映射关系。

@Mapper(componentModel = "spring")
public interface UserMapper {
    @Mapping(target = "id", source = "domain.id")
    @Mapping(target = "username", source = "domain.username")
    UserDTO domain2Dto(User domain);
}

3.执行映射转换

在执行映射转换时，我们需要先创建Mapper接口的实现类对象，再调用该对象的映射方法即可完成转换。

@Autowired
UserMapper userMapper;

@Test
public void testDomain2Dto() {
    User user = new User();
    user.setId(1);
    user.setUsername("Tom");

    UserDTO userDTO = userMapper.domain2Dto(user);

    Assert.assertNotNull(userDTO);
    Assert.assertEquals(user.getId(), userDTO.getId());
    Assert.assertEquals(user.getUsername(), userDTO.getUsername());
}

至此，Mapstruct的简单用法介绍完毕。接下来，我们进行两个示例的演示：

三、示例示范

示例一：基本类型映射

假设我们有两个Java bean类User和UserDTO，它们之间的属性如下：

User类：

public class User {
    private Long id;
    private String username;
    private Integer age;
    private Date createDate;
    // getter setter 略
}

UserDTO类：

public class UserDTO {
    private Long id;
    private String username;
    // getter setter 略
}

我们可以使用Mapstruct进行基本类型的映射转换代码如下：

1.定义Mapper接口

@Mapper(componentModel = "spring")
public interface UserMapper {
    UserDTO domain2Dto(User domain);

    List<UserDTO> domain2Dto(List<User> domain);
}

2.定义 map 映射方法

@Mapper(componentModel = "spring")
public interface UserMapper {
    @Mapping(target = "id", source = "domain.id")
    @Mapping(target = "username", source = "domain.username")
    UserDTO domain2Dto(User domain);

    List<UserDTO> domain2Dto(List<User> domain);
}

3.调用mapper方法

@Autowired
UserMapper userMapper;

@Test
public void testDomain2Dto() {
    User user = new User();
    user.setId(123L);
    user.setUsername("Tom");
    user.setAge(18);
    user.setCreateDate(new Date());

    UserDTO userDTO = userMapper.domain2Dto(user);

    Assert.assertEquals(user.getId(), userDTO.getId());
    Assert.assertEquals(user.getUsername(), userDTO.getUsername());
}

示例二： List集合映射

在示例一的基础之上，假如有 List domain，我们需要转成 List 呢？此时，可以加上一个映射关系如下：

@Mapper(componentModel = "spring")
public interface UserMapper {
    @Mapping(target = "id", source = "domain.id")
    @Mapping(target = "username", source = "domain.username")
    UserDTO domain2Dto(User domain);

    List<UserDTO> domain2Dto(List<User> domain);
}

相对应的，Lists和Stream的转换分别是：

List<UserDTO> result = userDTOList.stream().map(userMapper::domain2Dto).collect(Collectors.toList());

List<UserDTO> result = Lists.transform(domain, userMapper::domain2Dto);//GuavaConverters.toDTOs

至此，我们对Mapstruct的用法以及示例进行了详细的介绍，希望能对大家有所帮助。