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

千宇同学_2087

千宇同学_2087

2026-08-17

698人浏览

原创

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

当 Spring Boot 接收非法枚举值(如 UNK)导致 InvalidFormatException 时,需通过 @RestControllerAdvice 统一捕获并返回友好提示,但必须注意异常处理器的优先级顺序,避免被更宽泛的异常(如 HttpMessageNotReadableException)提前拦截。

spring boot 接收非法枚举值(如 `unk`)导致 `invalidformatexception` 时,需通过 `@restcontrolleradvice` 统一捕获并返回友好提示,但必须注意异常处理器的优先级顺序,避免被更宽泛的异常(如 `httpmessagenotreadableexception`)提前拦截。

在 Spring Boot 应用中,使用 @RequestBody 绑定请求体到 DTO 时,若 JSON 中的枚举字段值(如 "currency": "UNK")不在 enum 定义范围内,Jackson 默认抛出 com.fasterxml.jackson.databind.exc.InvalidFormatException。该异常会被 Spring 封装为 HttpMessageNotReadableException(其 cause 为 InvalidFormatException),最终由 Spring MVC 的异常解析机制统一处理。

因此,直接注册 @ExceptionHandler(InvalidFormatException.class) 通常无效——因为原始异常并未以顶层形式到达 @RestControllerAdvice,而是作为嵌套原因被包裹在 HttpMessageNotReadableException 中。若你同时定义了针对 HttpMessageNotReadableException 的处理器(如返回 ex.getMessage()),它将优先匹配并吞掉整个异常链,导致更具体的 InvalidFormatException 处理器完全不被执行。

✅ 正确做法是:HttpMessageNotReadableException 处理器中主动解包并识别根本原因,而非单独监听 InvalidFormatException。以下为推荐实现:

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

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

下载
@RestControllerAdvice
public class ExceptionAdvice {

    @ExceptionHandler(HttpMessageNotReadableException.class)
    @ResponseStatus(HttpStatus.UNPROCESSABLE_ENTITY) // 更语义化的状态码(422)
    public ResponseEntity<map string>> handleHttpMessageNotReadable(
            HttpMessageNotReadableException ex, HttpServletRequest request) {

        Throwable cause = ex.getCause();
        if (cause instanceof JsonProcessingException jsonEx) {
            // 深度查找 InvalidFormatException(可能嵌套多层)
            InvalidFormatException invalidFormat = findInvalidFormatException(jsonEx);
            if (invalidFormat != null && invalidFormat.getTargetType() != null) {
                String enumName = invalidFormat.getTargetType().getSimpleName();
                String invalidValue = invalidFormat.getValue() != null 
                    ? String.valueOf(invalidFormat.getValue()) 
                    : "null";

                Map<string string> error = new HashMap();
                error.put("error", "Invalid value for enum");
                error.put("enum", enumName);
                error.put("received", invalidValue);
                error.put("hint", "Please choose from valid values");

                return ResponseEntity.status(HttpStatus.UNPROCESSABLE_ENTITY).body(error);
            }
        }

        // 默认降级处理
        Map<string string> fallback = Map.of(
            "error", "Request body is malformed",
            "detail", ex.getLocalizedMessage()
        );
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(fallback);
    }

    private InvalidFormatException findInvalidFormatException(Throwable t) {
        if (t == null) return null;
        if (t instanceof InvalidFormatException) return (InvalidFormatException) t;
        return findInvalidFormatException(t.getCause());
    }
}</string></string></map>

? 关键注意事项:

  • ✅ 使用 HttpStatus.UNPROCESSABLE_ENTITY (422)NOT_ACCEPTABLE (406) 更符合语义:客户端提交了语法正确但语义无效的数据(如非法枚举值)。
  • ✅ 必须递归检查 getCause() 链,因 Jackson 异常可能被多层包装(例如 JsonMappingException → InvalidFormatException)。
  • ❌ 避免为 InvalidFormatException 单独写 @ExceptionHandler——它几乎永远不会被直接触发。
  • ✅ 可结合 @JsonCreator(mode = JsonCreator.Mode.DELEGATING) 或自定义 JsonDeserializer<currency></currency> 实现更灵活的枚举反序列化(如忽略大小写、支持别名),从源头降低异常发生概率。

通过上述方式,你既能精准识别非法枚举输入,又能返回结构清晰、可被前端程序消费的 JSON 错误响应,彻底告别原始堆栈式报错信息。

相关文章

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

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

下载

相关标签:

js json spring boot

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

相关专题

更多
spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.05

511

5

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

2023.10.12

1395

7

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

2025.08.19

3886

10

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

2025.12.22

416

5

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

2025.12.24

580

18

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

2026.02.11

345

24

Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

2026.02.12

311

18

Spring Boot 项目开发与实战
Spring Boot 项目开发与实战

以 Spring Boot 为核心,讲解项目的快速初始化(Spring Initializr)、自动配置与 Starter 依赖原理、配置文件(application.yml)多环境管理、RESTful API 接口开发与参数校验、MyBatis / MyBatis-Plus / Spring Data JPA 数据持久层整合、Redis 缓存集成、统一异常处理与全局响应封装、Swagger / Knife4j 接口文档生成,以及 Ma

2026.04.17

286

21

Java Spring Boot多租户架构设计与数据隔离实战
Java Spring Boot多租户架构设计与数据隔离实战

本专题聚焦 Java 企业级系统中的多租户架构设计,讲解数据隔离策略、租户路由机制、数据库分库分表方案以及权限控制模型。通过真实 SaaS 系统案例,帮助开发者构建可扩展的多租户应用架构。

2026.06.29

276

13

热门下载

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

精品课程

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

共101课时 | 20.4万人学习

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

共39课时 | 4.6万人学习