MapStruct 中将字符串映射为枚举的正确实践-java教程-PHP中文网

MapStruct 中将字符串映射为枚举的正确实践

MapStruct 默认支持 String 到 Enum 的自动映射（需名称完全匹配），无需手动编写 @ValueMapping；若需自定义映射逻辑（如字符串与枚举常量名不一致），应使用 @ValueMapping 或 @EnumMapping，并确保注解位置正确、类型匹配。

mapstruct 默认支持 string 到 enum 的自动映射（需名称完全匹配），无需手动编写 `@valuemapping`；若需自定义映射逻辑（如字符串与枚举常量名不一致），应使用 `@valuemapping` 或 `@enummapping`，并确保注解位置正确、类型匹配。

在 MapStruct 中，将 DTO 中的字符串字段映射为 Java 枚举类型（如 MyEnum）是一项常见需求。关键在于理解 MapStruct 的默认行为与显式配置的适用场景。

✅ 默认映射（推荐优先使用）

当字符串值与枚举常量名完全一致（大小写敏感）时，MapStruct 会自动完成转换，无需额外注解：

public enum MyEnum {
    ONE, TWO;
}

public class MyDTO {
    private String value; // 如："ONE"
    // getter/setter...
}

public class MyClass {
    private MyEnum value;
    // getter/setter...
}

@Mapper(componentModel = "spring")
public interface MyDTOMapper {
    MyClass toMyClass(MyDTO dto);
}

生成的实现类会自动调用 MyEnum.valueOf("ONE") —— 这正是 MapStruct 的内置能力。若传入非法字符串（如 "three"），运行时抛出 IllegalArgumentException，符合 Java 枚举语义。

⚠️ 常见错误分析

原问题中写法存在两处关键问题：

@ValueMapping 应用于 枚举类型转换方法（即 String → MyEnum），但该方法未被主映射方法调用；
source = "one-code" 是无效的源值标识（source 指输入参数名，此处应为 source = "value" 或直接省略）；
更重要的是：@ValueMapping 必须配合一个独立的转换方法，且该方法需被 MapStruct 检测到（如通过 @Named 引用或自动匹配）。

✅ 自定义映射（字符串 ≠ 枚举名）

若 DTO 字段值为 "one-code" 需映射为 MyEnum.ONE，应定义显式转换方法：

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

    @Mapping(source = "value", target = "value", qualifiedByName = "stringToMyEnum")
    MyClass toMyClass(MyDTO dto);

    @Named("stringToMyEnum")
    default MyEnum stringToMyEnum(String value) {
        if ("one-code".equalsIgnoreCase(value)) return MyEnum.ONE;
        if ("two-code".equalsIgnoreCase(value)) return MyEnum.TWO;
        throw new IllegalArgumentException("Unknown enum code: " + value);
    }
}

或使用 @ValueMapping（更声明式）：

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

    @Mapping(source = "value", target = "value")
    MyClass toMyClass(MyDTO dto);

    @ValueMapping(source = "one-code", target = "ONE")
    @ValueMapping(source = "two-code", target = "TWO")
    @ValueMapping(source = MappingConstants.NULL, target = MappingConstants.NULL)
    MyEnum stringToMyEnum(String value);
}

? 注意：@ValueMapping 方法必须是 String → MyEnum 类型，且不能是 default 方法；MapStruct 会自动识别并调用它。

? 验证示例

public static void main(String[] args) {
    MyDTOMapper mapper = Mappers.getMapper(MyDTOMapper.class);

    MyDTO dto = new MyDTO();
    dto.setValue("ONE"); // 或 "one-code"（启用自定义映射后）

    MyClass result = mapper.toMyClass(dto);
    System.out.println(result.getValue()); // 输出：ONE
}