如何利用Jackson或Gson框架优雅定制Java枚举类的JSON序列化行为

秋宇酱_9204

秋宇酱_9204

2026-07-02

731人浏览

原创

java枚举序列化可定制:jackson用@jsonvalue/@jsoncreator实现双向映射,gson用typeadapter精确控制,@jsonformat仅适用于简单别名,动态策略可通过@jsonview按场景切换。

如何利用jackson或gson框架优雅定制java枚举类的json序列化行为

Java枚举类默认序列化为名称字符串(如 STATUS_ACTIVE),但实际开发中常需输出更友好的值(如 "active")、带描述的结构(如 {"code": 1, "desc": "启用"}),或按不同场景动态适配。Jackson 和 Gson 都支持灵活定制,关键在于选对扩展点、避免全局污染、兼顾反序列化一致性。

用@JsonFormat指定简单别名(Jackson)

适用于只需将枚举名映射为固定字符串的轻量场景。通过 @JsonFormat 注解直接声明序列化后的值,无需额外类或配置。

  • 在枚举类上加 @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "active") 不生效;正确用法是配合 name 属性:
  • 给每个枚举常量添加 @JsonProperty("active"),或统一在枚举类上用 @JsonFormat(using = ...)(需自定义序列化器);最简方案是重写 toString() 并加 @JsonValue:
示例:
public enum Status {
    ACTIVE, INACTIVE;

    @JsonValue
    public String toValue() {
        return name().toLowerCase();
    }
}

序列化结果为 "active" 或 "inactive",反序列化时仍能按名称匹配。

用@JsonCreator + @JsonValue 构建双向映射(Jackson)

当枚举需携带元数据(如码值、中文描述)且要求 JSON 输入/输出结构一致时,推荐此方式。核心是让序列化走 @JsonValue 方法,反序列化走 @JsonCreator 静态工厂方法。

  • @JsonValue 标记一个实例方法,返回要序列化的值(可为对象或字符串)
  • @JsonCreator 标记一个静态方法,接收 JSON 值并返回对应枚举实例
  • 确保两者逻辑可逆:序列化输出的值,必须能被 @JsonCreator 正确还原
示例:
public enum Role {
    ADMIN(1, "管理员"),
    USER(2, "普通用户");

    private final int code;
    private final String desc;

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

    @JsonValue
    public Map<string object> toJson() {
        Map<string object> map = new HashMap();
        map.put("code", code);
        map.put("desc", desc);
        return map;
    }

    @JsonCreator
    public static Role fromJson(Map<string object> json) {
        if (json == null) return null;
        Integer code = (Integer) json.get("code");
        for (Role r : values()) {
            if (r.code == code) return r;
        }
        throw new IllegalArgumentException("Unknown role code: " + code);
    }
}</string></string></string>

序列化得 {"code":1,"desc":"管理员"},反序列化也支持该结构输入。

Gson 中用 TypeAdapter 精确控制(Gson)

Gson 没有内置注解支持复杂枚举序列化,TypeAdapter 是最可控的方式。它分离序列化与反序列化逻辑,适合需要复用、或对接外部协议的场景。

  • 继承 TypeAdapter<yourenum></yourenum>,重写 write() 和 read()
  • 注册时使用 GsonBuilder.registerTypeAdapter(YourEnum.class, new YourEnumAdapter())
  • 避免用 @SerializedName——它只改字段名,不改变枚举本身的序列化行为
示例:
public class RoleAdapter extends TypeAdapter<role> {
    @Override
    public void write(JsonWriter out, Role value) throws IOException {
        if (value == null) {
            out.nullValue();
        } else {
            out.beginObject();
            out.name("code").value(value.getCode());
            out.name("desc").value(value.getDesc());
            out.endObject();
        }
    }

    @Override
    public Role read(JsonReader in) throws IOException {
        if (in.peek() == JsonToken.NULL) {
            in.nextNull();
            return null;
        }
        in.beginObject();
        int code = 0;
        while (in.hasNext()) {
            String name = in.nextName();
            if ("code".equals(name)) {
                code = in.nextInt();
            } else {
                in.skipValue();
            }
        }
        in.endObject();
        return Role.fromCode(code);
    }
}</role>

注册后,所有 Role 字段均按此规则处理,包括嵌套对象中的字段。

按上下文动态切换序列化策略(Jackson)

同一枚举在不同 API 接口可能需不同格式(如管理后台返回完整对象,移动端只返回 code)。Jackson 支持通过 @JsonView 或自定义 SerializerProvider 实现条件化序列化。

  • 定义多个 View 类(如 public interface MobileView {}),在字段上标注 @JsonView(MobileView.class)
  • 为枚举编写多个 StdSerializer 子类,在 serialize() 中判断当前 View 并输出不同结构
  • 注册时用 SimpleModule.addSerializer(new MobileRoleSerializer()),并在配置中启用 View 支持

这种方式保持枚举类干净,把格式逻辑外移,便于测试和复用。

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

10457

6

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

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

2023.07.05

7582

9

java自学难吗
java自学难吗

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

2023.07.31

6632

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

928

3

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

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

2023.08.02

1376

5

java有什么用
java有什么用

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

2023.08.02

2749

5

java在线网站
java在线网站

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

2023.08.03

20071

3

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

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

2023.08.03

1215

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习