Java中 Gradle 怎么通过 annotationProcessor 配置第三方编译期注解处理器

老瑶姑娘_6615

老瑶姑娘_6615

2026-07-19

674人浏览

原创

在Gradle项目中,需用annotationProcessor配置引入编译期注解处理器(如Lombok),禁止用implementation;Java模块需应用java插件、设置兼容Java版本,并在sourceSets中添加生成目录为源根以供IDE识别。

java中 gradle 怎么通过 annotationprocessor 配置第三方编译期注解处理器

在 Gradle 项目中通过 annotationProcessor 配置第三方编译期注解处理器,核心是让编译器(javac)在编译阶段加载并执行对应的 Processor 类,同时确保生成的代码能被 IDE 正确识别和参与编译。

添加 annotationProcessor 依赖

在模块级 build.gradle(或 build.gradle.kts)的 dependencies 块中,使用 annotationProcessor 配置项引入处理器 JAR:

  • 对 Java/Kotlin 普通模块,直接写:
dependencies {
    implementation 'com.google.guava:guava:33.2.1-jre'
    annotationProcessor 'org.projectlombok:lombok:1.18.34'
    compileOnly 'org.projectlombok:lombok:1.18.34' // 推荐同时加 compileOnly,避免运行时依赖
}
  • 如果是 Android 项目,用 annotationProcessor(旧版 AGP)或 compileOnly + kapt(Kotlin);但纯 Java Gradle 项目只用 annotationProcessor 即可。
  • 注意:不要用 implementation 引入处理器——它只应在编译期存在,不应打包进最终产物。

启用 Gradle 的注解处理支持

Gradle 默认开启注解处理,但需确认以下两点:

  • Java 插件已应用:plugins { id 'java' }(或 id 'org.jetbrains.kotlin.jvm' 等)
  • Java 版本兼容:在 java { sourceCompatibility = JavaVersion.VERSION_17 } 中设为 ≥ 注解处理器要求的版本(如 Lombok 要求 JDK 11+)
  • 无需额外开启 options.annotationProcessing = true —— Gradle 6.0+ 默认启用

确保生成代码被正确识别(IDEA 关键一步)

即使 Gradle 编译成功生成了代码(如 build/generated/sources/annotationProcessor/java/main/),IntelliJ IDEA 默认不将其视为源码根目录,会导致“找不到符号”错误:

Java Api Extractor
Java Api Extractor

从 Java 项目中提取 Controller 层接口定义为 JSON 数据。

下载
  • 手动标记:右键该生成目录 → Mark as Generated Sources Root
  • 更推荐自动化方式(在 build.gradle 中):
sourceSets {
    main {
        java {
            srcDirs += "$buildDir/generated/sources/annotationProcessor/java/main"
        }
    }
}

这样每次构建后,IDEA 会自动识别新生成的类,支持跳转、补全和编译依赖。

验证是否生效

最直接的验证方式:

  • 添加一个该处理器支持的注解(如 @Data 来自 Lombok)
  • 执行 ./gradlew compileJava,观察是否无报错且生成了对应方法字节码(可通过反编译 build/classes 下 class 文件确认)
  • 在 IDEA 中检查是否出现 getter/setter 补全提示,且无红色报错
  • 若使用自定义 Processor,检查 META-INF/services/javax.annotation.processing.Processor 是否在 JAR 包内正确声明实现类

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

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

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

下载

相关标签:

java 处理器

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

相关专题

更多
java
java

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

2023.06.15

11517

6

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

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

2023.07.05

8642

9

java自学难吗
java自学难吗

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

2023.07.31

7432

8

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

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

2023.08.01

1224

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

1476

5

java有什么用
java有什么用

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

2023.08.02

3029

5

java在线网站
java在线网站

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

2023.08.03

20291

3

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

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

2023.08.03

1335

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习