如何配置Eclipse在移除注解时运行注解处理器？

问题根源 #

Eclipse的增量构建默认仅在添加/修改注解、或修改被注解类的代码时触发注解处理器。当移除类上的注解时，Eclipse不会将该类标记为需要重新处理的输入，导致处理器无法运行清理逻辑，生成的列表文件也就无法更新。

解决方案（Gradle/Buildship项目） #

1. 调整Gradle配置，强制增量构建监听注解变更 #

在项目的build.gradle（Groovy）或build.gradle.kts（Kotlin）中添加以下配置，让Buildship告知Eclipse在注解变更时触发处理器：

Groovy DSL

eclipse {
    jdt {
        file {
            withProperties { props ->
                // 启用注解处理
                props['org.eclipse.jdt.core.compiler.processAnnotations'] = 'enabled'
                // 开启增量构建中的注解处理
                props['org.eclipse.jdt.apt.processorOptions'] = 'incrementalProcessing=true'
                // 确保APT始终启用
                props['org.eclipse.jdt.apt.aptEnabled'] = true
            }
        }
    }
}

tasks.withType(JavaCompile) {
    options.annotationProcessing {
        // 启用增量注解处理
        incremental = true
        // 让处理器能访问编译后的类文件，用于检查注解是否存在
        classpath += sourceSets.main.output
    }
}

Kotlin DSL

eclipse {
    jdt {
        file.withProperties {
            setProperty("org.eclipse.jdt.core.compiler.processAnnotations", "enabled")
            setProperty("org.eclipse.jdt.apt.processorOptions", "incrementalProcessing=true")
            setProperty("org.eclipse.jdt.apt.aptEnabled", true)
        }
    }
}

tasks.withType<JavaCompile> {
    options.annotationProcessing.apply {
        incremental = true
        classpath += sourceSets.main.get().output
    }
}

2. 修改注解处理器，确保清理逻辑能被触发 #

即使Eclipse触发了处理器，当没有带目标注解的元素时，原代码仍可能跳过处理。修改处理器逻辑，确保即使没有新的注解元素，也会检查并清理旧列表：

@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
    if (!roundEnv.processingOver()) {
        try {
            // 处理当前带注解的元素
            generateAnnotationFiles(annotations, roundEnv);
            
            // 额外清理：遍历所有已生成的注解文件，检查每个类是否仍保留注解
            cleanUpStaleAnnotationEntries();
        } catch (IOException e) {
            throw new IllegalStateException(e);
        }
    }
    return false;
}

private void cleanUpStaleAnnotationEntries() throws IOException {
    try {
        // 访问META-INF/annotations目录下的所有生成文件
        FileObject annotationsDir = processingEnv.getFiler()
                .getResource(StandardLocation.SOURCE_OUTPUT, "", "META-INF/annotations");
        
        if (!annotationsDir.exists()) {
            return;
        }
        
        for (FileObject file : annotationsDir.getChildren()) {
            String annotationQualifiedName = file.getName().getBaseName();
            TypeElement annotationType = processingEnv.getElementUtils()
                    .getTypeElement(annotationQualifiedName);
            
            if (annotationType == null) {
                // 注解类型已不存在，直接删除文件
                file.delete();
                continue;
            }
            
            // 重新验证文件中的每个类是否仍带有注解
            List<String> validClasses = getPreviousListedClasses(file.getName().toString(), annotationType);
            
            // 重写文件，只保留有效类
            try (PrintWriter out = new PrintWriter(file.openWriter())) {
                validClasses.forEach(clazz -> out.append(clazz).append('\n'));
            }
        }
    } catch (FilerException e) {
        // 目录不存在时忽略
    }
}

// 保留你原有的generateAnnotationFiles、getPreviousListedClasses等方法

3. Eclipse项目手动配置（兜底） #

如果Gradle配置不生效，手动调整Eclipse的注解处理设置：

• 右键项目 → Properties → Java Compiler → Annotation Processing
• 勾选Enable annotation processing和Enable annotation processing in incremental builds
• 切换到Factory Path标签，添加你的注解处理器JAR文件（如果是项目内的处理器，添加对应的模块输出）

为什么这样能解决问题 #

• Gradle配置强制Eclipse将注解变更视为增量构建的触发条件，确保移除注解时处理器会被调用
• 修改后的处理器在每次运行时都会主动检查所有已生成的列表，即使没有新的注解元素，也能清理掉已移除注解的类
• Eclipse手动配置确保APT在增量构建中始终启用，避免Buildship配置未同步的问题

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