如何让 Jackson 使用枚举名称(而非值)序列化 Enum

梦静酱_1249

梦静酱_1249

2026-04-12

436人浏览

原创

如何让 Jackson 使用枚举名称(而非值)序列化 Enum

Jackson 默认以枚举名称字符串形式序列化 enum;若误加 @JsonFormat(shape = JsonFormat.Shape.OBJECT),会导致转为 JSON 对象格式,只需移除该注解即可恢复名称序列化。

jackson 默认以枚举名称字符串形式序列化 enum;若误加 `@jsonformat(shape = jsonformat.shape.object)`,会导致转为 json 对象格式,只需移除该注解即可恢复名称序列化。

在使用 Jackson(如 jackson-databind:2.14.2)进行 JSON 序列化时,enum 类型的默认行为是直接输出其 name()(即大写标识符)作为字符串,例如 MsgType.HEARTBEAT 序列化为 "HEARTBEAT"。这恰好符合你期望的输出格式:

{
  "msgType": "HEARTBEAT",
  "msg": "balabala....."
}

但问题中的 MsgType 枚举被错误地标注了:

@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum MsgType {
    HEARTBEAT(1, "heartbeat");
    // ...
}

⚠️ @JsonFormat(shape = JsonFormat.Shape.OBJECT) 的作用是将枚举序列化为一个 JSON 对象(需配合自定义序列化器或含字段的构造逻辑),而非字符串。即使枚举本身有参数(如 1 和 "heartbeat"),只要未显式注册 ToStringSerializer 或 EnumSerializer 的替代逻辑,Jackson 在 OBJECT 模式下会尝试将其视为 POJO —— 导致生成类似:

"msgType": {
  "nr": 1,
  "value": "heartbeat"
}

这显然偏离了你的目标。

✅ 正确做法非常简洁:完全移除 @JsonFormat(shape = JsonFormat.Shape.OBJECT)。保持枚举干净定义即可:

@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; }
}

此时,WebSocketMsg 类无需任何修改:

@Data
@NoArgsConstructor
@AllArgsConstructor
public class WebSocketMsg {
    private MsgType msgType;
    private String msg;
}

完整测试验证:

@Test
void serializeEnumByName() throws JsonProcessingException {
    WebSocketMsg resp = new WebSocketMsg(MsgType.HEARTBEAT, "balabala.....");
    ObjectMapper mapper = new ObjectMapper();
    String json = mapper.writeValueAsString(resp);

    System.out.println(json);
    // 输出:{"msgType":"HEARTBEAT","msg":"balabala....."}
}

? 补充说明:

  • 若你确实需要按 value 字符串(如 "heartbeat")序列化,可使用 @JsonValue 标注对应 getter;
  • 若需全局统一 enum 序列化策略(如全部用 name()),无需额外配置 —— 这就是 Jackson 2.12+ 的默认行为;
  • @JsonFormat(shape = JsonFormat.Shape.STRING) 是显式声明“按 name 序列化”的安全写法(等价于默认),可选添加以增强可读性与意图表达;
  • OpenAPI 的 @Schema 注解(来自 Springdoc 或 Swagger)仅影响 API 文档生成,不干预 Jackson 运行时序列化逻辑,可放心保留。

总结:删掉 @JsonFormat(shape = JsonFormat.Shape.OBJECT),Jackson 自动回归优雅简洁的枚举名称序列化 —— 简单、标准、零配置。

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

10417

6

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

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

2023.07.05

7542

9

java自学难吗
java自学难吗

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

2023.07.31

6612

8

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

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

2023.08.01

1124

3

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

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

2023.08.02

928

3

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

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

2023.08.02

1376

5

java有什么用
java有什么用

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

2023.08.02

2749

5

java在线网站
java在线网站

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

2023.08.03

20051

3

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

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

2023.08.03

1215

8

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 133.7万人学习