Java中 枚举类怎么在 Jackson 反序列化中用 @JsonCreator 映射字段

云伟大大_8421

云伟大大_8421

2026-07-22

856人浏览

原创

@jsoncreator的核心作用是显式指定jackson将json字符串或对象转换为枚举实例的静态工厂方法或构造器,解决默认仅支持枚举name()匹配的局限;当json值为小写字符串、自定义code或嵌套对象时,必须通过@jsoncreator标注的方法按code、desc等属性精确查找已有枚举实例。

java中 枚举类怎么在 jackson 反序列化中用 @jsoncreator 映射字段

Java 枚举类在 Jackson 反序列化中使用 @JsonCreator,核心是让 Jackson 知道:**该用哪个构造方法(或静态工厂方法)来把 JSON 字符串/对象转成枚举实例**,尤其当枚举字段不是简单的名字(name),而是自定义属性(如 code、desc)时。

为什么需要 @JsonCreator?

默认情况下,Jackson 只认枚举的 name()(即大写常量名)。比如:{"status": "ACTIVE"} 能自动映射到 Status.ACTIVE。但若 JSON 是 {"status": "active"} 或 {"status": {"code": "A", "desc": "启用"}},就必须显式告诉 Jackson 怎么解析——@JsonCreator 就是用来标记这个“创建入口”的。

单参数字符串反序列化(最常用)

适用于 JSON 中字段值为字符串,需按自定义字段(如 code)匹配枚举:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
public enum Status {
    ACTIVE("A", "启用"),
    INACTIVE("I", "停用");

    private final String code;
    private final String desc;

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

    // ✅ 标记静态工厂方法,Jackson 会传入 JSON 字符串(如 "A")
    @JsonCreator
    public static Status fromCode(String code) {
        for (Status s : Status.values()) {
            if (s.code.equals(code)) {
                return s;
            }
        }
        throw new IllegalArgumentException("Unknown code: " + code);
    }

    public String getCode() { return code; }
}

此时 JSON {"status": "A"} 就能正确反序列化为 Status.ACTIVE。

多参数反序列化(JSON 对象形式)

当 JSON 字段本身是对象(如 {"status": {"code": "A", "desc": "启用"}}),需配合 @JsonProperty 指定参数名:

public enum Role {
    ADMIN("001", "系统管理员"),
    USER("002", "普通用户");

    private final String code;
    private final String name;

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

    // ✅ 标记带 @JsonProperty 的构造方法
    @JsonCreator
    public Role(
            @JsonProperty("code") String code,
            @JsonProperty("name") String name) {
        // 注意:这里不能直接赋值给 enum field(final),需查表
        // 所以更推荐用静态工厂方式(见下一条)
        throw new UnsupportedOperationException("Use fromCodeAndName instead");
    }

    @JsonCreator
    public static Role fromCodeAndName(
            @JsonProperty("code") String code,
            @JsonProperty("name") String name) {
        for (Role r : Role.values()) {
            if (r.code.equals(code) && r.name.equals(name)) {
                return r;
            }
        }
        return null;
    }
}

关键细节和建议

  • 必须是 static 方法或私有构造器:Jackson 调用时不依赖已有实例,所以 @JsonCreator 方法必须是 static(推荐)或私有构造器(不推荐,因 enum 构造器隐式私有且不能重载用于反序列化)
  • 方法名任意,但参数要对齐:参数数量、类型、@JsonProperty 名称需与 JSON 结构一致;单字符串参数默认匹配整个 JSON 值
  • 务必处理未匹配情况:抛出 IllegalArgumentException 或返回默认值(如 UNKNOWN),否则 Jackson 会报 InvalidFormatException
  • 避免在 @JsonCreator 中直接 new 枚举实例:enum 实例只能由 JVM 在类加载时创建,运行时不能 new,所以必须通过 values() 查找已存在实例

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

9897

6

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

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

2023.07.05

7042

9

java自学难吗
java自学难吗

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

2023.07.31

6212

8

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

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

2023.08.01

1084

3

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

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

2023.08.02

888

3

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

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

2023.08.02

1296

5

java有什么用
java有什么用

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

2023.08.02

2589

5

java在线网站
java在线网站

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

2023.08.03

19931

3

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

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

2023.08.03

1155

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习