使用Kotlin编写Android注解处理器时构建失败求助

我来帮你搞定这个Kotlin注解处理器的构建失败问题，结合你的项目结构和给出的Gradle配置信息，下面是几个针对性的排查和解决方向：

1. 完善Annotation模块的Gradle核心配置 #

注解处理器模块的Gradle配置是最容易出问题的地方，你需要补充这些关键配置：

• 必须应用kotlin-kapt插件（仅kotlin插件不够），kapt是Kotlin官方提供的注解处理器工具，用来替代Java的annotationProcessor：

  plugins {
      id 'java-library'
      id 'kotlin'
      id 'kotlin-kapt'
  }
  

  这里添加java-library是因为注解处理器本质是Java库，不需要Android组件支持。
• 补充必要的依赖项，确保注解处理器能正常工作：

  dependencies {
      // 匹配你用的Kotlin版本
      implementation 'org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.2.31'
      // AutoService用来自动注册注解处理器，避免手动配置META-INF
      implementation 'com.google.auto.service:auto-service:1.0-rc6'
      kapt 'com.google.auto.service:auto-service:1.0-rc6'
      // 如果需要处理Android相关注解，添加编译期依赖
      compileOnly 'com.android.tools:annotations:27.1.1'
  }
  

2. 确保注解处理器类被正确识别 #

你的AnnotationProcessor.kt需要通过@AutoService注解标记，让Gradle能自动发现它，同时重写必要的方法：

import com.google.auto.service.AutoService
import javax.annotation.processing.AbstractProcessor
import javax.annotation.processing.Processor
import javax.lang.model.SourceVersion
import javax.lang.model.element.TypeElement

@AutoService(Processor::class)
class AnnotationProcessor : AbstractProcessor() {
    override fun getSupportedAnnotationTypes(): MutableSet<String> {
        // 指定你的注解类全限定名
        return mutableSetOf(Annotation::class.java.canonicalName)
    }

    override fun getSupportedSourceVersion(): SourceVersion {
        return SourceVersion.latestSupported()
    }

    override fun process(annotations: MutableSet<out TypeElement>?, roundEnv: RoundEnvironment?): Boolean {
        // 你的处理器逻辑
        return true
    }
}

3. 配置Sample模块的依赖引用 #

在Sample模块的build.gradle中，要正确引用注解模块作为依赖和注解处理器：

dependencies {
    // 依赖注解定义类
    implementation project(':annotation')
    // 用kapt引用注解处理器（Kotlin项目必须用kapt，Java项目用annotationProcessor）
    kapt project(':annotation')
}

4. 清理构建缓存并排查兼容性 #

你当前用的Gradle插件3.1.1和Kotlin插件1.2.31是兼容的，但旧的构建缓存可能导致问题：

• 执行命令清理缓存并重新构建：./gradlew clean build
• 检查Android Studio的Gradle同步状态，确保没有同步错误提示

5. 检查注解类的定义正确性 #

确保你的Annotation.kt注解类型符合处理器需求，比如编译期注解适合生成代码的场景：

@Target(AnnotationTarget.CLASS) // 指定注解可以用在类上
@Retention(AnnotationRetention.SOURCE) // 仅保留在源码阶段，处理器处理后就丢弃
annotation class Annotation

内容的提问来源于stack exchange，提问作者Philipp Fahlteich