如何配置mapstruct以在所有字段都为空时忽略映射对象

Question

环境:

• jdk：17.0.1
• 映射：1.5.1.Final

使用默认配置，我生成了以下代码

        protected AgentInfo wealthProdAccountInfoDTOToAgentInfo(WealthProdAccountInfoDTO wealthProdAccountInfoDTO) {
        if ( wealthProdAccountInfoDTO == null ) {
            return null;
        }

        String agentName = null;
        String agentIdentityType = null;
        String agentIdentityNo = null;
        String agentIdentityExpireAt = null;

        agentName = wealthProdAccountInfoDTO.getAgentName();
        agentIdentityType = wealthProdAccountInfoDTO.getAgentIdentityType();
        agentIdentityNo = wealthProdAccountInfoDTO.getAgentIdentityNo();
        agentIdentityExpireAt = wealthProdAccountInfoDTO.getAgentIdentityExpireAt();

        AgentInfo agentInfo = new AgentInfo( agentName, agentIdentityType, agentIdentityNo, agentIdentityExpireAt );

        return agentInfo;
    }

但我想在source的所有字段都为null时返回null，如下所示

    protected AgentInfo wealthProdAccountInfoDTOToAgentInfo(WealthProdAccountInfoDTO wealthProdAccountInfoDTO) {
        if ( wealthProdAccountInfoDTO == null ) {
            return null;
        }
        // add check logic
        if (agentName == null && agentIdentityType == null && agentIdentityNo == null && agentIdentityExpireAt == null) {
            return null;
        }

        String agentName = null;
        String agentIdentityType = null;
        String agentIdentityNo = null;
        String agentIdentityExpireAt = null;

        agentName = wealthProdAccountInfoDTO.getAgentName();
        agentIdentityType = wealthProdAccountInfoDTO.getAgentIdentityType();
        agentIdentityNo = wealthProdAccountInfoDTO.getAgentIdentityNo();
        agentIdentityExpireAt = wealthProdAccountInfoDTO.getAgentIdentityExpireAt();

        AgentInfo agentInfo = new AgentInfo( agentName, agentIdentityType, agentIdentityNo, agentIdentityExpireAt );

        return agentInfo;
    }

我应该如何配置它？

Answer 1

多亏了ArtemAgaev的想法，我最终考虑在这种场景中使用@AfterMapping和java反射

java prettyprint-override">    @AfterMapping
    default void cleanData(@MappingTarget AccountInfoDomain domain) {
        Optional.ofNullable(domain).ifPresent(c -> {
            if (isAllFieldNull(domain.getAgentInfo())) {
                domain.setAgentInfo(null);
            }
        });
    }

    public static boolean isAllFieldNull(Object o) {
        Object[] fieldsValue = getFieldsValue(o);
        return Optional.ofNullable(fieldsValue).map(f -> Arrays.stream(f).allMatch(Objects::isNull)).orElse(true);
    }

    public static Object[] getFieldsValue(Object obj) {
        if (null != obj) {
            final Field[] fields = getFields(obj instanceof Class ? (Class<?>) obj : obj.getClass());
            if (null != fields) {
                final Object[] values = new Object[fields.length];
                for (int i = 0; i < fields.length; i++) {
                    values[i] = getFieldValue(obj, fields[i]);
                }
                return values;
            }
        }
        return null;
    }

Answer 2

蛮力…这是一个简单的类，所以创建一个自定义映射器

@Mapper
public interface AgentInfoMapper {

    @Named("AgentInfoNullIfContentsNull")
    public static AgentInfo custom(WealthProdAccountInfoDTO dto) {
        if ( wealthProdAccountInfoDTO == null ) {
            return null;
        }
        if (agentName == null && agentIdentityType == null && agentIdentityNo == null && agentIdentityExpireAt == null) {
            return null;
        }
        // mapping code
    }
}

https://www.baeldung.com/mapstruct-custom-mapper

Answer 3

不幸的是，你的问题没有干净的解决方案，除了自己实现空检查的代码，Marc指定了正确的方法来解决你的问题(我个人会同意，或者出于同样的目的使用默认方法)。

我可以添加一些变通方法，仅当映射目标是内部对象时才有效：

>

使用@BeforeMap将输入内部对象设置为null，因此当出现null-check时将跳过它

    @BeforeMapping
default void clearData(TestB source, @MappingTarget TestA target) {
    TestD innerD = source.getInnerD();
    if (innerD.getSecond() == null && innerD.getFirst() == null) {
        source.setInnerD(null);
    }
}

它将生成以下代码:

    @Override
public TestA from(TestB input) {
    ....

    clearData( input, testA ); //set input field to null
    testA.setInnerC( fromInner( input.getInnerD() ) );

    ....
}

@Override
public TestC fromInner(TestD input) {
    if ( input == null ) { //skip because of null
        return null;
    }
    ....
}

使用@AfterMapper将输出参数设置为null（它将首先被映射，因此会有一些开销）

@AfterMapping
default void clearData(TestB source, @MappingTarget TestA target) {
    TestD innerD = source.getInnerD();
    if (innerD.getSecond() == null && innerD.getFirst() == null) {
        target.setInnerC(null);
    }
}

并且生成的代码将是：

    @Override
public TestA from(TestB input) {
    ....

    testA.setInnerC( fromInner( input.getInnerD() ) ); //field is actually mapped but cleared later
    clearData( input, testA );

    return testA;
}

正如我所说，这些解决方案并不是真正干净的，应该只被视为变通方法。这些变通方法的优点是您将继续使用自动生成的代码，并且这些黑客将隐藏在该代码中。

UPD最近偶然发现了< code>@DecoratedWith，它也可以做到这一点。https://map struct . org/documentation/stable/reference/html/# _ customizing _ mappings

只需为iterable2iterable映射方法实现装饰器：List