如何在 Gradle 项目中将自身作为注解处理器进行测试与使用

轻辰君_4225

轻辰君_4225

2026-08-07

210人浏览

原创

如何在 Gradle 项目中将自身作为注解处理器进行测试与使用

本文介绍如何让 Gradle 项目在同一构建中正确启用并测试其自定义注解处理器(如 MyAnnotationProcessor),解决“在 src/test/ 中使用 @MyAnnotation 却无任何处理日志”的常见问题。核心方案是拆分模块,使处理器与测试代码分离,规避编译期循环依赖限制。

本文介绍如何让 gradle 项目在**同一构建中**正确启用并测试其自定义注解处理器(如 `myannotationprocessor`),解决“在 `src/test/` 中使用 `@myannotation` 却无任何处理日志”的常见问题。核心方案是拆分模块,使处理器与测试代码分离,规避编译期循环依赖限制。

在 Gradle 中,一个模块无法直接将自身 src/main/ 中定义的注解处理器用于自身的 src/test/ 编译过程。原因在于:Gradle 的 Java 插件默认将 annotationProcessor 依赖解析为外部 JAR 包,而 project(':lib') 在 test 阶段尚未完成编译(classes 任务未执行完毕),导致 testAnnotationProcessor 无法识别或加载 lib 模块中尚未生成的处理器类。即使使用 annotationProcessor project(':lib'),也会因 classpath 时机问题静默失败——你不会看到错误,但 processingEnv.getMessager().printMessage(...) 完全不会触发。

✅ 推荐且稳定可行的解决方案是:采用多模块结构,将注解处理器定义在 lib 模块,测试逻辑移至独立的 test(或 processor-test)模块。该方式符合 Gradle 构建生命周期,确保 lib 先编译、发布(到构建缓存),再被 test 模块以 testAnnotationProcessor 形式引用。

✅ 正确目录结构与配置

.
├── lib/
│   ├── build.gradle
│   └── src/main/java/demo/
│       ├── MyAnnotation.java
│       └── MyAnnotationProcessor.java
├── test/
│   ├── build.gradle
│   └── src/test/java/demo/MyAnnotationProcessorTest.java
└── settings.gradle

1. settings.gradle 启用双模块

include('lib', 'test')

2. lib/build.gradle —— 仅声明处理器实现

plugins {
    id 'java-library'
}

repositories { mavenCentral() }

dependencies {
    // 注解处理器运行时依赖(如 AutoService)
    implementation 'com.google.auto.service:auto-service:1.1.1'
    annotationProcessor 'com.google.auto.service:auto-service:1.1.1'
    // ⚠️ 注意:此处不添加 test 相关依赖,保持模块职责单一
}

java {
    toolchain { languageVersion = JavaLanguageVersion.of(17) }
}

3. test/build.gradle —— 专注测试验证

plugins { id 'java' }

repositories { mavenCentral() }

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter:5.9.1'
    testImplementation project(':lib')           // 提供 @MyAnnotation 等 API
    testAnnotationProcessor project(':lib')       // ✅ 关键:让注解处理器参与 test 编译
}

java {
    toolchain { languageVersion = JavaLanguageVersion.of(17) }
}

tasks.named('test') {
    useJUnitPlatform()
}

? 为什么 testAnnotationProcessor project(':lib') 有效?
因为 Gradle 会自动确保 lib:classes 和 lib:jar(含 META-INF/services/javax.annotation.processing.Processor)在 test:compileTestJava 之前完成。此时 test 模块的编译器能正确发现并加载 MyAnnotationProcessor,并在遇到 @MyAnnotation 时触发 process() 方法——你会在控制台看到 ">>>>> process called 日志。

? 验证是否生效

在 test/src/test/java/demo/MyAnnotationProcessorTest.java 中添加测试用例:

Miller CSV TSV JSON 数据处理器
Miller CSV TSV JSON 数据处理器

Miller (mlr) 是一个命令行工具,用于查询、整形和重新格式化名称索引数据,如 CSV、TSV、JSON 和 JSON Lines。它将 awk、sed、cut、join 和 sort 的功能整合到一个专为结构化数据处理而构建的单一工具中。

下载
package demo;

import org.junit.jupiter.api.Test;

@MyAnnotation
class MyAnnotationProcessorTest {

    @Test
    @MyAnnotation
    void testWithAnnotation() {
        @MyAnnotation String s = "hello";
    }
}

运行 ./gradlew test --info,观察编译日志中是否出现 >>>>> process called 。若出现,则证明处理器已成功介入测试源码的编译阶段。

⚠️ 注意事项与最佳实践

  • test 模块不会打包进最终发布的 lib.jar:test 是独立模块,其内容(包括 MyAnnotationProcessorTest.class)仅存在于 test/build/ 下,不影响 lib 的发布产物。
  • 避免在 lib 中写测试逻辑:lib/src/test/ 仅适合单元测试处理器内部逻辑(如模拟 RoundEnvironment),不能验证注解处理行为本身——因为 lib 无法处理自己的注解。
  • 替代方案(不推荐):尝试 compileOnly files('build/classes/java/main') 或 gradle.properties 中 hack classpath,极易因构建缓存、增量编译失效,且不可靠。
  • 进阶建议:若需更高保真度测试(如生成文件校验),可在 test 模块中添加 compileTestJava 任务的 doLast 钩子,检查 build/generated/sources/annotationProcessor/test/ 目录是否存在预期输出。

通过模块化拆分,你不仅解决了自测难题,还提升了项目结构清晰度和可维护性——这正是现代 Gradle 工程实践所倡导的「关注点分离」原则的体现。

相关文章

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

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

下载

相关标签:

处理器

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

相关专题

更多
java
java

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

2023.06.15

11297

6

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

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

2023.07.05

8402

9

java自学难吗
java自学难吗

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

2023.07.31

7252

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

988

3

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

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

2023.08.02

1456

5

java有什么用
java有什么用

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

2023.08.02

2969

5

java在线网站
java在线网站

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

2023.08.03

20231

3

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

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

2023.08.03

1315

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Sass 教程
Sass 教程

共14课时 | 1.5万人学习

PHP入门速学(台湾同胞版)
PHP入门速学(台湾同胞版)

共10课时 | 1.6万人学习

韩顺平 2016年 最新PHP基础视频教程
韩顺平 2016年 最新PHP基础视频教程

共47课时 | 12.2万人学习