在 mapstruct 中使用构建器（使用不可变注释处理器）将对象映射到不可变对象

Question

我们正在使用immutables framework 来生成所有 DTO。现在我们想用mapstruct 将这些对象映射到另一个对象。但是生成的 DTO 是不可变的，没有设置器和构造器，对应于构建器模式。它们仅通过静态builder()-方法访问的相应构建器填充。

我们尝试将 DTO1 映射到 DTO2.Builder，如果 mapstruct 能够识别 Builder 中的设置器，但它们没有 void 返回类型但返回 Builder 本身以进行流畅的连接，这将起作用。

所以这里是示例的代码。

我们有两个接口

@Value.Immutable
public interface MammalDto {
  public Integer getNumberOfLegs();
  public Long getNumberOfStomachs();
}

和

@Value.Immutable
public interface MammalEntity {
  public Long getNumberOfLegs();
  public Long getNumberOfStomachs();
}

那么我们就有了 mapstruct 的 Mapper 接口：

@Mapper(uses = ObjectFactory.class)
public interface SourceTargetMapper {
  SourceTargetMapper MAPPER = Mappers.getMapper( SourceTargetMapper.class );

  ImmutableMammalEntity.Builder toTarget(MammalDto source);
}

为了让 mapstruct 找到 Builder，我们需要一个工厂：

public class ObjectFactory {

  public ImmutableMammalDto.Builder createMammalDto() {
    return ImmutableMammalDto.builder();
  }

  public ImmutableMammalEntity.Builder createMammalEntity() {
    return ImmutableMammalEntity.builder();
  }
}

为了生成代码，编译器插件被指示使用两个注释处理器：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.6.1</version>
    <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <annotationProcessorPaths>
            <path>
                <groupId>org.immutables</groupId>
                <artifactId>value</artifactId>
                <version>2.2.8</version>
            </path>
            <path>
                <groupId>org.mapstruct</groupId>
                <artifactId>mapstruct-processor</artifactId>
                <version>1.2.0.Beta3</version>
            </path>
        </annotationProcessorPaths>
    </configuration>
</plugin>

注意：这仅适用于 mapstruct 版本 > 1.2.x。旧版本在干净构建 (mvn clean compile) 中存在问题，即他们找不到刚刚构建的不可变源。在第二次构建（没有清理）中，他们会找到不可变的实现，因为它们在注释处理器运行之前就在类路径上。此错误现已修复。

这就像一个魅力。首先生成接口的不可变实现，mapstruct 使用它们来生成构建器。

但测试显示没有设置任何属性：

@Test
public void test() {
  MammalDto s = ImmutableMammalDto.builder().numberOfLegs(4).numberOfStomachs(3l).build();
  MammalEntity t = SourceTargetMapper.MAPPER.toTarget(s).build();
    assertThat(t.getNumberOfLegs()).isEqualTo(4);
    assertThat(t.getNumberOfStomachs()).isEqualTo(3);
}

断言失败。一看 mapstruct 生成的映射器，显然没有找到任何 setter：

@Generated(
    value = "org.mapstruct.ap.MappingProcessor",
    //...
)
public class SourceTargetMapperImpl implements SourceTargetMapper {
    private final ObjectFactory objectFactory = new ObjectFactory();

    @Override
    public Builder toTarget(MammalDto source) {
        if ( source == null ) {
            return null;
        }

        Builder builder = objectFactory.createMammalEntity();
        return builder;
    }
}

返回空的构建器。我认为原因是生成的构建器的 setter 实现，因为它返回自身以创建流畅的 API：

public final Builder numberOfLegs(Long numberOfLegs) {
  this.numberOfLegs = Objects.requireNonNull(numberOfLegs, "numberOfLegs");
  return this;
}

有没有办法让 mapstruct 找到这些设置器？或者甚至是一种更好的方法来使用构建器来处理此类不可变对象？

编辑：正如我在评论中所说，我遇到了Issue #782。在 1.2.0.Beta3 版本中仍然不支持构建器。但是有几个关于这个话题的讨论，所以如果有人遇到同样的问题，关注这个问题可能会很有趣。

Answer 1

我们的项目遇到了同样的问题。 作为解决方法，我们一直在使用 Modifiable 实现我们的不可变 dto。

你也可以试试。最好直接使用构建器和对象工厂。

@Value.Modifiable 使用 setter 生成实现。

@Value.Style(create = "new") 生成 public no args 构造函数。

@Value.Immutable
@Value.Modifiable
@Value.Style(create = "new")
public interface MammalEntity {
    public Long getNumberOfLegs();
    public Long getNumberOfStomachs();
}

那么你的映射器会更简单，不需要对象工厂。

@Mapper
public interface SourceTargetMapper {

  ModifiableMammalEntity toTarget(MammalDto source);
}

在这种情况下，MapStruct 可以在 ModifiableMammalEntity 中看到 setter

这种映射器的用法看起来像

// Here you don't need to worry about implementation of MammalEntity is. The interface `MammalEntity` is immutable.
MammalEntity mammalEntity = sourceTargetMapper.toTarget(source);

Answer 2

您可以配置 Immutables 以在构建器中生成 setter：

@Value.Immutable
@Value.Style(init = "set*")
public interface MammalEntity {
    public Long getNumberOfLegs();
    public Long getNumberOfStomachs();
}

而且不需要ObjectBuilder，直接使用生成的Immutable类即可

@Mapper(uses = ImmutableMammalEntity.class)
public interface SourceTargetMapper {
    SourceTargetMapper MAPPER = Mappers.getMapper( SourceTargetMapper.class );

    ImmutableMammalEntity.Builder toTarget(MammalDto source);
}

您甚至可以在自己的注释中定义这些设置

@Value.Style(init = "set*")
public @interface SharedData {}

改为使用它

@SharedData
@Value.Immutable
public interface MammalEntity {
    public Long getNumberOfLegs();
    public Long getNumberOfStomachs();
}

Answer 3

从 1.3 开始 MapStruct 支持不可变对象。更多详情请关注here。