讲师中心 微信公众号
AI工具推荐 视频效率加速

Java 怎么为枚举编写自定义的 JSON 序列化反序列化规则

小丽大大_4445

小丽大大_4445

发布时间:2026-09-05 14:36:59

|

270人浏览过

|

来源于php中文网

原创

在Java中为枚举定制JSON序列化与反序列化,推荐使用@JsonValue和@JsonCreator注解:@JsonValue标记返回code的方法用于序列化,@JsonCreator标记根据code查找枚举实例的静态工厂方法,实现简洁双向转换。

java 怎么为枚举编写自定义的 json 序列化反序列化规则

在 Java 中,为枚举编写自定义 JSON 序列化与反序列化规则,核心是让 Jackson(最常用的 JSON 库)跳过默认行为(如直接序列化为 name 字符串),转而按你定义的逻辑处理——比如序列化为某个字段值(如 code)、反序列化时根据 code 查找对应枚举实例。

使用 @JsonValue + @JsonCreator 实现双向定制

这是最简洁、推荐的方式,适用于大多数场景。只需在枚举中添加两个注解:

  • @JsonValue:标记一个方法,表示序列化时该方法的返回值作为 JSON 输出内容;
  • @JsonCreator:标记一个静态工厂方法,用于从 JSON 值(如字符串或数字)构造枚举实例。

示例:

public enum Status {
    SUCCESS(1, "操作成功"),
    FAILED(0, "操作失败");
<pre class="brush:php;toolbar:false;">private final int code;
private final String message;

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

@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 status code: " + code);
}

}

立即学习“Java免费学习笔记(深入)”;

这样,Status.SUCCESS 序列化为 1,反序列化 1 也能正确还原为 Status.SUCCESS。

Json Schema Toolkit
Json Schema Toolkit

使用 JSON Schema 验证 JSON 数据,从示例 JSON 生成 schema,并将其转换为 TypeScript 接口、Python 数据类或 Markdown 文档。

下载

用 @JsonProperty 配合私有字段(仅限 Jackson 2.12+)

如果希望 JSON 中保留多个字段(如 {"code":1,"message":"操作成功"}),可将枚举视为“类”来处理。需配合 @JsonFormat(shape = JsonFormat.Shape.OBJECT):

  • 加 @JsonFormat(shape = JsonFormat.Shape.OBJECT) 到枚举类上;
  • 为每个需要暴露的字段添加 @JsonProperty 的 getter;
  • 提供带参数的 @JsonCreator 构造器或静态工厂方法。

注意:此时反序列化必须传入 JSON 对象,不能是纯数字或字符串。

全局注册自定义序列化器/反序列化器(适合复用或复杂逻辑)

当逻辑较重(如依赖 Spring Bean、需查数据库、或统一处理多枚举)时,可编写专用的 JsonSerializer 和 JsonDeserializer,再注册到 ObjectMapper:

  • 继承 StdSerializer<yourenum></yourenum> 实现序列化逻辑;
  • 继承 StdDeserializer<yourenum></yourenum> 实现反序列化逻辑;
  • 通过 SimpleModule 注册,并加入 ObjectMapper。

这种方式灵活但略重,适合框架级封装或跨项目复用。

Spring Boot 中的配置建议

若用 Spring Boot,默认的 ObjectMapper 可通过 @Bean 自定义:

@Bean
public ObjectMapper objectMapper() {
    ObjectMapper mapper = new ObjectMapper();
    SimpleModule module = new SimpleModule();
    module.addSerializer(Status.class, new StatusSerializer());
    module.addDeserializer(Status.class, new StatusDeserializer());
    mapper.registerModule(module);
    return mapper;
}

也可用 @JsonComponent 更简洁地声明序列化组件(Spring Boot 1.4+ 支持),Jackson 会自动扫描并注册。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

相关专题

更多
java
java

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

9477

2023.06.15

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

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

6642

2023.07.05

java自学难吗
java自学难吗

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

5892

2023.07.31

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

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

1044

2023.08.01

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

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

868

2023.08.02

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

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

1236

2023.08.02

java有什么用
java有什么用

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

2489

2023.08.02

java在线网站
java在线网站

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

19831

2023.08.03

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

0

2026.09.30

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn