MapStruct 条件性映射：当源字段非空时如何设置常量值

本文探讨了mapstruct在处理字段映射时，如何在源字段非空的情况下有条件地设置目标字段为常量值。针对mapstruct默认行为（`constant`属性总是设置值）与实际需求（仅当源非空时设置常量）之间的差异，文章介绍了两种主要解决方案：利用`@qualifiedbyname`定义自定义映射方法，以及使用`expression`结合三元运算符。这两种方法各有优劣，适用于不同的场景，旨在帮助开发者选择最适合其项目需求的策略。

引言：MapStruct条件性常量映射的需求

在日常的Java对象映射中，MapStruct是一个广受欢迎的代码生成器，它能够极大地简化DTO（数据传输对象）和实体对象之间的转换。通常情况下，MapStruct会智能地处理字段映射，只有当源字段非null时才设置目标字段。然而，当我们需要将目标字段映射为一个固定常量时，例如使用@Mapping(target = "status", constant = "ACTIVE")，MapStruct的默认行为是无论源字段为何值（包括null），都会将目标字段设置为该常量。

但在某些业务场景中，我们可能需要更精细的控制：仅当特定的源字段非null时，才将目标字段设置为一个预设的常量值；如果源字段为null，则目标字段不应被设置（或保持null）。本文将介绍两种在MapStruct中实现这种条件性常量映射的策略。

方法一：利用 @QualifiedByName 实现自定义映射

原理

@QualifiedByName 允许我们引用一个带有 @Named 注解的自定义映射方法。这个自定义方法可以包含任意的Java逻辑，从而实现复杂的条件判断和值转换。通过这种方式，我们可以检查源字段是否为null，并根据结果返回我们希望的常量值或者null。如果自定义方法返回null，MapStruct通常会跳过对目标字段的设置，这正好符合我们的需求。

示例代码

假设我们有一个Source对象，其中包含一个sourceField，我们希望在将其映射到Target对象的targetField时，如果sourceField非null，则targetField被设置为"DEFAULT_STATUS"；如果sourceField为null，则targetField保持null。

import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Named;

// 假设的源对象
class Source {
    private String sourceField;
    // getter/setter
    public String getSourceField() { return sourceField; }
    public void setSourceField(String sourceField) { this.sourceField = sourceField; }
}

// 假设的目标对象
class Target {
    private String targetField;
    // getter/setter
    public String getTargetField() { return targetField; }
    public void setTargetField(String targetField) { this.targetField = targetField; }
}

@Mapper(componentModel = "spring") // 或其他组件模型
public interface MyMapper {

    @Mapping(target = "targetField", source = "sourceField", qualifiedByName = "mapTargetFieldIfNotNull")
    Target map(Source source);

    /**
     * 自定义映射方法：当源字段非空时，返回常量值；否则返回null。
     * @param sourceField 源字段的值
     * @return 如果源字段非空，返回预设常量；否则返回null。
     */
    @Named("mapTargetFieldIfNotNull")
    static String mapTargetFieldIfNotNull(String sourceField) {
        if (sourceField != null) {
            return "DEFAULT_STATUS"; // 这是你希望设置的常量
        }
        return null; // 如果源字段为null，则返回null，MapStruct不会设置目标字段
    }
}

优点

• 逻辑集中与可重用性: 映射逻辑被封装在一个独立的、具名的方法中。这使得逻辑清晰、易于理解和维护，并且可以在多个映射中重复使用相同的条件判断逻辑。
• 易于重构: 当常量值或条件判断逻辑需要修改时，只需修改一个方法即可，无需修改每个@Mapping注解。
• 可测试性: 自定义映射方法可以独立进行单元测试。

缺点

• 对于仅使用一次的简单场景，需要额外定义一个方法，代码量相对较多。

方法二：使用 expression 结合三元运算符

原理

@Mapping 注解的 expression 属性允许我们直接嵌入一段 Java 表达式来计算目标字段的值。通过结合 Java 的三元运算符 (condition ? value_if_true : value_if_false)，我们可以在注解内部实现简洁的条件判断。

示例代码

沿用上面的场景，我们希望如果sourceField非null，则targetField被设置为"DEFAULT_STATUS"；如果sourceField为null，则targetField保持null。

北极象沉浸式AI翻译

免费的北极象沉浸式AI翻译 - 带您走进沉浸式AI的双语对照体验

24

查看详情

import org.mapstruct.Mapper;
import org.mapstruct.Mapping;

// ... Source 和 Target 类定义同上 ...

@Mapper(componentModel = "spring")
public interface MyMapper {

    @Mapping(target = "targetField", 
             expression = "java(source.getSourceField() != null ? \"DEFAULT_STATUS\" : null)")
    Target map(Source source);
}

在上述示例中，expression = "java(source.getSourceField() != null ? \"DEFAULT_STATUS\" : null)" 实现了以下逻辑：如果 source.getSourceField() 不为 null，则将目标字段设置为字符串 "DEFAULT_STATUS"；否则，设置为 null。MapStruct在生成代码时，如果表达式结果为null，通常会跳过对目标字段的设置。

优点

• 简洁明了: 对于单一、简单的条件映射，代码更加紧凑，无需额外定义方法。
• 直接嵌入: 逻辑直接体现在映射定义处，一目了然。

缺点

• 可读性与复杂性: 复杂的表达式会降低@Mapping注解的可读性。
• 难以重构: 表达式直接嵌入在注解的字符串中，如果源字段名、常量值或逻辑发生变化，需要在每个使用该表达式的地方手动修改，容易出错且效率低下。
• 缺乏重用性: 相同的逻辑无法直接在其他映射中复用。

选择合适的策略

在选择上述两种方法时，应综合考虑项目的具体需求、代码的可维护性、可重用性以及简洁性：

• 何时使用 qualifiedByName:

  • 当你需要对多个字段应用相同的条件逻辑时。
  • 当条件逻辑本身比较复杂，需要更好的封装和可读性时。
  • 当常量值或判断逻辑未来可能发生变化，需要更好的重构能力时。
  • 它提供了更好的中心化控制和代码复用性。

• 何时使用 expression:

  • 当你只需要对单个字段进行一次性、非常简单的条件判断时。
  • 当你不考虑该逻辑的复用性或未来重构成本时。
  • 它能让代码更加紧凑，但牺牲了一定的可维护性。

总结

MapStruct提供了灵活的机制来处理各种复杂的映射需求。对于“当源字段非空时才设置常量值”的特定场景，@QualifiedByName和expression是两种有效的解决方案。@QualifiedByName通过引入自定义方法，提供了更好的结构化、可重用性和可维护性，适用于通用或复杂的条件。而expression则以其简洁性，适用于一次性、简单的条件。开发者应根据项目的具体上下文和长期维护成本，明智地选择最适合的策略。

以上就是MapStruct 条件性映射：当源字段非空时如何设置常量值的详细内容，更多请关注php中文网其它相关文章！