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

如何在 Spring Boot 中验证枚举参数的有效性

轻宇大大_5945

轻宇大大_5945

发布时间:2026-07-22 18:46:07

|

336人浏览过

|

来源于php中文网

原创

如何在 Spring Boot 中验证枚举参数的有效性

本文介绍在 Spring Boot REST API 中,如何确保请求体中的枚举字段(如 Level)仅接受预定义的合法值(如 NEW、OLD),并通过 @EnumFormat 注解实现声明式校验。

本文介绍在 spring boot rest api 中,如何确保请求体中的枚举字段(如 `level`)仅接受预定义的合法值(如 `new`、`old`),并通过 `@enumformat` 注解实现声明式校验。

在 Spring Boot 中,默认的 Bean Validation(JSR-303/380)标准并不原生支持枚举值的合法性校验——即无法自动拒绝传入 "UNKNOWN" 或空字符串等非法枚举字符串。虽然 @NotNull 可防止 null,@NotBlank 适用于字符串,但对 enum 类型字段无效,因为反序列化阶段若传入非法字符串(如 "MID"),Jackson 会直接抛出 HttpMessageNotReadableException(400 Bad Request),而非进入 Bean Validation 流程,导致无法自定义错误提示。

✅ 正确方案:使用 Hibernate Validator 扩展注解 @EnumFormat(来自 spring-boot-starter-validation 的增强支持,实际由 spring-boot-starter-web 间接引入,但需确认版本兼容性)。

首先,确保项目已引入验证依赖(Spring Boot 2.3+ 默认包含,若缺失请显式添加):

<!-- Maven -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

然后,在 DTO 字段上添加 @EnumFormat 注解:

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

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

下载
import org.springframework.format.annotation.EnumFormat;
import javax.validation.constraints.NotNull;

public class CarDto {
    @EnumFormat(enumClass = Level.class, caseSensitive = false)
    @NotNull(message = "Level must not be null")
    private Level level;

    // getter/setter...
}

⚠️ 注意事项:

  • @EnumFormat 是 Spring Framework 提供的注解(位于 org.springframework.format.annotation),并非 Hibernate Validator 原生注解(常见误区)。它作用于数据绑定阶段(@RequestBody 反序列化前),由 WebDataBinder 解析时触发校验。
  • caseSensitive = false 允许客户端传 "new" 或 "NEW" 均可成功绑定(默认为 true)。
  • 若传入非法值(如 "invalid"),将返回 400 Bad Request,响应体中包含标准化错误信息(如 Field error in object 'carDto' on field 'level': rejected value [invalid]),并支持通过 @ControllerAdvice 统一处理为友好 JSON 错误。

? 补充:如需更灵活控制(例如支持别名映射或忽略大小写),可自定义 Converter<java.lang.String, Level> 并注册到 WebMvcConfigurer;但对于大多数场景,@EnumFormat 已足够简洁可靠。

总结:验证枚举字段的核心在于拦截反序列化前的字符串转换过程,而非等待 Validator 运行。因此,优先使用 @EnumFormat,配合 @NotNull 确保非空,即可实现健壮、可读、可定制的枚举参数校验。

热门AI工具

更多
讯飞绘文

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

豆包大模型

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

WorkBuddy

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

DeepSeek

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

UpDream
UpDream Hot

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

相关专题

更多
java
java

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

10357

2023.06.15

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

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

7482

2023.07.05

java自学难吗
java自学难吗

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

6552

2023.07.31

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

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

1124

2023.08.01

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

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

928

2023.08.02

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

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

1356

2023.08.02

java有什么用
java有什么用

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

2729

2023.08.02

java在线网站
java在线网站

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

20051

2023.08.03

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

80

2026.10.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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