Java 中枚举类怎么配合 Jackson 实现 JSON 序列化定制

浅芳姑娘_9064

浅芳姑娘_9064

2026-08-26

578人浏览

原创

java枚举配合jackson定制json序列化有三种主流方式:①@jsonvalue+@jsoncreator实现单字段双向映射;②@jsonformat(shape=object)输出完整json对象;③实现统一接口+自定义泛型序列化器以复用逻辑。

java 中枚举类怎么配合 jackson 实现 json 序列化定制

Java 枚举配合 Jackson 做 JSON 序列化定制,关键在于控制“输出什么”和“怎么还原”。默认情况下,Jackson 只输出枚举名(如 ACTIVE),但业务中往往需要输出 code、描述、或完整对象结构。下面几种方式覆盖主流需求,按使用频率和适用场景组织。

@JsonValue + @JsonCreator:单字段双向映射

适合希望序列化为简单值(如字符串或数字)、且反序列化时也按该值匹配的场景,比如状态码、类型标识。

  • @JsonValue 必须标在无参、非静态、有返回值的 public 方法上,例如 getCode() 或 getDesc();不能标在字段或带参数的方法上
  • 反序列化需配套 @JsonCreator + 静态工厂方法,参数类型必须与 @JsonValue 方法返回类型一致
  • 整个枚举类中只能有一个 @JsonValue 方法,否则报错

示例:

public enum OrderStatus {
    PENDING(1, "待处理"),
    COMPLETED(2, "已完成");

    private final int code;
    private final String desc;

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

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

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

序列化 OrderStatus.PENDING → 1;反序列化 1 → 正确还原为 PENDING。

@JsonFormat(shape = JsonFormat.Shape.OBJECT):输出完整 JSON 对象

适合前端需要同时拿到 code 和文本描述等多字段信息的场景,无需额外写序列化器,简洁通用。

Java Maven Common
Java Maven Common

Java Maven 项目审查工作流的通用输入处理。当 Java Maven 项目以 ZIP压缩包或 GitLab 仓库 URL 形式提供且需要...时使用。

下载
  • 加在枚举类上,Jackson 会自动把每个枚举常量序列化为一个 JSON 对象,字段为其所有 public getter 的返回值
  • 要求枚举有标准 getter(如 getCode()、getName()),且方法名符合 JavaBean 规范
  • 反序列化时,Jackson 默认按字段名+值匹配,例如 {"code":1,"name":"待处理"} 能还原成功

示例:

@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum PaymentMethod {
    ALIPAY(1, "支付宝"),
    WECHAT(2, "微信支付");

    private final int code;
    private final String name;

    PaymentMethod(int code, String name) {
        this.code = code;
        this.name = name;
    }

    public int getCode() { return code; }
    public String getName() { return name; }
}

序列化 ALIPAY → {"code":1,"name":"支付宝"}。

实现统一接口 + 自定义序列化器:灵活复用多枚举

适合项目中大量枚举都遵循相同结构(如都有 code() 和 desc()),希望一套逻辑通配所有枚举的场景。

  • 先定义公共接口(如 BaseEnum 或 ValueEnum),所有枚举实现它
  • 编写泛型序列化器继承 JsonSerializer<t extends baseenum></t>,统一输出字段
  • 注册到 ObjectMapper:通过 SimpleModule.addSerializer(BaseEnum.class, new XxxSerializer())
  • 反序列化可用 @JsonCreator 在各枚举内分别实现,或统一写反序列化器

优点是解耦、可维护性强;缺点是配置稍重,适合中大型项目。

注意事项与兜底建议

实际使用中容易忽略但影响稳定性的点:

  • 反序列化失败默认抛 JsonMappingException,建议全局配置 DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES = false 并结合 @JsonCreator 内做容错(如返回默认值或抛业务异常)
  • 避免在枚举中暴露 setter 或可变状态,保证线程安全与不可变语义
  • 若枚举字段含敏感信息(如内部编码),注意是否需配合 @JsonIgnore 过滤
  • Spring Boot 项目中,推荐在 ObjectMapper Bean 初始化时统一注册模块,而非每个 Controller 单独配置

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

相关专题

更多
java
java

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

2023.06.15

10677

6

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

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

2023.07.05

7802

9

java自学难吗
java自学难吗

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

2023.07.31

6792

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

2809

5

java在线网站
java在线网站

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

2023.08.03

20111

3

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

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

2023.08.03

1235

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习