混合Java/Kotlin Android项目中注解处理器未处理Kotlin类问题

在Java/Kotlin混合的原生Android项目中，我们通过注解处理器在构建阶段生成类，该类会收集所有标记了项目内部特定注解的Activity类，用于初始化设备特定硬件。此前处理器运行正常，但添加第一个标记目标注解的Kotlin Activity后，发现它未被纳入生成类，排查确认该Kotlin类不在RoundEnvironment返回的注解元素集合中。

需要解答两个问题：

1. 为何该Kotlin Activity未被包含在环境中？
2. 需如何操作使其被纳入？

相关处理器代码：

// [...]
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.RoundEnvironment;
// [...]

@SupportedAnnotationTypes(EnableScannerTypesAnnotationProcessor.ENABLE_SCANNER_ANNOTATION)
@SupportedSourceVersion(SourceVersion.RELEASE_8)
@SuppressWarnings("PMD.ConsecutiveLiteralAppends")
public class EnableScannerTypesAnnotationProcessor
    extends AbstractProcessor {

    // [...]

    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        // [...]
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
    
        for (TypeElement annotation : annotations) {
            if (annotation.getQualifiedName().contentEquals(ENABLE_SCANNER_ANNOTATION)) {
                final Set<? extends Element> annotatedTypes = roundEnv.getElementsAnnotatedWith(annotation);
                // the processor now operates on the set `annotatedTypes`
                // [...] 

1. 原因分析 #

Kotlin和Java在注解处理环节的默认行为存在差异，主要原因有以下几点：

• 注解Retention配置缺失：Kotlin默认不会将注解编译到字节码的可识别区域，除非注解本身显式指定了CLASS或RUNTIME级别的Retention策略。如果目标注解只设置了默认的SOURCE级别，Kotlin编译后会丢弃注解信息，导致处理器无法读取。
• Gradle依赖配置错误：Android项目中，仅用annotationProcessor引入注解处理器只能处理Java代码，Kotlin代码的注解需要通过kapt来处理，漏加kapt依赖会直接导致Kotlin类的注解被忽略。
• 源版本兼容性问题：处理器指定的@SupportedSourceVersion(RELEASE_8)如果和项目中Kotlin的jvmTarget版本不匹配，可能导致处理器无法识别Kotlin生成的字节码元素。

2. 解决操作 #

步骤1：修正目标注解的Retention策略 #

确保你的@EnableScanner（即代码中ENABLE_SCANNER_ANNOTATION对应的注解）的Retention设置为CLASS或RUNTIME：

• 若注解是Java定义：

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.TYPE;

@Retention(RetentionPolicy.CLASS) // 编译阶段可见，满足注解处理器需求
@Target(TYPE) // 限定注解用于类/接口
public @interface EnableScanner {
    // 注解参数（如果有）
}

• 若注解是Kotlin定义：

import kotlin.annotation.AnnotationRetention.*
import kotlin.annotation.AnnotationTarget.*

@Retention(CLASS)
@Target(CLASS)
annotation class EnableScanner

步骤2：修正Gradle依赖配置 #

在模块的build.gradle（或build.gradle.kts）中，同时添加annotationProcessor和kapt依赖，确保Kotlin和Java代码的注解都能被处理：

• Groovy版本：

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
    kotlinOptions {
        jvmTarget = "1.8" // 和处理器的SOURCE_VERSION保持一致
    }
}

dependencies {
    // 处理Java注解
    annotationProcessor project(":your-processor-module")
    // 处理Kotlin注解（必须添加）
    kapt project(":your-processor-module")
}

• Kotlin DSL版本：

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }
    kotlinOptions {
        jvmTarget = "1.8"
    }
}

dependencies {
    annotationProcessor(project(":your-processor-module"))
    kapt(project(":your-processor-module"))
}

步骤3：更新处理器的源版本配置（可选） #

如果项目使用了更高版本的Java/Kotlin，可以将处理器的@SupportedSourceVersion改为兼容的版本，或者直接使用最新支持的版本：

@SupportedSourceVersion(SourceVersion.latestSupported())

这样可以避免版本不匹配导致的识别问题。

步骤4：验证处理器接收的元素 #

可以在处理器中添加日志打印，确认是否接收到Kotlin类的元素：

@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
    for (TypeElement annotation : annotations) {
        if (annotation.getQualifiedName().contentEquals(ENABLE_SCANNER_ANNOTATION)) {
            final Set<? extends Element> annotatedTypes = roundEnv.getElementsAnnotatedWith(annotation);
            // 打印所有被注解的元素
            for (Element elem : annotatedTypes) {
                processingEnv.getMessager().printMessage(
                    Diagnostic.Kind.NOTE,
                    "已识别到注解元素：" + elem.getQualifiedName() + "，类型：" + elem.getKind()
                );
            }
            // 后续生成代码逻辑...
        }
    }
    return true;
}

构建项目后，查看Build窗口的日志，应该能看到Kotlin Activity的类名被打印出来。

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