java枚举配合jackson定制json序列化有三种主流方式:①@jsonvalue+@jsoncreator实现单字段双向映射;②@jsonformat(shape=object)输出完整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 项目审查工作流的通用输入处理。当 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 项目中,推荐在
ObjectMapperBean 初始化时统一注册模块,而非每个 Controller 单独配置
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南










