如何通过 Annotation Processor 在编译期实现代码检查并强制执行团队的架构规范

轻晨吖_6778

轻晨吖_6778

2026-04-28

647人浏览

原创

annotation processor适合做架构层静态检查,因为它是唯一能在java编译期稳定访问完整ast、类型信息和注解元数据的官方机制;通过roundenvironment精准筛选元素,用messager报error中断编译,结合supportedoptions动态控制规则,且需将自定义注解抽为独立api模块避免类加载失败。

如何通过 annotation processor 在编译期实现代码检查并强制执行团队的架构规范

为什么 AnnotationProcessor 适合做架构层静态检查

因为它是唯一能在 Java 编译期(javac 阶段)稳定访问完整 AST、类型信息和注解元数据的官方机制——比 Lombok 插件更底层,比 SpotBugs/Checkstyle 更贴近源码结构,且不依赖 IDE 或额外构建插件。团队规范如「Controller 不得直接 new Service」或「Data 类禁止继承」,必须在编译失败时拦截,而不是靠 Code Review 或 CI 后置扫描。

如何用 RoundEnvironment 定位违规类并报告错误

关键不是遍历所有类,而是精准筛选带特定注解(如 @Layer)或位于特定包路径下的元素,再结合 Element.getEnclosedElements() 和 Element.getSuperclass() 做语义判断。错误必须用 processingEnv.getMessager().printMessage() 报出 Diagnostic.Kind.ERROR,否则不会中断编译。

  • 不要用 elements.getAllMembers() 查方法调用——它不包含字节码级调用关系,只能查声明;想检查「new Service」得解析 ExecutableElement 的 getParameters() 和 getSimpleName(),再递归扫描其 getEnclosedElements() 中的 VariableElement 初始化表达式(需配合 TreePathScanner + JavacTrees,但注意:标准 AnnotationProcessor API 不暴露 AST 树,得用 com.sun.source.util.Trees 并 cast ProcessingEnvironment
  • 包路径检查别硬编码字符串匹配,用 element.getEnclosingElement().toString().startsWith("com.example.controller") 更可靠,避免子包误判
  • 报错位置要精确到行号:传入 element 或具体 VariableElement,而非笼统的 TypeElement

javax.annotation.processing.SupportedOptions 怎么控制检查开关和规则粒度

通过 -Acheck.layering=true -Aallow.service.impl.in.controller=false 这类编译参数注入配置,比写死在 processor 里更灵活。processor 内部用 processingEnv.getOptions().get("check.layering") 读取,值为 "true" 字符串而非布尔型,需显式转换。

  • 选项名必须全小写加点号,IDEA 的 Maven 编译默认不透传 -A 参数,需在 Settings > Build > Compiler > Java Compiler 中勾选「Use compiler: javac」并手动添加 Additional command line parameters
  • Gradle 用户要在 compileJava.options.compilerArgs 里追加,例如 ['-Acheck.domain.rules=true'],且确保 annotationProcessor 依赖已声明,否则选项被忽略
  • 避免用选项控制「是否启用整个 processor」——JVM 会跳过未声明 @SupportedAnnotationTypes 的 processor,应始终启用,靠选项决定是否执行具体校验逻辑

为什么不能只靠 @SupportedAnnotationTypes("*") 捕获所有类

通配符会导致 processor 被触发次数爆炸(每个源文件都进一轮),且无法区分「被注解的类」和「引用了注解的类」。真正需要检查的是架构约束涉及的实体(如 @Controller、@Repository 标记的类),应显式声明 @SupportedAnnotationTypes({"org.springframework.stereotype.Controller", "com.example.arch.DomainEvent"})。

  • Spring 自带注解如 @Controller 是 @Target(ElementType.TYPE),可直接匹配;但若检查「Service 调用 Repository」,就得监听所有类(因调用发生在方法体内),此时需结合 RoundEnvironment.getRootElements() + 包过滤,而非依赖注解类型
  • Android 环境下 androidx.annotation.NonNull 等支持库注解可能被混淆或未参与编译,需确认 processor classpath 包含对应 jar,否则 getTypeElement() 返回 null
  • 增量编译时,RoundEnvironment 只返回变更的元素,若规则依赖跨类关系(如 A 类调用 B 类方法),必须缓存上一轮结果或改用全量扫描模式

最易被忽略的是 processor 的 classloader 隔离问题:自定义注解若放在被检查模块中,processor 默认看不到其 class —— 必须把注解定义抽成独立的 api 模块,并作为 processor 的 compileOnly 依赖,否则 getTypeElement("com.example.Layer") 返回 null,整个检查逻辑静默失效。

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

11137

6

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

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

2023.07.05

8242

9

java自学难吗
java自学难吗

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

2023.07.31

7132

8

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

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

2023.08.01

1204

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

1436

5

java有什么用
java有什么用

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

2023.08.02

2929

5

java在线网站
java在线网站

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

2023.08.03

20211

3

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

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

2023.08.03

1295

8

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 133.9万人学习