MapStruct对象映射常见问题和最佳实践

2024-03-17 11:29:29

使用 MapStruct 进行不同数据源的对象映射

在软件开发中，我们需要在不同的数据对象之间进行转换。MapStruct 是一个代码生成库，可以自动生成对象之间的映射实现。

问题

我们有一个场景，需要将 Source 对象映射到 Target 对象。Source 对象有一个字符串字段 str3，而 Target 对象有两个字符串字段 (str1 和 str2) 和一个嵌套对象 anotherObj。anotherObj 对象也有两个字符串字段 (str3 和 str4)。

最初的 MapStruct 映射如下：

@Mapping(target = "anotherObj", source = "request", qualifiedByName = "mapAnotherObjToSource")
@Mapping(target = "anotherObj.str4", source = "str4")
Target convert(Source request, String str4);

然而，执行映射时，我们遇到了一个错误：

Java: No read accessor found for property anotherObj in target type.

错误分析

错误表明 MapStruct 找不到目标类型 Target 中 anotherObj 属性的读取访问器。这是因为我们没有为 anotherObj 属性定义 getter 方法。

解决方案

1. 添加 getter 方法

@Getter
public class Target {
  public String str1;
  public String str2;
  public AnotherObj anotherObj;
}

2. 使用 @AfterMapping 方法

除了添加 getter 方法，我们还可以使用 @AfterMapping 方法来处理映射后的自定义逻辑。@AfterMapping 方法将在映射过程完成后调用。

@AfterMapping
default void handleStr4(@MappingTarget Target target, Source source, String str4) {
  if (target.getAnotherObj() != null) {
    target.getAnotherObj().setStr4(str4);
  }
}