我正在编写一个 AnnotationProcessor，它应该生成 java 代码。它应该从某些现有接口(interface)生成派生接口(interface)。

为此我需要找到原始输入代码的导入语句，以便我可以在生成的java文件中输出它。

如何做到这一点？

最佳答案

您无法使用注解处理器获取导入语句。不过，您可以获得的是该类使用的类型，这更好。

源代码中的 import 语句不足以分析类中使用了哪些类型，因为并非所有使用的类型都有 import 语句。如果你真的只需要实际的陈述，你可以 read the source file直接地。

如果只看语句会有一些问题:

• 完全合格的类名，例如一处特性java.util.Date date;
• 从同一个包导入没有明确的导入语句
• 为文件中的所有类声明导入语句
• 未使用的导入语句可能会导致额外的困惑

使用注释处理器和 Mirror API ，您可以获得属性类型、方法参数、方法返回类型等 - 基本上是每个不在方法或 block 中的声明的类型。这应该足够好了。

您应该分析类的每个元素并将其类型存储在一个集合中。有一些utility classes这有助于完成这项任务。您可以忽略 java.lang 中的任何类型包，因为它总是隐式导入。

一个最小的注释处理器可能看起来像这样:

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.annotation.processing.SupportedSourceVersion;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.TypeElement;

@SupportedSourceVersion(SourceVersion.RELEASE_7)
@SupportedAnnotationTypes("*")
public class Processor extends AbstractProcessor {

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        ImportScanner scanner = new ImportScanner();
        scanner.scan(roundEnv.getRootElements(), null);

        Set<String> importedTypes = scanner.getImportedTypes();
        // do something with the types

        return false;
    }

}

这里的扫描仪扩展了ElementScanner7这是基于访问者模式。我们只实现了一些访问者方法并按类型过滤元素，因为并非所有元素实际上都可以包含可导入类型。

import java.util.HashSet;
import java.util.Set;

import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.TypeElement;
import javax.lang.model.element.TypeParameterElement;
import javax.lang.model.element.VariableElement;
import javax.lang.model.type.TypeKind;
import javax.lang.model.util.ElementScanner7;

public class ImportScanner extends ElementScanner7<Void, Void> {

    private Set<String> types = new HashSet<>();

    public Set<String> getImportedTypes() {
        return types;
    }

    @Override
    public Void visitType(TypeElement e, Void p) {
        for(TypeMirror interfaceType : e.getInterfaces()) {
            types.add(interfaceType.toString());
        }
        types.add(e.getSuperclass().toString());
        return super.visitType(e, p);
    }

    @Override
    public Void visitExecutable(ExecutableElement e, Void p) {
        if(e.getReturnType().getKind() == TypeKind.DECLARED) {
            types.add(e.getReturnType().toString());
        }
        return super.visitExecutable(e, p);
    }

    @Override
    public Void visitTypeParameter(TypeParameterElement e, Void p) {
        if(e.asType().getKind() == TypeKind.DECLARED) {
            types.add(e.asType().toString());
        }
        return super.visitTypeParameter(e, p);
    }

    @Override
    public Void visitVariable(VariableElement e, Void p) {
        if(e.asType().getKind() == TypeKind.DECLARED) {
            types.add(e.asType().toString());
        }
        return super.visitVariable(e, p);
    }

}

此扫描器返回一组类型作为完全限定路径。还有一些事情需要考虑和实现:

• 该集合包含来自 java.lang 的元素以及来自同一包的类型
• 该集合包含泛型，例如 java.util.List<String>
• TypeKind.DECLARED不是唯一一种可导入类型的元素。还要检查 TypeKind.ARRAY并获取它的实际声明类型。而不是将另一个添加到 else if(e.asType().getKind() == TypeKind.ARRAY) // ...类(class)TypeKindVisitor7可以改用
• 根据用例，可能会发现更多类型。例如，注释可以包含类作为参数。
• 对于 Java 1.6 使用相应的 ElementScanner6 , TypeKindVisitor6等实现。

关于Java注解处理API访问import语句，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/14734445/