如何创建或增强使用 mapstruct 的自定义注释

Question

Mapsturct 具有带有预定义属性的 @Mapping 注解 例如：@Mapping(source="", target="", qualifiedByName="")，如果我想添加另一个属性并使用它来计算逻辑怎么办

例如：@Mapping(source="", target="", qualifiedByName="" , version="")

我想将版本号传递给它，根据版本，它会从源设置目标。

我尝试创建自定义注释并在其中使用@Mapping，但没有帮助

@CustomMapping(version = "1.0", mapping = @Mapping(source = "", target = "", qualifiedByName=""))

Answer 1

您为什么不直接定义第二个不同的注释以与@Mapping 一起使用？

@Mapping(source="", target="", qualifiedByName="")
@MappingVersion("1.0")
CarDto carToCarDto(Car car);

如果您担心在使用 @Mapping 时想要某种强制执行该版本始终存在，那么您可以很简单地使用 write an annotation processor，它在编译时执行此操作。

Answer 2

根据问题中的 cmets，我对需要做的事情有了更多的了解。基本上根据一些输入参数需要创建不同的映射方法。

不确定您的逻辑有多复杂。但是，您可以做的是创建自己的注释处理器，以便能够创建 MapStruct 映射器。

假设你有

@CustomMapper
public interface MyMapper {
    @CustomMapping(version = "1.0", mappings = { 
        @Mapping(source = "numberOfSeats", target = "seatCount", qualifiedByName="")
    })
    @CustomMapping(version = "2.0", mappings = { 
        @Mapping(source = "numberOfSeats", target = "seats", qualifiedByName="")
    })
    CarDto map(Car car, String version);
}

所以你的注释处理器需要处理CustomMapper。

处理器还会生成不同的 MapStruct 版本接口。

所以：

@Mapper
public interface MyMapperV1 {

    @Mapping(source = "numberOfSeats", target = "seatCount", qualifiedByName="")
    CarDto map(Car car)
}

@Mapper
public interface MyMapperV2 {

    @Mapping(source = "numberOfSeats", target = "seats", qualifiedByName="")
    CarDto map(Car car)
}

另外还有一个MyMapper 的实现。看起来像：

public class MyMapperImpl {

    protected MyMapperV1 myMapperV1 = Mappers.getMapper(MyMapperV1.class):
    protected MyMapperV2 myMapperV2 = Mappers.getMapper(MyMapperV2.class):

    public CarDto map(Car car, String version) {
        if ("1.0".equals(version)) {
            return myMapperV1.map(car);
        } else {
            return myMapperV2.map(car);
        }
    }
}

基本上，目标是让您的处理器生成 MapStruct 在同一编译轮次中获取的接口。这可以通过注释处理实现。

另一种选择是自己编写 MapStruct 映射器，并在调用者位置选择适合该版本的映射器。这实际上可能更简单。