SpringBoot 整合mapstruct的实现步骤

下面是详细讲解“SpringBoot 整合 MapStruct 的实现步骤”的完整攻略。

什么是 MapStruct

MapStruct 是一个在编译时期通过注解自动生成 Java Bean 映射代码的框架。它具有简单易用、高效准确等特点，可以大幅度提升 Java Bean 映射的开发效率。

SpringBoot 整合 MapStruct 的实现步骤

步骤一：添加 MapStruct 依赖

在 SpringBoot 项目中添加 MapStruct 依赖，可参考以下配置：

<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct</artifactId>
    <version>${mapstruct.version}</version>
</dependency>

其中，${mapstruct.version} 需要在项目中指定。

步骤二：创建 Bean 实体类

创建需要转换的 Bean 实体类，并使用 @Mapper 注解标注该类，该注解表明这是一个 MapStruct 映射器，在编译时期会根据该注解自动生成 Bean 映射代码，示例如下：

@Mapper
public interface UserMapper {
    UserDto toUserDto(User entity);
    User toUser(UserDto dto);
}

步骤三：编写 MapStruct 映射接口

在上一步骤中创建的 Bean 映射器中，需要创建映射接口，用于 Bean 属性之间的映射，示例代码如下：

public interface UserMapper {
    UserDto toUserDto(User entity);
    User toUser(UserDto dto);
}

步骤四：实现 MapStruct 映射接口

编写具体的 Bean 属性映射实现代码，可使用 MapStruct 提供的 @Mappings 注解和 @Mapping 注解自定义属性映射，示例代码如下：

@Mapper
public interface UserMapper {
    @Mappings({
        @Mapping(source = "name", target = "username"),
        @Mapping(source = "password", target = "password"),
        @Mapping(source = "phone", target = "userPhone.phoneNum"),
    })
    UserDto toUserDto(User entity);

    // 反向映射
    @InheritInverseConfiguration
    User toUser(UserDto dto);
}

步骤五：调用 MapStruct 映射方法

在代码中调用 MapStruct 的映射方法，示例代码如下：

@Autowired
private UserMapper userMapper;

public void test() {
    User entity = new User();
    entity.setName("zhangsan");
    entity.setPassword("123456");
    entity.setPhone("13812345678");

    UserDto dto = userMapper.toUserDto(entity);

    System.out.println(dto);
}

示例 One

下面示例展示了如何使用 MapStruct 实现 User 和 UserDTO 之间的映射。

创建 User

创建 User 类：

@Data
public class User{
    private String name;
    private Integer age;
}

创建 UserDTO

创建 UserDTO 类：

@Data
public class UserDTO{
    private String name;
    private Integer age;
}

创建 UserMapper

创建 UserMapper 接口：

@Mapper
public interface UserMapper {

    UserDTO toDTO(User entity);

    List<UserDTO> toDTOList(List<User> entityList);

    @InheritInverseConfiguration
    //@Mapping(target = "age", ignore = true)//忽略不需要转换的字段映射
    User toEntity(UserDTO dto);

}

测试 UserMapper

编写测试代码，使用 UserMapper 进行 User 和 UserDTO 之间的映射：

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserMapperTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testUserToDTO(){
        User user = new User();
        user.setName("zhangsan");
        user.setAge(18);

        UserDTO userDTO = userMapper.toDTO(user);

        Assert.assertEquals(user.getName(), userDTO.getName());
        Assert.assertEquals(user.getAge(), userDTO.getAge());
    }

    @Test
    public void testDTOToUser(){
        UserDTO userDTO = new UserDTO();
        userDTO.setName("zhangsan");
        userDTO.setAge(18);

        User user = userMapper.toEntity(userDTO);

        Assert.assertEquals(userDTO.getName(), user.getName());
        Assert.assertEquals(userDTO.getAge(), user.getAge());
    }

}

示例 Two

下面示例展示了如何使用 MapStruct 实现 User 和 UserVO 之间的映射。

创建 User

创建 User 类：

@Data
public class User{
    private String name;
    private Integer age;
}

创建 UserVO

创建 UserVO 类：

@Data
public class UserVO{
    private String name;
    private Integer age;
}

创建 UserMapper

创建 UserMapper 接口：

@Mapper
public interface UserMapper {

    UserVO toVO(User entity);

    List<UserVO> toVOList(List<User> entityList);

    @InheritInverseConfiguration
    //@Mapping(target = "age", ignore = true)//忽略不需要转换的字段映射
    User toEntity(UserVO dto);

}

测试 UserMapper

编写测试代码，使用 UserMapper 进行 User 和 UserVO 之间的映射：

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserMapperTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testUserToVO(){
        User user = new User();
        user.setName("zhangsan");
        user.setAge(18);

        UserVO userVO = userMapper.toVO(user);

        Assert.assertEquals(user.getName(), userVO.getName());
        Assert.assertEquals(user.getAge(), userVO.getAge());
    }

    @Test
    public void testVOToUser(){
        UserVO userVO = new UserVO();
        userVO.setName("zhangsan");
        userVO.setAge(18);

        User user = userMapper.toEntity(userVO);

        Assert.assertEquals(userVO.getName(), user.getName());
        Assert.assertEquals(userVO.getAge(), user.getAge());
    }

}

以上就是 SpringBoot 整合 MapStruct 的详细过程。通过以上过程，我们可以看到 MapStruct 在 Bean 映射上的高效和便利的特点，大幅度提升了开发效率。