MapStruct 中将字符串映射为枚举的正确实现方法

夜磊大大_5491

夜磊大大_5491

2026-08-08

406人浏览

原创

MapStruct 中将字符串映射为枚举的正确实现方法

MapStruct 默认支持字符串到枚举的自动映射(区分大小写、按名称匹配),无需手动编写 @ValueMapping,只需确保源字符串与枚举常量名完全一致即可。

mapstruct 默认支持字符串到枚举的自动映射(区分大小写、按名称匹配),无需手动编写 `@valuemapping`,只需确保源字符串与枚举常量名完全一致即可。

在使用 MapStruct 将 DTO 中的 String 字段映射为 Java 枚举时,许多开发者误以为必须显式声明 @ValueMapping,但实际上 MapStruct 提供了开箱即用的枚举名称自动解析机制:只要源字符串的值与目标枚举常量的 name() 完全相同(严格区分大小写),MapStruct 会自动完成转换。

✅ 正确做法如下:

  1. 定义枚举(保持标准命名):

    public enum MyEnum {
     ONE, TWO;
    }
  2. 定义 DTO 和目标类(字段名建议一致,便于自动映射):

    public class MyDTO {
     private String value;
     // getter/setter
    }

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

3. **声明 Mapper 接口**(启用 Spring 组件模型,便于注入):
```java
@Mapper(componentModel = "spring")
public interface MyDTOMapper {
    MyClass toMyClass(MyDTO dto);
}

⚠️ 注意:无需 @Mapping 注解——当 MyDTO.value(String)与 MyClass.value(MyEnum)字段名相同且类型可匹配时,MapStruct 会自动应用内置的 String → Enum 转换器。

  1. 使用示例:
    MyDTOMapper mapper = Mappers.getMapper(MyDTOMapper.class);
    MyDTO dto = new MyDTO();
    dto.setValue("ONE"); // 必须是 "ONE",而非 "one-code" 或 "one"
    MyClass result = mapper.toMyClass(dto);
    System.out.println(result.getValue()); // 输出:ONE

❌ 常见错误排查:

  • 字符串值不匹配枚举常量名(如传 "one" → MyEnum.ONE 失败,因 ONE.name() 是 "ONE");
  • 未启用 componentModel = "spring"(若需 Spring 管理 Bean);
  • 错误使用 @ValueMapping 绑定自定义字符串(如 "one-code" → ONE),此时才需显式配置——但应改用 @ValueMapping(source = "one-code", target = "ONE") 并配合 String 到 MyEnum 的专用方法,而非放在主映射方法中。

? 进阶提示:如需支持别名映射(如 "one-code" → MyEnum.ONE),应单独定义转换方法并标注 @Named,再通过 qualifiedByName 引用:

@Mapper(componentModel = "spring")
public interface MyDTOMapper {
    @Mapping(source = "value", target = "value", qualifiedByName = "stringToMyEnum")
    MyClass toMyClass(MyDTO dto);

    @Named("stringToMyEnum")
    default MyEnum stringToMyEnum(String value) {
        return switch (value) {
            case "one-code" -> MyEnum.ONE;
            case "two-code" -> MyEnum.TWO;
            default -> null; // 或抛异常
        };
    }
}

总之,优先利用 MapStruct 的默认行为;仅在业务需要非标准字符串映射时,再引入定制逻辑——简洁、安全、可维护。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1638

5

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2464

5

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

2023.10.24

5924

49

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

2023.11.24

5249

6

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

2024.03.22

6954

16

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

2024.04.29

9734

11

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

2025.07.29

4959

17

c++字符串相关教程
c++字符串相关教程

本专题整合了c++字符串相关教程,阅读专题下面的文章了解更多详细内容。

2025.08.07

5247

13

常用字符串方法大全
常用字符串方法大全

常用字符串方法大全

2025.08.08

2708

14

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习