如何通过 Annotation Processor 在编译期实现对 Record 字段的自定义校验逻辑注入

轻晨吖_6778

轻晨吖_6778

2026-04-28

975人浏览

原创

record字段校验不能依赖运行时注解,因其无法修改编译生成的final构造器和访问器;真正可插手的是编译期annotation processor,需显式判断elementkind.record类型并操作ast。

如何通过 annotation processor 在编译期实现对 record 字段的自定义校验逻辑注入

Record 字段校验为什么不能靠运行时注解?

因为 @Override、toString()、hashCode() 这些方法在 record 编译后就固化了,运行时反射拿不到字段校验逻辑的注入点;而 @Retention(RetentionPolicy.RUNTIME) 注解只能触发检查,无法修改生成的构造器或访问器。真正能插手的地方只有编译期——也就是 Annotation Processor 在解析 Record 元素时,通过 javax.annotation.processing.ProcessingEnvironment 获取 AST 并生成辅助类或改写构造逻辑。

如何让 Processor 识别 Record 类及其字段?

Java 14+ 的 Record 在 ElementKind 中是独立类型(RECORD),但很多老版本 Processor 模板仍用 TYPE 判断,会漏掉。必须显式检查:

if (element.getKind() == ElementKind.RECORD) {
    TypeElement recordType = (TypeElement) element;
    List extends Element> enclosed = recordType.getEnclosedElements();
    // 注意:record 的字段是 RECORD_COMPONENT,不是 FIELD
    enclosed.stream()
            .filter(e -> e.getKind() == ElementKind.RECORD_COMPONENT)
            .forEach(this::processRecordComponent);
}
  • RECORD_COMPONENT 是关键类型,不是 FIELD,否则拿不到 canonical constructor 参数信息
  • 字段的 @NonNull、@Size 等注解需用 getAnnotationMirrors() 获取,不能用 getAnnotation()(后者只支持 RUNTIME)
  • 若 record 声明在嵌套作用域(如方法内、匿名类中),Element 可能为 ERROR,需跳过处理

生成校验逻辑时该往哪塞代码?

不能修改原 record 字节码(JSR-269 不允许),只能生成配套类。主流做法是生成一个同名 Validator 辅助类,或在 canonical constructor 调用前插入校验调用——但后者需配合 javac 插件(如 javac-plugin)或字节码增强(非标准 Processor 能力)。更稳妥的是:

  • 生成 MyRecordValidator 类,含静态 validate(MyRecord r) 方法,自动调用每个字段的 @NotNull、@Min 等逻辑
  • 若使用 Lombok 风格,可生成带 withXxx() 的 builder 类,并在每个 setter 中插入字段级校验
  • 避免生成 MyRecord$$Enhancer 这类代理类——它破坏 record 的不可变语义,且与 equals()/hashCode() 行为冲突

示例生成的 validator 片段:

public class UserValidator {
    public static void validate(User user) {
        if (user.name() == null) {
            throw new IllegalArgumentException("name must not be null");
        }
        if (user.age() = 0");
        }
    }
}

常见陷阱:泛型 record 和模块化环境下的 ClassLoader 问题

Processor 运行在 javac 的上下文中,其 ClassLoader 与应用类路径隔离。当你在注解中引用自定义校验类(如 @ValidateWith(MyCustomRule.class)),Processor 无法直接 Class.forName() 加载它——会抛 ClassNotFoundException,哪怕该类就在同一 module 中。

  • 正确做法:用 annotationMirror.getElementValues().get(...) 提取注解属性值,而非尝试加载类
  • 泛型 record(如 record Box<t>(T value)</t>)的 TypeParameter 在 RecordComponent 中不保留具体类型实参,asType() 返回的是 T 符号类型,需结合 Types#erasure() 或额外元数据推断
  • 若项目启用 --enable-preview 或多版本 jar,Processor 必须声明支持对应 source version(SupportedSourceVersion(SourceVersion.RELEASE_21)),否则 RECORD 元素可能被忽略

最易被忽略的一点:record 的 canonical constructor 可能被显式重写(哪怕只加个 throws),此时 getEnclosedElements() 里找不到 CONSTRUCTOR,所有基于构造器参数顺序推导字段校验位置的逻辑都会失效——得退回到字段声明顺序 + 名称匹配。

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

10957

6

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

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

2023.07.05

8082

9

java自学难吗
java自学难吗

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

2023.07.31

7012

8

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

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

2023.08.01

1184

3

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

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

2023.08.02

968

3

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

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

2023.08.02

1416

5

java有什么用
java有什么用

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

2023.08.02

2889

5

java在线网站
java在线网站

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

2023.08.03

20171

3

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

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

2023.08.03

1275

8

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 133.9万人学习