Java 6注解处理——从注解获取类

Question

我有一个名为 @Pojo 的自定义注释，用于自动 wiki 文档生成：

package com.example.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.METHOD)
public @interface Pojo {
    Class<?> value();
}

我这样使用它：

@Pojo(com.example.restserver.model.appointment.Appointment.class)

注释资源方法，以便注释处理器可以自动生成描述其所需资源和类型的 wiki 页面。

我需要读取注释处理器中 value 字段的值，但出现运行时错误。

在我的处理器的源代码中，我有以下几行：

final Pojo pojo = element.getAnnotation(Pojo.class);
// ...
final Class<?> pojoJavaClass = pojo.value();

但实际的类不可用于处理器。我想我需要一个 javax.lang.model.type.TypeMirror 作为真实类的替代。我不知道如何获得一个。

我收到的错误是：

javax.lang.model.type.MirroredTypeException: Attempt to access Class object for TypeMirror com.example.restserver.model.appointment.Appointment

Appointment 是我的一个 @Pojo 注释中提到的一个类。

不幸的是，有关 Java 注释处理的文档和/或教程似乎很少。尝试过谷歌搜索。

Answer 1

我来这里是为了问完全相同的问题。 ...并发现相同的 博客链接由拉尔夫发布。

文章很长，但是内容很丰富。故事摘要——有两种方法可以做到这一点，简单的方法和“更正确”的方法。

这是简单的方法：

private static TypeMirror getMyValue1(MyAnnotation annotation) {
    try
    {
        annotation.myValue(); // this should throw
    }
    catch( MirroredTypeException mte )
    {
        return mte.getTypeMirror();
    }
    return null; // can this ever happen ??
}

另一种更乏味的方法（无一例外）：

private static AnnotationMirror getAnnotationMirror(TypeElement typeElement, Class<?> clazz) {
    String clazzName = clazz.getName();
    for(AnnotationMirror m : typeElement.getAnnotationMirrors()) {
        if(m.getAnnotationType().toString().equals(clazzName)) {
            return m;
        }
    }
    return null;
}

private static AnnotationValue getAnnotationValue(AnnotationMirror annotationMirror, String key) {
    for(Entry<? extends ExecutableElement, ? extends AnnotationValue> entry : annotationMirror.getElementValues().entrySet() ) {
        if(entry.getKey().getSimpleName().toString().equals(key)) {
            return entry.getValue();
        }
    }
    return null;
}


public TypeMirror getMyValue2(TypeElement foo) {
    AnnotationMirror am = getAnnotationMirror(foo, MyAnnotation.class);
    if(am == null) {
        return null;
    }
    AnnotationValue av = getAnnotationValue(am, "myValue");
    if(av == null) {
        return null;
    } else {
        return (TypeMirror)av.getValue();
    }
}

当然，一旦你得到了 TypeMirror，你（至少以我的经验）几乎总是想要一个 TypeElement 来代替：

private TypeElement asTypeElement(TypeMirror typeMirror) {
    Types TypeUtils = this.processingEnv.getTypeUtils();
    return (TypeElement)TypeUtils.asElement(typeMirror);
}

...最后一点不明显在我第一次把它解决之前，我花了一个小时的时间来拉头发。这些注释处理器实际上并不难编写，只是 API 一开始非常令人困惑，而且冗长得令人费解。我很想推出一个帮助程序类，使所有基本操作变得显而易见......但这是另一天的故事（如果你想要的话，请给我留言）。

Answer 2

您读过这篇文章吗： http://blog.retep.org/2009/02/13/getting-class-values-from-annotations-in-an-annotationprocessor/？

这里的技巧是实际使用 getAnnotation() 并捕获 MirroredTypeException。令人惊讶的是，异常随后提供了所需类的 TypeMirror。

我不知道这是否是一个好的解决方案，但它是一个。以我个人的观点，我会尝试获取 MirroredType 背后的类型，但我不知道这是否可能。

Answer 3

我的回答与 Dave Dopson 的基本相同，只是代码稍作改动：

public default Optional<? extends AnnotationMirror> getAnnotationMirror( final Element element, final Class<? extends Annotation> annotationClass )
{
    final var annotationClassName = annotationClass.getName();
    final Optional<? extends AnnotationMirror> retValue = element.getAnnotationMirrors().stream()
        .filter( m -> m.getAnnotationType().toString().equals( annotationClassName ) )
        .findFirst();

    return retValue;
}

他的代码使用 TypeElement 作为 getAnnotationMirror() 第一个参数的类型，限制该方法仅用于类。将其更改为 Element 使其可用于任何带注释的元素。
使用基于流的实现而不是原始的 for 循环只是一个品味问题。

public default Optional<? extends AnnotationValue> getAnnotationValue( final AnnotationMirror annotationMirror, final String name )
{
    final Elements elementUtils = this.processingEnv.getElementUtils();
    final Map<? extends ExecutableElement, ? extends AnnotationValue> elementValues = elementUtils.getElementValuesWithDefaults( annotationMirror );
    final Optional<? extends AnnotationValue> retValue = elementValues.keySet().stream()
        .filter( k -> k.getSimpleName().toString().equals( name ) )
        .map( k -> elementValues.get( k ) )
        .findAny();

    return retValue;
}

Dave 使用 Element.getElementValues() 来获取注释值，但这仅返回那些显式应用于具体注释的值。默认值将被省略。
方法 Elements.getElementValuesWithDefaults() 还将返回默认值（您可能已经从它的名称中猜到了）。

Answer 4

这是我的技巧：

public class APUtils {

  @FunctionalInterface
  public interface GetClassValue {
    void execute() throws MirroredTypeException, MirroredTypesException;
  }

  public static List<? extends TypeMirror> getTypeMirrorFromAnnotationValue(GetClassValue c) {
    try {
      c.execute();
    }
    catch(MirroredTypesException ex) {
      return ex.getTypeMirrors();
    }
    return null;
  }

}

然后我可以与任何注释值一起使用：

public @interface MyAnnotationType {
  public Class<?>[] value() default {};
}

示例

@MyAnnotationType(String.class)
public class Test { ... }

注释处理器中的

MyAnnotationType a = element.getAnnotation(MyAnnotationType.class);
List<? extends TypeMirror> types = APUtils.getTypeMirrorFromAnnotationValue(() -> a.value());

用法使用 JDK 1.8.0_192 进行测试