自定义注解校验器开发_自定义注解如何配合反射实现通用的字段合法性检查

秋墨同学_5847

秋墨同学_5847

2026-05-29

537人浏览

原创

自定义注解配合反射实现通用字段校验,核心是“标记+扫描+执行”三步闭环:通过运行时注解声明校验意图,反射定位带注解字段,再调用验证逻辑;不依赖spring validation,也无需重复if判断,真正一次定义、多处复用。

自定义注解校验器开发_自定义注解如何配合反射实现通用的字段合法性检查

自定义注解配合反射实现通用字段校验,核心在于“标记 + 扫描 + 执行”三步闭环:用注解声明校验意图,用反射定位带注解的字段,再调用对应验证逻辑完成检查。它不依赖 Spring Validation 框架,也不需要为每个字段写 if 判断,真正实现一次定义、多处复用。

一、定义运行时注解,明确校验语义

注解必须保留到运行时(@Retention(RUNTIME)),且能标注在字段上(@Target(FIELD))。例如定义一个非空校验注解:

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface NotNull {
  String message() default "字段不能为空";
  Class>[] groups() default {};
  Class extends Payload>[] payload() default {};
}

注意:message、groups、payload 是 JSR-303 规范要求的三个标准属性,即使不用 Bean Validation 框架,也建议保留,便于后续扩展或与框架兼容。

二、编写通用校验器,用反射遍历并执行检查

校验器是一个普通工具类,接收任意对象,通过反射获取其所有字段,判断是否带有指定注解,再根据注解类型执行对应逻辑:

  • 调用 obj.getClass().getDeclaredFields() 获取全部字段
  • 对每个字段调用 field.isAnnotationPresent(NotNull.class)
  • 设为可访问(field.setAccessible(true)),再用 field.get(obj) 取值
  • 若值为 null,抛出含 annotation.message() 的异常或收集错误信息

关键点:字段可能在父类中,需递归扫描 getSuperclass();私有字段必须设为 accessible;基本类型需处理包装类与默认值差异(如 int 默认 0,但不是 null)。

三、支持多注解组合与动态扩展

一个字段可同时标注多个校验注解(如 @NotNull + @Range(min=1, max=100)),校验器应统一扫描、逐个触发:

  • 把不同注解映射到不同验证器(如 NotNullValidator、RangeValidator)
  • 用 Map<class extends annotation>, Validator></class> 管理策略
  • 新增校验规则只需定义新注解 + 新验证器,无需修改主校验流程

例如枚举校验可定义 @EnumValue(enumClass = Status.class),验证器内部用 enumClass.getDeclaredMethod("valueOf", String.class).invoke(null, value) 尝试转换,失败即不合法——完全泛化,不耦合具体枚举类型。

四、集成使用:手动触发或结合 AOP 自动拦截

最轻量用法是在业务入口手动调用校验工具:

ValidationUtils.validate(user); // 抛出 ValidationException 或返回 List

若希望无感生效,可结合 Spring AOP,在 Controller 方法参数前织入校验逻辑:

  • 切点匹配 @annotation(org.springframework.web.bind.annotation.PostMapping) 或自定义 @Validated
  • 从 JoinPoint.getArgs() 中提取 DTO 对象
  • 委托给上述通用校验器执行

这样既保持低侵入,又避免重复调用,适合微服务中统一参数守门。

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

10497

6

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

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

2023.07.05

7642

9

java自学难吗
java自学难吗

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

2023.07.31

6652

8

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

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

2023.08.01

1144

3

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

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

2023.08.02

928

3

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

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

2023.08.02

1376

5

java有什么用
java有什么用

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

2023.08.02

2769

5

java在线网站
java在线网站

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

2023.08.03

20071

3

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

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

2023.08.03

1235

8

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.7万人学习