讲师中心 微信公众号
AI工具推荐 视频效率加速

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

大瑶吖_1028

大瑶吖_1028

发布时间:2026-08-08 13:27:57

|

838人浏览过

|

来源于php中文网

原创

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

本文介绍如何让 Gradle 在同一项目中正确启用自定义注解处理器(即:在定义处理器的模块内,对其自身代码执行注解处理),解决 annotationProcessor 在本模块 src/test 中失效的问题。

本文介绍如何让 gradle 在同一项目中正确启用自定义注解处理器(即:在定义处理器的模块内,对其自身代码执行注解处理),解决 `annotationprocessor` 在本模块 `src/test` 中失效的问题。

在 Gradle 构建系统中,注解处理器(Annotation Processor)默认不会处理其所在模块自身的源码——这是由编译阶段的依赖隔离机制决定的:annotationProcessor 依赖仅作用于 消费该处理器的其他模块,而不会反向应用于当前模块的 main 或 test 源集。因此,即使你在 lib/src/test/java 中使用了 @MyAnnotation,Gradle 的 compileTestJava 任务也不会触发 MyAnnotationProcessor,导致 process() 方法静默不执行。

✅ 正确方案:模块拆分 + 跨模块注解处理

最稳定、符合 Gradle 最佳实践的解决方案是将 注解处理器实现 与 使用该处理器的测试代码 分离到两个独立的子项目(模块)中:

.
├── lib/               ← 核心模块:含 @MyAnnotation 和 MyAnnotationProcessor
│   ├── build.gradle
│   └── src/main/java/demo/...
├── test/              ← 测试模块:使用 @MyAnnotation 编写测试用例
│   ├── build.gradle
│   └── src/test/java/demo/MyAnnotationProcessorTest.java
└── settings.gradle    ← 声明 include('lib', 'test')

? 配置说明

settings.gradle

include 'lib', 'test'

lib/build.gradle(精简版,专注提供处理器)

plugins { id 'java-library' }

repositories { mavenCentral() }

dependencies {
    implementation 'com.google.auto.service:auto-service:1.1.1'
    annotationProcessor 'com.google.auto.service:auto-service:1.1.1'
}

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

✅ 注意:lib 模块不再包含测试逻辑,也不需配置 testImplementation 或 useJUnitPlatform。

test/build.gradle(专用于验证处理器行为)

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

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

下载
plugins { id 'java' }

repositories { mavenCentral() }

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter:5.9.1'
    testImplementation project(':lib')        // 提供注解类和处理器类
    testAnnotationProcessor project(':lib')   // 关键!使注解处理器参与 test 编译
}

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

tasks.test {
    useJUnitPlatform()
}

⚠️ 关键点:testAnnotationProcessor project(':lib') 显式声明 lib 作为测试期的注解处理器,确保 MyAnnotationProcessor 在 compileTestJava 阶段被激活。

✅ 验证效果

运行:

./gradlew test --info

你将在编译日志中看到:

>>>>> process called <<<<<

这表明注解处理器已成功介入测试代码的编译流程。

? 补充说明与注意事项

  • 输出产物隔离:test 模块的编译结果(如 test.jar)默认不会打包进 lib/build/libs/xxx.jar,符合发布规范;lib 的 JAR 仅含 public API(注解类 + 处理器 SPI 类),不含测试代码。
  • 替代方案不推荐:
    • 使用 compileOnly + annotationProcessor 同时依赖 project(':lib') 在单模块内强行复用 —— 因 Gradle 的 compileJava 和 compileTestJava 是独立任务,且 annotationProcessor 不跨源集生效,此方式不可靠。
    • 修改 sourceSets.test.annotationProcessorPath 手动注入 —— 易出错、难维护,且在新版 Gradle(8.0+)中已被弃用。
  • 进阶建议:若需集成测试(IT),可额外添加 integrationTest 源集,并同样通过 integrationTestAnnotationProcessor project(':lib') 启用处理器。

通过模块化设计,你不仅解决了自测问题,还提前践行了“处理器应可独立发布与复用”的工程原则——这也是主流开源注解库(如 AutoService、Room、Lombok)的标准实践。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

相关专题

更多
java
java

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

10157

2023.06.15

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

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

7302

2023.07.05

java自学难吗
java自学难吗

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

6412

2023.07.31

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

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

1104

2023.08.01

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

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

908

2023.08.02

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

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

1336

2023.08.02

java有什么用
java有什么用

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

2669

2023.08.02

java在线网站
java在线网站

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

19991

2023.08.03

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

20

2026.10.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
夸克AI浏览器使用手册
夸克AI浏览器使用手册

共0课时 | 0人学习

jQuery官方API文档
jQuery官方API文档

共0课时 | 0人学习

Manus AI 入门手册
Manus AI 入门手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn