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

如何使用自定义注解配合Java枚举在Spring框架中实现优雅的入参校验

夜瑶吖_3566

夜瑶吖_3566

发布时间:2026-06-27 07:44:27

|

737人浏览过

|

来源于php中文网

原创

自定义注解实现枚举值校验需定义带@Constraint的注解并指定validatedBy类,枚举类提供code字段及ofCode静态查找方法,验证器通过反射调用ofCode判断合法性,支持泛型与enumClass属性提升复用性,配合@Valid和全局异常处理返回结构化错误响应。

如何使用自定义注解配合java枚举在spring框架中实现优雅的入参校验

自定义注解定义校验规则

先创建一个自定义注解,用于标记需要校验枚举值的字段。注解需声明校验逻辑的触发时机(如 @Target({ElementType.FIELD, ElementType.PARAMETER})),并指定运行时保留(@Retention(RetentionPolicy.RUNTIME))。关键点是添加 @Constraint(validatedBy = EnumValueValidator.class),将校验委托给具体实现类。

编写枚举类并约定校验依据

枚举类应提供统一的取值入口,比如定义 code 字段表示外部传入的标识符,并提供静态方法 ofCode(String code) 用于查找对应枚举项。该方法在验证器中被调用,若返回 null 则视为非法值。例如:

public enum OrderStatus {
  PENDING("pending"),
  PAID("paid"),
  SHIPPED("shipped");
  private final String code;
  OrderStatus(String code) { this.code = code; }
  public static OrderStatus ofCode(String code) {
    return Arrays.stream(values())
      .filter(e -> e.code.equals(code))
      .findFirst()
      .orElse(null);
  }
}

实现 ConstraintValidator 接口完成校验逻辑

编写 EnumValueValidator 类,泛型参数为自定义注解类型和待校验字段类型(通常为 String 或枚举本身)。重写 isValid 方法:若入参为 null,根据业务决定是否允许;否则调用枚举的 ofCode 方法判断是否存在匹配项。支持泛型枚举校验可提取通用逻辑,避免为每个枚举写单独验证器。

Java Maven Common
Java Maven Common

Java Maven 项目审查工作流的通用输入处理。当 Java Maven 项目以 ZIP压缩包或 GitLab 仓库 URL 形式提供且需要...时使用。

下载

立即学习“Java免费学习笔记(深入)”;

  • 校验器中通过 Class<? extends Enum> 获取目标枚举类型,再反射调用其静态方法
  • 注解上可增加 enumClass() 属性,运行时传入具体枚举类,提升复用性
  • 错误提示消息通过 message() 属性配置,默认使用国际化键(如 enum.not.supported)

在 Controller 中使用并配合全局异常处理

在 DTO 或请求参数对象的字段上添加自定义注解,例如:@ValidEnum(enumClass = OrderStatus.class, message = "订单状态不合法") private String status;。Spring MVC 自动触发校验,失败时抛出 MethodArgumentNotValidException。配合 @ControllerAdvice 统一捕获,提取 BindingResult 中的错误信息,返回结构化 JSON 响应(如 code=400, msg="订单状态不合法")。

注意开启校验支持:确保控制器方法参数带有 @Valid 或 @Validated,且项目引入了 spring-boot-starter-validation 依赖。

热门AI工具

更多
墨刀AI
墨刀AI Hot

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

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

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

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

WorkBuddy

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

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

Laper
Laper Hot

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

DeepSeek

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

豆包大模型

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

相关专题

更多
java
java

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

10717

2023.06.15

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

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

7842

2023.07.05

java自学难吗
java自学难吗

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

6812

2023.07.31

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

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

1164

2023.08.01

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

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

948

2023.08.02

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

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

1396

2023.08.02

java有什么用
java有什么用

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

2829

2023.08.02

java在线网站
java在线网站

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

20111

2023.08.03

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

20

2026.10.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

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

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