IDEA插件中Annotation Processor无法运行问题排查求助

我在IntelliJ IDEA插件开发中，尝试使用注解处理器解析带有@TaskID注解的类和方法，但发现处理器完全不执行。相关代码和环境信息如下：

相关代码 #

TaskID注解定义 #

@Retention(RetentionPolicy.SOURCE)
@Target({TYPE, METHOD})
public @interface TaskID {
    /**
     * Task ID
     */
    String[] taskID();
}

注解处理器类 #

import com.google.auto.service.AutoService;

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.Processor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.*;
import javax.lang.model.util.Elements;
import java.util.*;

@AutoService(Processor.class)
public class AnnotationProcessor extends AbstractProcessor {
    // 此处缺少核心方法实现
}

Gradle依赖配置 #

dependencies {
    annotationProcessor 'com.google.auto.service:auto-service:1.0-rc2'
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
    implementation 'com.google.auto.service:auto-service:1.0-rc2'
    implementation ("com.github.javaparser:javaparser-core:3.25.4")
}

环境信息 #

• JDK 11
• Gradle 7.6
• IntelliJ IDEA 2021.3.1（社区版）

可能的原因及解决方案 #

1. 注解处理器未实现核心方法 #

AbstractProcessor要求必须重写三个核心方法才能执行处理逻辑：

• getSupportedAnnotationTypes()：指定处理器要处理的注解全类名
• getSupportedSourceVersion()：声明支持的Java版本
• process()：编写具体的注解解析逻辑

补充完整后的处理器代码示例：

import com.google.auto.service.AutoService;

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.Processor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import java.util.Collections;
import java.util.Set;

@AutoService(Processor.class)
public class AnnotationProcessor extends AbstractProcessor {

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        // 指定要处理的注解
        return Collections.singleton(TaskID.class.getCanonicalName());
    }

    @Override
    public SourceVersion getSupportedSourceVersion() {
        // 使用当前支持的最高Java版本
        return SourceVersion.latestSupported();
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        // 遍历所有带有@TaskID的元素
        for (Element element : roundEnv.getElementsAnnotatedWith(TaskID.class)) {
            TaskID taskID = element.getAnnotation(TaskID.class);
            String[] ids = taskID.taskID();
            // 这里编写你的业务逻辑，比如打印、生成代码等
            System.out.println("检测到TaskID: " + String.join(",", ids) + "，位于元素: " + element.getSimpleName());
        }
        // 返回false表示允许其他处理器处理剩余注解，true则表示当前处理器已处理所有相关注解
        return false;
    }
}

2. AutoService依赖配置冗余 #

当前依赖中同时添加了implementation 'com.google.auto.service:auto-service:1.0-rc2'和annotationProcessor 'com.google.auto.service:auto-service:1.0-rc2'，implementation依赖是多余的，AutoService只需作为注解处理器依赖即可，用于自动生成META-INF/services/javax.annotation.processing.Processor配置文件。调整后的依赖：

dependencies {
    annotationProcessor 'com.google.auto.service:auto-service:1.0-rc2'
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
    implementation ("com.github.javaparser:javaparser-core:3.25.4")
}

3. IntelliJ IDEA未启用注解处理器 #

检查IDEA的注解处理器开关是否开启：

• 打开File → Settings → Build, Execution, Deployment → Compiler → Annotation Processors
• 勾选Enable annotation processing选项
• 确保当前模块的注解处理器设置为Automatically detect annotation processors，或者手动指定处理器路径

4. JDK版本与Gradle编译配置不匹配 #

在build.gradle中明确指定编译版本为JDK 11，避免版本兼容问题：

java {
    sourceCompatibility = JavaVersion.VERSION_11
    targetCompatibility = JavaVersion.VERSION_11
}

5. 插件模块的注解处理器配置问题 #

如果注解处理器是IDEA插件模块的一部分，需要：

• 确保插件模块的编译过程中能识别到注解处理器，可在build.gradle中添加annotationProcessor依赖指向处理器模块（如果是多模块项目）
• 检查plugin.xml是否有相关配置，确保编译插件代码时触发注解处理器执行

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