详解Java对象转换神器MapStruct库的使用

下面我来为你详细讲解“详解Java对象转换神器MapStruct库的使用”的完整攻略。

什么是MapStruct库？

MapStruct是一个JavaBean映射工具，它可以自动生成JavaBean之间互相转换的映射代码，从而避免手动编写“getter”和“setter”方法。

MapStruct的使用方法

步骤一：添加依赖

首先，我们需要在项目中添加MapStruct的依赖。我们可以在Maven或Gradle中加入以下依赖：

<!-- Maven -->
<dependency>
  <groupId>org.mapstruct</groupId>
  <artifactId>mapstruct</artifactId>
  <version>1.3.1.Beta3</version>
</dependency>

<!-- Gradle -->
implementation 'org.mapstruct:mapstruct:1.3.1.Beta3'

步骤二：定义接口

然后，我们需要定义一个接口，并且在接口中定义映射方法。将来源对象Source转换为一个目标对象Target，这就需要编写一个对应的映射方法。

@Mapper
public interface SourceTargetMapper {

    SourceTargetMapper INSTANCE = Mappers.getMapper(SourceTargetMapper.class);

    Target sourceToTarget(Source source);

    List<Target> sourceToTargetList(List<Source> sourceList);
}

• @Mapper注解表示该接口是一个MapStruct映射的接口。
• INSTANCE是MapStruct推荐的单例方式，可以在其他代码中使用。
• sourceToTarget和sourceToTargetList是映射方法，需要在接口中声明。我们只需要指定目标对象Target和来源对象Source，并且MapStruct会自动生成映射代码。

步骤三：使用映射

现在，我们可以在代码中使用MapStruct生成的映射方法。

Source source = new Source();
source.setId(1L);
source.setName("source");

Target target = INSTANCE.sourceToTarget(source);
System.out.println(target.getName()); // 输出 "source"

我们可以看到，现在source通过sourceToTarget映射方法被转换为了target对象，其中name属性已经被正确地转移过来。

示例一：转换字段名不同的对象

现在，我们有一个需求，需要将两个字段名不同的对象进行转换，其中来源对象Person的name属性需要映射到目标对象UserName的username属性。

@Data
public class Person {
    private Long id;
    private String name;
}

@Data
public class UserName {
    private Long id;
    private String username;
}

我们可以定义这样一个映射接口：

@Mapper
public interface PersonUserNameMapper {
    PersonUserNameMapper INSTANCE = Mappers.getMapper(PersonUserNameMapper.class);

    @Mapping(source = "name", target = "username")
    UserName personToUserName(Person person);
}

在上述定义中，我们使用@Mapping注解指定源对象的name属性对应到目标对象的username属性。

如上述定义方法完成后，我们可以在实际业务场景中使用：

Person person = new Person();
person.setId(1L);
person.setName("test");

UserName userName = PersonUserNameMapper.INSTANCE.personToUserName(person);
System.out.println(userName.getUsername()); // 输出 "test"

示例二：转换枚举类型

有时候，我们需要将枚举类型源对象中的字段，转换到目标对象的字符串类型字段中。

@Data
public class User {
    private Long id;
    private String name;
    private GenderEnum gender;
}

@Data
public class UserDTO {
    private Long id;
    private String name;
    private String gender;
}

public enum GenderEnum {
    MALE,
    FEMALE
}

我们可以定义这样一个映射接口：

@Mapper
public interface UserMapper {
    UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);

    @Mapping(source = "gender", target = "gender", qualifiedByName = "genderEnumToString")
    UserDTO userToUserDTO(User user);

    @Named("genderEnumToString")
    static String genderEnumToString(GenderEnum gender) {
        return gender == null ? null : gender.toString();
    }
}

• @Mapping注解中指定对于源对象中的GenderEnum类型，需要通过genderEnumToString方法进行转换。
• genderEnumToString方法负责将GenderEnum类型转换为字符串类型。

如上述定义方法完成后，我们可以在实际业务场景中使用：

User user = new User();
user.setId(1L);
user.setName("test");
user.setGender(GenderEnum.MALE);

UserDTO userDTO = UserMapper.INSTANCE.userToUserDTO(user);
System.out.println(userDTO.getGender()); // 输出 "MALE"

总结

MapStruct是一个JavaBean映射工具，可以帮助我们轻松地进行对象之间的转换。我们只需要在接口中定义好映射方法，MapStruct会自动生成对应的映射代码。使用这个库可以加快开发效率，并且减少手写代码的负担。