Spring Boot 中如何校验枚举类型参数的有效性

梦杰同学_3953

梦杰同学_3953

2026-07-22

796人浏览

原创

Spring Boot 中如何校验枚举类型参数的有效性

在 Spring Boot REST API 中,可通过 @EnumFormat 注解结合 Hibernate Validator 实现对请求体中枚举字段的自动校验,确保传入值严格限定在预定义枚举范围内,避免非法字符串导致的运行时异常。

在 spring boot rest api 中,可通过 `@enumformat` 注解结合 hibernate validator 实现对请求体中枚举字段的自动校验,确保传入值严格限定在预定义枚举范围内,避免非法字符串导致的运行时异常。

在构建 RESTful 接口时,若请求体(如 CarDto)中包含枚举类型字段(如 Level level),默认情况下 Spring 会尝试将 JSON 字符串(如 "NEW" 或 "OLD")反序列化为对应枚举值;但当客户端传入非法值(如 "UNKNOWN"、空字符串或 null)时,Spring 默认仅抛出 MethodArgumentNotValidException 或 HttpMessageNotReadableException,且不提供语义清晰的校验提示——这不利于前端友好反馈与 API 契约一致性。

✅ 正确做法是引入 Hibernate Validator 并使用 @EnumFormat 注解进行声明式校验:

1. 添加依赖(Maven)
确保 pom.xml 中包含 Hibernate Validator(Spring Boot 2.3+ 已移除默认嵌入,需显式引入):

<dependency><groupid>org.springframework.boot</groupid><artifactid>spring-boot-starter-validation</artifactid></dependency>

⚠️ 注意:spring-boot-starter-validation 已包含 hibernate-validator,无需额外添加 org.hibernate:hibernate-validator 坐标(除非需指定版本)。

2. 在 DTO 字段上添加校验注解

Spring Boot 3.3.13
Spring Boot 3.3.13

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

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

    // getter/setter
}

@EnumFormat 是 Spring Framework 5.2+ 内置的校验注解(位于 org.springframework.format.annotation 包),无需额外依赖,且支持:

  • enumClass:指定目标枚举类型(必填);
  • message:自定义错误提示;
  • ignoreCase:可选,设为 true 时支持大小写不敏感匹配(如 "new" 也被接受)。

3. 启用全局校验(推荐)
确保控制器方法使用 @Valid 触发校验:

@PostMapping("/cars")
public ResponseEntity> createCar(@Valid @RequestBody CarDto carDto) {
    return ResponseEntity.ok(carService.save(carDto));
}

当请求中 level 字段为 "INVALID" 或 null 时,Spring 将自动返回 400 Bad Request,响应体包含标准 ConstraintViolation 错误信息,例如:

{
  "timestamp": "2024-06-15T10:20:30.123",
  "status": 400,
  "error": "Bad Request",
  "fieldErrors": [{
    "field": "level",
    "message": "Invalid level: must be one of [NEW, OLD]"
  }]
}

? 补充说明:

  • 若使用 Jackson 反序列化(如 @RequestBody),@EnumFormat 作用于绑定阶段(DataBinder),而 Jackson 自身的 @JsonCreator 或 @JsonValue 属于序列化层,二者职责分离,建议优先使用 @EnumFormat 统一校验入口;
  • 对于路径变量或查询参数中的枚举,同样适用 @EnumFormat(配合 @PathVariable 或 @RequestParam);
  • 如需更灵活的枚举校验逻辑(如支持别名、多语言映射),可自定义 ConstraintValidator,但多数场景内置注解已足够。

通过 @EnumFormat,你既能保证类型安全,又能提供清晰、可控的错误反馈,是 Spring Boot 枚举参数校验的最佳实践。

相关文章

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

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

下载

相关标签:

spring boot

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

相关专题

更多
java
java

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

2023.06.15

9257

6

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

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

2023.07.05

6422

9

java自学难吗
java自学难吗

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

2023.07.31

5732

8

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

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

2023.08.01

1024

3

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

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

2023.08.02

848

3

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

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

2023.08.02

1216

5

java有什么用
java有什么用

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

2023.08.02

2429

5

java在线网站
java在线网站

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

2023.08.03

19791

3

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

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

2023.08.03

1095

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习