Java 中枚举怎么配合 JSON 序列化框架转换

梦明大大_8766

梦明大大_8766

2026-08-09

497人浏览

原创

java枚举与json序列化框架配合需控制双向转换:jackson用@jsonvalue和@jsoncreator定制code字段,gson需typeadapter实现;策略上name语义清晰但兼容性弱,code更稳定,多字段建议对象格式,并注意反序列化安全兜底。

java 中枚举怎么配合 json 序列化框架转换

Java 枚举与 JSON 序列化框架配合使用时,核心在于控制序列化方向(枚举 → JSON)和反序列化方向(JSON → 枚举),不同框架默认行为不同,需根据实际需求显式配置。

Jackson:用 @JsonValue 和 @JsonCreator 精确控制

Jackson 默认将枚举序列化为名称(name()),反序列化也依赖名称匹配。若需转为自定义字段(如 code 或 description),推荐组合使用 @JsonValue 和 @JsonCreator:

  • @JsonValue 标在 getter 上,指定序列化输出值(例如返回 code 字段)
  • @JsonCreator 标在静态工厂方法上,接收 JSON 值并构造对应枚举实例
  • 注意:该工厂方法参数类型必须与 @JsonValue 返回类型一致,且方法需声明为 static

示例:

public enum Status {
    SUCCESS(200, "操作成功"),
    ERROR(500, "系统错误");

    private final int code;
    private final String desc;

    Status(int code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    @JsonValue
    public int getCode() { return code; }

    @JsonCreator
    public static Status fromCode(int code) {
        for (Status s : Status.values()) {
            if (s.code == code) return s;
        }
        throw new IllegalArgumentException("Unknown code: " + code);
    }
}

Gson:靠 TypeAdapter 实现双向定制

Gson 默认也序列化为 name,但不支持注解驱动的自动映射。要实现 code/desc 转换,需编写 TypeAdapter 并注册:

Feishu calendar sync, local ics to json data for AI agent
Feishu calendar sync, local ics to json data for AI agent

将ICS日历文件转为JSON格式,用于飞书日历导入导出及数据集成。

下载
  • 重写 write() 方法,输出自定义字段(如 out.value(status.getCode()))
  • 重写 read() 方法,从 JSON 数值或字符串解析后匹配枚举实例
  • 注册方式:构建 GsonBuilder 时调用 registerTypeAdapter(Status.class, new StatusAdapter())

优点是完全可控;缺点是每个枚举都要手动适配,适合统一规范场景。

序列化策略选择建议

是否暴露枚举内部结构,影响 API 兼容性和可读性:

  • 用 name()(默认):语义清晰、调试友好,但名称变更即破坏兼容
  • 用 code(整型/字符串常量):更稳定,适合状态码类枚举,但需确保 code 唯一且不重复
  • 用 description 或多字段对象:需序列化为 JSON 对象(如 {"code":200,"desc":"成功"}),此时建议搭配 @JsonFormat(shape = JsonFormat.Shape.OBJECT)(Jackson)或自定义 Adapter(Gson)

注意反序列化安全边界

无论用哪种框架,反序列化未知值都可能抛异常(如 IllegalArgumentException 或 JsonParseException)。生产环境建议:

  • 在 @JsonCreator 或 TypeAdapter.read() 中提供兜底逻辑(如返回 UNKNOWN 枚举项)
  • 避免直接抛 unchecked exception,可包装为业务异常或返回 Optional
  • 对前端传入的枚举字段做校验层拦截(如 Spring 的 @Valid + 自定义 ConstraintValidator)

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

10177

6

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

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

2023.07.05

7322

9

java自学难吗
java自学难吗

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

2023.07.31

6432

8

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

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

2023.08.01

1104

3

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

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

2023.08.02

908

3

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

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

2023.08.02

1336

5

java有什么用
java有什么用

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

2023.08.02

2689

5

java在线网站
java在线网站

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

2023.08.03

20011

3

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

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

2023.08.03

1195

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习