讲师中心 微信公众号
AI工具推荐 视频效率加速

Spring Boot 中如何验证请求体中的枚举参数值

风晨吖_2847

风晨吖_2847

发布时间:2026-07-22 13:25:06

|

177人浏览过

|

来源于php中文网

原创

Spring Boot 中如何验证请求体中的枚举参数值

在 Spring Boot REST API 中,可通过 @EnumFormat 注解对请求体中的枚举字段进行合法性校验,确保客户端传入的值严格匹配预定义的枚举常量,避免无效字符串导致的运行时异常。

在 spring boot rest api 中,可通过 `@enumformat` 注解对请求体中的枚举字段进行合法性校验,确保客户端传入的值严格匹配预定义的枚举常量,避免无效字符串导致的运行时异常。

在构建 RESTful 接口时,将请求体(@RequestBody)中的字符串自动绑定为 Java 枚举类型虽便捷,但默认情况下 Spring 并不校验该字符串是否为合法枚举值——若客户端传入 "UNKNOWN" 或空格字符串等非法值,Spring 会抛出 MethodArgumentTypeMismatchException(如 IllegalArgumentException: No enum constant Level.UNKNOWN),且该异常发生在数据绑定阶段,早于 Bean Validation 的校验流程,因此 @NotNull、@NotBlank 等标准注解均无法捕获此类错误。

✅ 正确解决方案:使用 Spring Boot 官方支持的 @EnumFormat 注解(属于 Spring Framework 5.2+ 内置的格式化校验能力,无需额外引入 Hibernate Validator):

Spring Boot 3.3.13
Spring Boot 3.3.13

Spring Boot下载页提供 3.3.13 官方源码 ZIP,并整理快速入门、项目创建、配置和自动配置说明。

下载
public class CarDto {
    @EnumFormat(enumClass = Level.class, message = "Level must be one of: NEW, OLD")
    private Level level;

    // getter/setter
}

⚠️ 注意事项:

  • @EnumFormat 是 Spring 自带注解(位于 org.springframework.format.annotation.EnumFormat),无需添加 hibernate-validator 依赖(该依赖常被误传;实际 @EnumFormat 与 Hibernate Validator 无关);
  • 必须配合 @Valid 或 @Validated 在 Controller 方法参数上启用校验:
    @PostMapping("/cars")
    public ResponseEntity<?> createCar(@Valid @RequestBody CarDto carDto) {
        return ResponseEntity.ok(carDto);
    }
  • 若未配置全局异常处理器,非法枚举值将触发 MethodArgumentNotValidException,可通过 @ControllerAdvice 统一返回友好错误响应;
  • enumClass 属性必须显式指定(不可省略),以明确校验目标枚举类型;
  • 该注解仅校验字符串能否成功转换为枚举实例,不校验 null 值——如需同时禁止 null,应叠加 @NotNull:
    @NotNull(message = "Level cannot be null")
    @EnumFormat(enumClass = Level.class, message = "Invalid level value")
    private Level level;

? 补充说明:若项目已集成 Hibernate Validator 且希望复用统一校验机制,也可自定义 @Constraint 实现枚举校验(如 @ValidEnum),但 @EnumFormat 更轻量、语义更清晰,是 Spring Boot 场景下的推荐方案。

热门AI工具

更多
Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

相关专题

更多
java
java

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

9217

2023.06.15

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

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

6382

2023.07.05

java自学难吗
java自学难吗

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

5712

2023.07.31

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

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

1024

2023.08.01

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

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

848

2023.08.02

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

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

1196

2023.08.02

java有什么用
java有什么用

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

2429

2023.08.02

java在线网站
java在线网站

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

19771

2023.08.03

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

160

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习

尚硅谷新版SpringBoot3教程
尚硅谷新版SpringBoot3教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn