如何让 Jackson 使用枚举名称(name)而非值(value)进行序列化

梦静酱_1249

梦静酱_1249

2026-04-12

365人浏览

原创

如何让 Jackson 使用枚举名称(name)而非值(value)进行序列化

Jackson 默认将枚举序列化为 name() 字符串;若误加 @JsonFormat(shape = JsonFormat.Shape.OBJECT),则会转为 JSON 对象形式,需移除该注解并确保无其他干扰配置,即可输出如 "msgType": "HEARTBEAT" 的简洁字符串格式。

jackon 默认将枚举序列化为 `name()` 字符串;若误加 `@jsonformat(shape = jsonformat.shape.object)`,则会转为 json 对象形式,需移除该注解并确保无其他干扰配置,即可输出如 `"msgtype": "heartbeat"` 的简洁字符串格式。

在使用 Jackson 进行 JSON 序列化时,枚举类型的默认行为是调用其 name() 方法(即大写常量名),生成字符串形式的 JSON 字段值。例如,MsgType.HEARTBEAT 会被序列化为 "HEARTBEAT" —— 这正是你期望的结果。

但问题中的 @JsonFormat(shape = JsonFormat.Shape.OBJECT) 注解会强制 Jackson 将枚举视为普通 Java 对象,结合其字段(如 nr 和 value)生成嵌套 JSON 对象,导致输出不符合预期:

{
  "msgType": {
    "nr": 1,
    "value": "heartbeat"
  },
  "msg": "test-msg"
}

✅ 正确做法:移除 @JsonFormat(shape = JsonFormat.Shape.OBJECT)
该注解仅在你需要自定义枚举的「对象式」序列化(如含多个属性的完整结构)时才启用。对于纯名称字符串输出,它不仅不必要,而且是根本性冲突源。

修正后的 MsgType 定义应简化为:

@Schema(implementation = MsgType.class) // OpenAPI 文档用途,不影响 Jackson 序列化
public enum MsgType {
    HEARTBEAT(1, "heartbeat");

    private final int nr;
    private final String value;

    MsgType(int nr, String value) {
        this.nr = nr;
        this.value = value;
    }

    // 可选:添加 getter 供反序列化或业务使用(非必需)
    public int getNr() { return nr; }
    public String getValue() { return value; }
}

此时,无需额外配置,ObjectMapper 即可按名称序列化:

WebSocketMsg resp = new WebSocketMsg(MsgType.HEARTBEAT, "balabala.....");
ObjectMapper objectMapper = new ObjectMapper();
String resultJson = objectMapper.writeValueAsString(resp);
// 输出:{"msgType":"HEARTBEAT","msg":"balabala....."}

⚠️ 注意事项:

  • 若项目中全局配置了 SerializationFeature.WRITE_ENUMS_USING_TO_STRING 或 DeserializationFeature.READ_ENUMS_USING_TO_STRING,可能覆盖默认行为,请检查 ObjectMapper 配置;
  • 如需对特定枚举统一使用 toString()(而非 name()),可添加 @JsonValue 到对应方法上,但本例中不推荐 —— name() 更符合语义且可逆;
  • @Schema 来自 Springdoc/OpenAPI,仅用于 API 文档生成,不影响 Jackson 序列化逻辑,可安全保留。

总结:Jackson 枚举序列化的黄金法则——不加 @JsonFormat(shape = OBJECT),就默认用 name();加了,就变成对象。 精准控制的关键,在于理解注解意图并按需取舍。

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

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

下载

相关标签:

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

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10617

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7742

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6752

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1144

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

948

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1396

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2789

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20111

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1235

8

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 133.7万人学习