Java中 枚举类怎么在 Jackson 序列化中用 @JsonValue 指定输出字段

星萱同学_7100

星萱同学_7100

2026-07-21

492人浏览

原创

在jackson中,@jsonvalue必须标注在唯一一个无参、非静态、有返回值的公共方法上,用于序列化时输出指定字段值;若需反序列化,须配合@jsoncreator静态工厂方法。

java中 枚举类怎么在 jackson 序列化中用 @jsonvalue 指定输出字段

在 Jackson 中,给枚举类加 @JsonValue 是让序列化时只输出某个具体字段值(比如字符串或数字),而不是默认的枚举名(name())。

必须定义一个非静态、非 void、有返回值的 getter 方法

@JsonValue 不能直接标在字段上,只能标在**一个公共的、无参的、有返回值的方法**上。Jackson 会调用这个方法获取要序列化的值。

例如:

public enum Status {
    ACTIVE("启用"),
    INACTIVE("停用");

    private final String desc;

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

    @JsonValue
    public String getDesc() {
        return desc;
    }
}

这样,序列化 Status.ACTIVE 就会输出 "启用",而不是 "ACTIVE"。

注意:该方法不能有参数,且整个枚举中只能有一个 @JsonValue 方法

如果误加了参数,比如 getDesc(String prefix),Jackson 会忽略它,回退到默认的 name();如果多个方法都加了 @JsonValue,Jackson 会抛异常(JsonMappingException)。

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

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

下载

常见错误写法:

  • @JsonValue public String desc; ❌ 字段不支持
  • @JsonValue public String getValue(int flag) ❌ 有参数
  • 两个不同方法都加 @JsonValue ❌ 冲突

配合 @JsonCreator 可实现反序列化双向一致

仅加 @JsonValue 只控制序列化。如果还希望 JSON 字符串(如 "启用")能正确反序列化成对应枚举,需搭配 @JsonCreator 和一个静态工厂方法:

public enum Status {
    ACTIVE("启用"),
    INACTIVE("停用");

    private final String desc;

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

    @JsonValue
    public String getDesc() {
        return desc;
    }

    @JsonCreator
    public static Status fromDesc(String desc) {
        for (Status s : Status.values()) {
            if (s.desc.equals(desc)) {
                return s;
            }
        }
        throw new IllegalArgumentException("Unknown status: " + desc);
    }
}

这样 mapper.readValue("\"启用\"", Status.class) 才能成功转成 Status.ACTIVE。

替代方案:用 @JsonProperty 配合枚举字段名(不推荐用于自定义值)

@JsonProperty 在枚举里通常用于标注常量名(如把 ACTIVE 序列化为 "active"),但它不适用于动态字段值;真要输出描述性内容,@JsonValue + getter 是标准做法。

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

相关专题

更多
java
java

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

2023.06.15

9617

6

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

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

2023.07.05

6762

9

java自学难吗
java自学难吗

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

2023.07.31

5992

8

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

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

2023.08.01

1044

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

1276

5

java有什么用
java有什么用

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

2023.08.02

2529

5

java在线网站
java在线网站

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

2023.08.03

19851

3

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

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

2023.08.03

1135

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习