无法在 Kotlin 中构建注释处理器

Posted 2023-04-18

【中文标题】无法在 Kotlin 中构建注释处理器

【英文标题】：Failed to build annotation processor in Kotlin

【发布时间】：2018-09-21 00:08:46

【问题描述】：

我目前正在尝试在 Kotlin 中为 android 编写注释处理器。项目结构如下：

/annotation
  /src/main/kotlin/<package>
    Annotation.kt
    AnnotationProcessor.kt
/sample

项目/build.gradle

buildscript 
  dependencies 
    classpath 'com.android.tools.build:gradle:3.1.1'
    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.2.31"
  

注解/build.gradle

apply plugin: 'kotlin'

sourceCompatibility = 1.7
targetCompatibility = 1.7

dependencies 
  implementation "org.jetbrains.kotlin:kotlin-stdlib-jre7:$kotlinVersion"

示例/build.gradle

apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'

android 
  ...
  compileOptions 
    sourceCompatibility JavaVersion.VERSION_1_7
    targetCompatibility JavaVersion.VERSION_1_7
  

dependencies 
  implementation "org.jetbrains.kotlin:kotlin-stdlib-jre7:$kotlinVersion"
  implementation project(':annotation')
  kapt project(':annotation')

Annotation.kt

@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.SOURCE)
annotation class Annotation(val comment: String = "")

AnnotationProcessor.kt

class AnnotationProcessor : AbstractProcessor() 
  override fun process(annotations: MutableSet<out TypeElement>?, roundEnvironment: RoundEnvironment?): Boolean = true

使用 kapt 构建中断示例：javaPreCompileDebug 并显示以下消息：

org.gradle.api.tasks.TaskExecutionException: Execution failed for task ':sample:javaPreCompileDebug'
Caused by: java.lang.RuntimeException: Annotation processors must be explicitly declared now.  The following dependencies on the compile classpath are found to contain annotation processor.  Please add them to the annotationProcessor configuration.
- annotation.jar (project :annotation)
Alternatively, set android.defaultConfig.javaCompileOptions.annotationProcessorOptions.includeCompileClasspath = true to continue with previous behavior.  Note that this option is deprecated and will be removed in the future.
See https://developer.android.com/r/tools/annotation-processor-error-message.html for more details.

当我用 annotationProcessor 替换 kapt 时，构建在 sample:transformClassesWithInstantRunForDebug 上中断，并显示以下消息：

Caused by: java.io.IOException: Failed to find byte code for javax/annotation/processing/AbstractProcessor
at com.android.build.gradle.internal.incremental.AsmUtils.lambda$static$0(AsmUtils.java:89)
at com.android.build.gradle.internal.incremental.AsmUtils.loadClass(AsmUtils.java:307)
at com.android.build.gradle.internal.incremental.AsmUtils.readClassAndInterfaces(AsmUtils.java:165)
at com.android.build.gradle.internal.incremental.AsmUtils.loadClass(AsmUtils.java:278)
at com.android.build.gradle.internal.incremental.IncrementalVisitor.instrumentClass(IncrementalVisitor.java:342)
at com.android.build.gradle.internal.transforms.InstantRunTransform.transformToClasses2Format(InstantRunTransform.java:406)
at com.android.build.gradle.internal.transforms.InstantRunTransform.lambda$doTransform$3(InstantRunTransform.java:268)
at com.android.build.gradle.internal.transforms.InstantRunTransform.lambda$null$4(InstantRunTransform.java:297)
at java.util.concurrent.ForkJoinTask$AdaptedCallable.exec(ForkJoinTask.java:1424)
... 4 more

当我禁用 Instant Run 时，一切正常。

我现在的问题是，我的配置哪里出错了？我遵循this 之类的示例项目，我看到的唯一大区别是注释模块分为两个（运行时和编译器）。但错误消息表明 Kotlin 或 Instant Run 存在问题。

【参考方案1】：

您必须将“注释”项目分成两部分。

例子：

implementation project(':annotation-lib') // here you put Annotation.kt
kapt project(':annotation-compiler') // AnnotationProcessor.kt

不要忘记将处理器添加到注释编译器项目中的 META-INF，请参阅What is the default annotation processors discovery process?

【讨论】：

就是这样！将注释模块拆分为两个单独的模块（一个用于注释，一个用于处理器）解决了 Instant Run 的问题，并使其他解决方法（如“includeCompileClasspath”）过时。非常感谢您，祝您有愉快的一天！

为什么kapt project不能和根项目是同一个项目，而不是一个单独的项目？