如何让源文件被注解处理器处理，并获取未修改的原始源文件？

1. 如何让源文件被注解处理器处理？ #

要让源文件被注解处理器处理，需完成三个核心步骤：

• 定义自定义注解：确保注解保留级别至少为CLASS（编译期可见），若仅需在注解处理器阶段处理，用SOURCE级别即可。示例代码：

@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
public @interface XXX {
}

• 实现注解处理器类：继承AbstractProcessor，重写process方法处理注解逻辑，同时通过注解指定支持的注解类型和Java版本：

@SupportedAnnotationTypes("com.example.XXX") // 替换为你的注解全类名
@SupportedSourceVersion(SourceVersion.RELEASE_8) // 适配你的Java版本
public class XXXProcessor extends AbstractProcessor {
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        // 遍历被@XXX注解的元素，执行处理逻辑
        for (Element element : roundEnv.getElementsAnnotatedWith(XXX.class)) {
            // 处理逻辑代码
        }
        return true; // 返回true表示该注解已被当前处理器处理，无需其他处理器再处理
    }
}

• 注册注解处理器：让编译环境识别你的处理器，有两种常用方式：
  • 手动注册：在项目的src/main/resources/META-INF/services目录下创建名为javax.annotation.processing.Processor的文件，文件内写入处理器的全类名（如com.example.XXXProcessor）。
  • 构建工具配置：若用Gradle，在build.gradle中通过annotationProcessor依赖引入处理器模块；若用Maven，在maven-compiler-plugin中配置processorPaths指定处理器的依赖。

2. 保持原始源文件不变并获取处理前的原始文件 #

关于原始文件不变的说明 #

注解处理器的设计原则就是不能修改原始源文件，它只能生成新的文件（如类文件、资源文件），因此默认就满足“处理后原始源文件保持不变”的要求，无需额外配置。

获取原始A.java文件的解决方法 #

使用processingEnv.getFiler().getResource()失败是因为该方法用于获取处理器生成的资源或类路径中的资源，无法直接访问原始源码文件。推荐两种可靠的解决方案：

方案一：通过元素位置信息直接读取源文件内容

通过RoundEnvironment拿到被注解的元素后，利用Messager获取元素的源码位置，进而读取文件内容：

@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
    for (Element element : roundEnv.getElementsAnnotatedWith(XXX.class)) {
        if (element instanceof TypeElement) {
            TypeElement targetClass = (TypeElement) element;
            // 获取元素的源码位置
            SourcePosition position = processingEnv.getMessager().getSourceLocation(targetClass);
            FileObject sourceFile = position.getFile();
            try {
                // 读取原始文件的完整内容
                String originalContent = sourceFile.getCharContent(true).toString();
                // 在这里使用原始内容
            } catch (IOException e) {
                // 处理异常
                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "读取源文件失败：" + e.getMessage());
            }
        }
    }
    return true;
}

这种方式无需依赖源码目录配置，直接从编译环境获取文件，兼容性更好。

方案二：通过编译选项获取源码目录后读取文件

从ProcessingEnvironment的编译选项中拿到源码路径，再通过文件路径直接读取：

@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
    // 获取源码路径，不同构建工具的参数键可能不同
    String sourcePath = processingEnv.getOptions().get("sourcepath");
    if (sourcePath != null) {
        File originalFile = new File(sourcePath + "/a/b/c/A.java");
        try (BufferedReader reader = new BufferedReader(new FileReader(originalFile))) {
            String line;
            StringBuilder content = new StringBuilder();
            while ((line = reader.readLine()) != null) {
                content.append(line).append("\n");
            }
            // content即为原始文件内容
        } catch (IOException e) {
            processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "读取源文件失败：" + e.getMessage());
        }
    } else {
        processingEnv.getMessager().printMessage(Diagnostic.Kind.WARNING, "未获取到源码路径");
    }
    return true;
}

注意：不同构建工具的源码路径参数可能有差异，比如部分环境下参数键为javax.annotation.processing.sourcepath，需根据实际构建环境调整。

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