Java中 枚举类怎么在 JSON 序列化时将 Name 和 Code 同时输出

秋瑶姑娘_6378

秋瑶姑娘_6378

2026-07-23

486人浏览

原创

java枚举json序列化默认只输出name(),要同时输出名称和编码需自定义逻辑:一是为枚举添加带public getter的字段;二是用@jsonserialize实现stdserializer手动控制结构;三是避免write_enums_using_to_string等无效配置。

java中 枚举类怎么在 json 序列化时将 name 和 code 同时输出

Java 枚举类在 JSON 序列化时默认只输出 name()(即枚举常量名),若想同时输出名称(Name)和编码(Code),需自定义序列化逻辑,核心是让 Jackson 能识别并序列化你希望暴露的字段。

为枚举添加可序列化的字段和 getter

定义枚举时,显式声明业务字段(如 code、desc),并提供公共 getter 方法。Jackson 默认会序列化所有 public getter 返回的值(前提是开启相应配置)。

  • 确保字段有对应的 public getter(如 getCode()、getDesc())
  • 避免使用 private getter 或未遵循 JavaBean 命名规范的方法(如 getCODE())
  • 不要依赖 toString() 或 name() 自动映射——它们不会被自动包含

用 @JsonFormat 配合自定义序列化器(推荐)

若需完全控制输出结构(例如固定为 {"name":"XXX","code":123}),建议实现 JsonSerializer 并通过 @JsonSerialize 注解绑定。

javascript-pro
javascript-pro

专注现代 ECMAScript、异步编程、性能优化和全栈的 JavaScript 专家,适用于现代开发

下载
  • 编写一个继承 StdSerializer<yourenum></yourenum> 的序列化器,在 serialize() 中手动写入 name 和 code 字段
  • 在枚举类上加 @JsonSerialize(using = YourEnumSerializer.class)
  • 这样能彻底避免字段命名歧义,也兼容复杂逻辑(如动态 desc、国际化等)

启用 WRITE_ENUMS_USING_TO_STRING 或 WRITE_ENUMS_USING_INDEX(不推荐)

这两个 Jackson 配置仅影响枚举整体输出形式(字符串 or 序号),无法实现“同时输出 name + code”的结构化 JSON,因此不适用该需求。

  • WRITE_ENUMS_USING_TO_STRING:调用 toString(),需重写它返回 JSON 字符串(不安全且难维护)
  • WRITE_ENUMS_USING_INDEX:只输出序号,与目标无关

配合 @JsonValue 实现单字段定制(有限场景可用)

若只需把某个字段(如 code)作为主值序列化,同时保留 name 可读性,可在 getter 上加 @JsonValue。但注意:一个类只能有一个 @JsonValue 方法,所以无法同时标记两个字段。

  • 例如在 getCode() 上加 @JsonValue,则序列化结果仅为 123(纯数字),丢失 name
  • 若想结构化输出,必须放弃 @JsonValue,改用自定义序列化器或带 getter 的 POJO 风格枚举

不复杂但容易忽略:Jackson 对枚举的默认行为很保守,必须主动“告诉”它哪些字段要序列化——要么靠标准 getter + 默认配置,要么靠自定义序列化器精准控制。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

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

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

下载

相关标签:

java js json

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

相关专题

更多
java
java

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

2023.06.15

9417

6

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

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

2023.07.05

6582

9

java自学难吗
java自学难吗

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

2023.07.31

5852

8

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

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

2023.08.01

1024

3

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

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

2023.08.02

868

3

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

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

2023.08.02

1236

5

java有什么用
java有什么用

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

2023.08.02

2469

5

java在线网站
java在线网站

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

2023.08.03

19811

3

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

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

2023.08.03

1115

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习