如何在 Spring Boot 中实现 JSON 枚举值的大小写不敏感反序列化

冬芳君_7463

冬芳君_7463

2026-08-15

570人浏览

原创

如何在 Spring Boot 中实现 JSON 枚举值的大小写不敏感反序列化

本文介绍在 Spring Boot 项目中,当第三方 API 返回的 JSON 枚举字段(如 "addressType": "Mailing")与 Java 枚举常量(如 MAILING)大小写不匹配时,通过 Jackson 自定义反序列化器实现自动转换的完整方案。

本文介绍在 spring boot 项目中,当第三方 api 返回的 json 枚举字段(如 `"addresstype": "mailing"`)与 java 枚举常量(如 `mailing`)大小写不匹配时,通过 jackson 自定义反序列化器实现自动转换的完整方案。

在 Spring Boot 应用中,使用 RestTemplate 或 WebClient 调用外部 REST 接口并反序列化 JSON 响应时,若目标字段为 Java 枚举类型(如 AddressType),Jackson 默认要求 JSON 字符串必须严格匹配枚举常量名(全大写、下划线分隔)。而现实中,第三方服务常返回首字母大写(如 "Mailing")、驼峰(如 "mailingAddress")甚至混合大小写格式,直接映射会导致 InvalidFormatException 异常。

最简洁、可复用且符合 Jackson 最佳实践的解决方案是:编写自定义枚举反序列化器,并通过 @JsonDeserialize 注解绑定到对应字段。

✅ 正确实现步骤

1. 定义大小写不敏感的枚举反序列化器

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import java.io.IOException;

public class CaseInsensitiveEnumDeserializer extends JsonDeserializer<addresstype> {
    @Override
    public AddressType deserialize(JsonParser p, DeserializationContext ctxt) 
            throws IOException {
        String value = p.getText();
        if (value == null || value.trim().isEmpty()) {
            return null; // 或抛出异常,根据业务需求决定
        }
        try {
            return AddressType.valueOf(value.trim().toUpperCase());
        } catch (IllegalArgumentException e) {
            throw new IllegalArgumentException(
                "Unknown enum value for AddressType: '" + value + "'", e);
        }
    }
}</addresstype>

⚠️ 注意:valueOf() 方法仅支持精确匹配全大写常量名。确保你的枚举命名规范(如 MAILING),否则需改用 Stream.of(AddressType.values()) 进行模糊匹配(见下文扩展建议)。

2. 在 DTO 中应用反序列化器

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;

public class AddressResponseDTO {
    @JsonDeserialize(using = CaseInsensitiveEnumDeserializer.class)
    @JsonProperty("addressType")
    private AddressType addressType;

    @JsonProperty("line1")
    private String line1;

    @JsonProperty("line2")
    private String line2;

    @JsonProperty("city")
    private String city;

    @JsonProperty("state")
    private String state;

    // 构造函数、getter/setter(略)
}

✅ 此方式完全解耦:无需修改枚举类,不影响其他模块,且支持字段级精准控制。

3. 验证效果

假设收到 JSON:

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载
{
  "addressType": "mailing",
  "line1": "123 Ave",
  "city": "New York",
  "state": "NY"
}

反序列化后 addressType 将正确解析为 AddressType.MAILING,无异常。

? 扩展:支持更灵活的枚举匹配(推荐用于生产环境)

若第三方返回值不遵循统一规则(如可能为 "mailing"、"MAILING"、"Mailing" 甚至 "shipping"),建议增强反序列化逻辑,避免硬编码 toUpperCase():

@Override
public AddressType deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
    String input = p.getText();
    if (input == null || input.trim().isEmpty()) return null;

    String normalized = input.trim().toUpperCase();
    for (AddressType type : AddressType.values()) {
        if (type.name().equalsIgnoreCase(normalized) || 
            type.name().equals(normalized)) {
            return type;
        }
    }
    // 可选:返回默认值或抛出带上下文的异常
    throw new IllegalArgumentException("Unsupported AddressType value: " + input);
}

? 关键注意事项

  • ❌ 不要尝试在字段上同时声明 String 和 AddressType 并依赖构造逻辑(如原问题中的 addressEnum 方案)——Jackson 不会执行字段初始化表达式,该写法无效。
  • ✅ 优先使用 @JsonDeserialize 而非全局配置,避免影响其他枚举类型;如需全局生效,可通过 ObjectMapper 注册 SimpleModule。
  • ? 单元测试建议覆盖边界场景:空值、null、空白字符串、非法值,确保反序列化器健壮性。
  • ? 若使用 Spring Boot 2.3+ 且启用 spring.jackson.deserialization.fail-on-unknown-properties=false,仍需显式处理枚举,因未知值触发的是 InvalidFormatException,而非忽略。

通过上述方式,你能在保持代码清晰性与可维护性的前提下,优雅解决第三方接口枚举大小写不一致这一高频集成痛点。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js json spring boot

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

9977

6

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

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

2023.07.05

7122

9

java自学难吗
java自学难吗

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

2023.07.31

6272

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

908

3

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

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

2023.08.02

1316

5

java有什么用
java有什么用

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

2023.08.02

2629

5

java在线网站
java在线网站

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

2023.08.03

19951

3

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

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

2023.08.03

1175

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 20.8万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.8万人学习