参数校验中怎么自定义实现校验注解逻辑

秋枫君_5474

秋枫君_5474

2026-09-25

476人浏览

原创

自定义校验注解需两步:定义注解(含@constraint、@target、@retention及标准属性)和实现constraintvalidator(含initialize缓存参数、isvalid执行校验逻辑);使用时需配合@valid/@validated触发,并为枚举字符串绑定注册converter避免类型转换异常。

参数校验中怎么自定义实现校验注解逻辑

自定义校验注解的核心是两步:定义注解本身 + 实现对应的校验逻辑类。它不是写个注解就完事,关键在 ConstraintValidator 的实现和正确注册。

定义校验注解

用 @interface 声明注解,必须标注 @Constraint(validatedBy = XxxValidator.class),指明由哪个类执行校验:

  • 加上 @Target(如 FIELD, PARAMETER)明确能加在哪
  • 加上 @Retention(RUNTIME) 确保运行时可通过反射读取
  • 声明属性,比如 String[] values() 用于传入允许的枚举值,或 Class> enumClass() 指定枚举类型
  • 提供 message()、groups()、payload() 这三个标准属性(JSR-380 要求)

编写校验器(ConstraintValidator)

实现 ConstraintValidator<yourannotation yourtargettype></yourannotation> 接口:

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载
  • initialize() 方法里可解析注解参数,比如把 values() 转成 Set 缓存,避免每次校验都重复构造
  • isValid() 是核心逻辑:接收待校验的值(如字符串、整数)和上下文对象,返回 true 表示合法
  • 若需国际化提示,用 context.buildConstraintViolationWithTemplate(...).addConstraintViolation() 替代直接返回 false

在 DTO 或参数上使用

注解生效的前提是 Spring 的校验机制被触发:

  • 对请求体对象(@RequestBody),字段上加你的注解,并在 Controller 方法参数前加 @Valid
  • 对路径变量、查询参数等单个参数,需在 Controller 类上加 @Validated,再在参数前加你的注解(如 @MyEnum("PENDING", "DONE") String status)
  • 确保项目已引入 spring-boot-starter-validation,Spring Boot 2.3+ 默认包含

处理枚举字符串绑定异常(关键细节)

如果校验目标是枚举类型,且前端传的是字符串(如 "pending"),默认会因类型转换失败而抛 MethodArgumentTypeMismatchException,校验根本不会执行:

  • 必须注册一个 Converter<string yourenum></string>,查不到时返回 null(不能抛异常)
  • 在 WebMvcConfigurer#addFormatters 中注册该 Converter
  • 这样非法值才能绑定为 null,后续 @Valid 才有机会调用你的校验器判断是否为空或越界

相关文章

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

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

下载

相关标签:

java

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

相关专题

更多
java
java

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

2023.06.15

8977

6

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

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

2023.07.05

6182

9

java自学难吗
java自学难吗

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

2023.07.31

5552

8

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

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

2023.08.01

1004

3

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

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

2023.08.02

828

3

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

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

2023.08.02

1176

5

java有什么用
java有什么用

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

2023.08.02

2389

5

java在线网站
java在线网站

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

2023.08.03

19711

3

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

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

2023.08.03

1075

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习