Spring Boot 中自定义处理 JSON 反序列化枚举异常的正确方式

千宇同学_2087

千宇同学_2087

2026-08-17

233人浏览

原创

Spring Boot 中自定义处理 JSON 反序列化枚举异常的正确方式

本文详解如何在 Spring Boot 中精准捕获并优雅处理 @RequestBody 反序列化失败(如传入非法枚举值)时抛出的 InvalidFormatException,避免被更宽泛的异常处理器(如 HttpMessageNotReadableException)意外覆盖。

本文详解如何在 spring boot 中精准捕获并优雅处理 `@requestbody` 反序列化失败(如传入非法枚举值)时抛出的 `invalidformatexception`,避免被更宽泛的异常处理器(如 `httpmessagenotreadableexception`)意外覆盖。

在 Spring Boot Web 应用中,当客户端通过 POST 提交 JSON 数据(如 {"currency": "UNK"})试图反序列化为含 enum 字段的 DTO(如 AccountDto)时,Jackson 默认会抛出 InvalidFormatException——这是底层 JSON 解析器对非法枚举值的直接反馈。虽然你已通过 @RestControllerAdvice 定义了专门处理该异常的方法:

@ExceptionHandler(InvalidFormatException.class)
@ResponseStatus(HttpStatus.NOT_ACCEPTABLE)
public String invalidFormatException(InvalidFormatException exc) {
    return "foo";
}

但实际仍返回原始堆栈式错误信息,根本原因在于:异常处理器的匹配遵循“最具体优先”原则,而 InvalidFormatExceptionJsonProcessingException 的子类,同时它也常被包裹在更高层的 HttpMessageNotReadableException(后者是 Spring MVC 对所有请求体解析失败的统一包装异常)。

关键陷阱就藏在这里:如果你的 @RestControllerAdvice同时存在 @ExceptionHandler(HttpMessageNotReadableException.class) 的处理器(尤其当它未做内部异常类型判断就直接返回 ex.getMessage()),那么无论原始异常是 InvalidFormatExceptionJsonParseException 还是其他 Jackson 异常,都会被该通用处理器“提前拦截”,导致更精确的 InvalidFormatException 处理器完全失效。

✅ 正确做法分两步:

抖音下载器(Node.js)
抖音下载器(Node.js)

抖音无水印视频下载和文案提取工具

下载
  1. 移除或重构通用处理器:删除或修改 HttpMessageNotReadableException 处理器,避免无差别吞并所有解析异常;
  2. 增强 InvalidFormatException 处理逻辑(推荐):保留通用处理器,但在其中显式检查 cause 链,精准提取并响应 InvalidFormatException
@RestControllerAdvice
public class ExceptionAdvice {

    @ExceptionHandler(HttpMessageNotReadableException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ResponseEntity<map string>> handleHttpMessageNotReadable(
            HttpMessageNotReadableException ex, HttpServletRequest request) {

        // 检查是否由 InvalidFormatException 引起(如枚举值不合法)
        Throwable cause = ex.getCause();
        while (cause != null) {
            if (cause instanceof InvalidFormatException invalidFormat) {
                String fieldName = Optional.ofNullable(invalidFormat.getPath().get(0))
                        .map(JsonMappingException.Reference::getFieldName)
                        .orElse("field");
                String value = invalidFormat.getValue() != null 
                        ? String.valueOf(invalidFormat.getValue()) 
                        : "(null)";

                Map<string string> error = Map.of(
                    "error", "Invalid enum value",
                    "field", fieldName,
                    "received", value,
                    "message", String.format("'%s' is not a valid value for %s", 
                        value, invalidFormat.getTargetType().getSimpleName())
                );
                return ResponseEntity.badRequest().body(error);
            }
            cause = cause.getCause();
        }

        // 其他解析失败场景(如 JSON 格式错误)
        Map<string string> fallback = Map.of(
            "error", "Invalid request body",
            "detail", "Failed to parse JSON payload"
        );
        return ResponseEntity.badRequest().body(fallback);
    }
}</string></string></map>

? 注意事项:

  • 不要依赖 @ResponseBody + String 返回简单文本(易被 Content-Type 误解),推荐统一返回 ResponseEntity<map string>></map>,确保 JSON 响应且结构清晰;
  • 枚举校验也可前置:在 DTO 字段上添加 @Pattern 或自定义 @ValidEnum 注解配合 ConstraintValidator,将校验时机从反序列化阶段前移到 Bean Validation 阶段,获得更可控的错误响应;
  • 生产环境建议记录异常日志(log.error("Enum deserialization failed", ex)),便于问题追踪。

通过精准定位异常根源、合理设计处理器优先级与降级策略,即可彻底告别冗长低层错误信息,为 API 提供专业、友好的错误体验。

相关文章

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

8697

6

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

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

2023.07.05

5922

9

java自学难吗
java自学难吗

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

2023.07.31

5312

8

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

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

2023.08.01

964

3

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

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

2023.08.02

808

3

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

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

2023.08.02

1136

5

java有什么用
java有什么用

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

2023.08.02

2309

5

java在线网站
java在线网站

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

2023.08.03

19651

3

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

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

2023.08.03

1055

8

热门下载

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

精品课程

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

共101课时 | 20.4万人学习

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

共39课时 | 4.7万人学习