如何在注释处理器中获取字段类?

内容来源于 Stack Overflow,并遵循CC BY-SA 3.0许可协议进行翻译与使用

  • 回答 (1)
  • 关注 (0)
  • 查看 (9)

我正在编写我的第一个注释处理器,并且遇到了一些看似微不足道的问题,但是我找不到有关它的任何信息。

我有一个带注释的元素

@MyAnnotation String property;

当我在处理器中作为元素获得该属性时,我似乎无法以任何方式获得该元素的类型。在本例中,a希望获得表示字符串的Class或TypeElement实例。

我尝试用以下方法实例化容器类型的类对象Class.forName()但它抛出了ClassNotFoundException。我认为这是因为我无法访问包含该类的类加载器?

提问于
用户回答回答于

运行注释处理器时,你无权访问已编译的类。注释处理的要点是它发生预编译。

相反,你需要创建专门处理注释类型的注释处理器,然后使用镜像API访问该字段。例如:

@SupportedAnnotationTypes("com.example.MyAnnotation")
public class CompileTimeAnnotationProcessor extends AbstractProcessor {

    @Override
    public boolean process(Set<? extends TypeElement> annotations, 
                           RoundEnvironment roundEnv) {
        // Only one annotation, so just use annotations.iterator().next();
        Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(
                annotations.iterator().next());
        Set<VariableElement> fields = ElementFilter.fieldsIn(elements);
        for (VariableElement field : fields) {
            TypeMirror fieldType = field.asType();
            String fullTypeClassName = fieldType.toString();
            // Validate fullTypeClassName
        }
        return true;
    }
}

验证字段类型为java.lang.String(已编译)的示例验证:

for (VariableElement field : fields) {
    TypeMirror fieldType = field.asType();
    String fullTypeClassName = fieldType.toString();
    if (!String.class.getName().equals(fullTypeClassName)) {
        processingEnv.getMessager().printMessage(
                Kind.ERROR, "Field type must be java.lang.String", field);
    }
}

我想让字段类型获得该类型的注释。但这似乎并不可能?

确实有可能!这可以通过以下方法使用更多方法完成TypeMirror

if (fieldType.getKind() != TypeKind.DECLARED) {
    processingEnv.getMessager().printMessage(
            Kind.ERROR, "Field cannot be a generic type.", field);
}
DeclaredType declaredFieldType = (DeclaredType) fieldType;
TypeElement fieldTypeElement = (TypeElement) declaredFieldType.asElement();

从这里,你有两个选择:

  1. 如果正在尝试查找的注释已经被编译(即它来自另一个库),那么可以直接引用该类来获取注释。
  2. 如果正在尝试查找的注释未编译(例如,它正在编译当前javac正在运行APT的调用),那么可以通过AnnotationMirror实例来引用它。

已编译

DifferentAnnotation diffAnn = fieldTypeElement.getAnnotation(
        DifferentAnnotation.class);
// Process diffAnn

非常直接,这使你可以直接访问注释本身。

未编译

请注意,无论注释是否被编译,此解决方案都可以工作,但它不像上面的代码那么干净。

以下是我曾经写过的一些方法,用它的类名从注解镜像中提取某个值:

private static <T> T findAnnotationValue(Element element, String annotationClass,
        String valueName, Class<T> expectedType) {
    T ret = null;
    for (AnnotationMirror annotationMirror : element.getAnnotationMirrors()) {
        DeclaredType annotationType = annotationMirror.getAnnotationType();
        TypeElement annotationElement = (TypeElement) annotationType
                .asElement();
        if (annotationElement.getQualifiedName().contentEquals(
                annotationClass)) {
            ret = extractValue(annotationMirror, valueName, expectedType);
            break;
        }
    }
    return ret;
}

private static <T> T extractValue(AnnotationMirror annotationMirror,
        String valueName, Class<T> expectedType) {
    Map<ExecutableElement, AnnotationValue> elementValues = new HashMap<ExecutableElement, AnnotationValue>(
            annotationMirror.getElementValues());
    for (Entry<ExecutableElement, AnnotationValue> entry : elementValues
            .entrySet()) {
        if (entry.getKey().getSimpleName().contentEquals(valueName)) {
            Object value = entry.getValue().getValue();
            return expectedType.cast(value);
        }
    }
    return null;
}

假设你正在寻找DifferentAnnotation注释并且你的源代码如下所示:

@DifferentAnnotation(name = "My Class")
public class MyClass {

    @MyAnnotation
    private String field;

    // ...
}

此代码将打印My Class

String diffAnnotationName = findAnnotationValue(fieldTypeElement,
        "com.example.DifferentAnnotation", "name", String.class);
System.out.println(diffAnnotationName);

扫码关注云+社区

领取腾讯云代金券