Как захватить Enum из AnnotationValue в обработчике аннотаций - PullRequest
Новая
       65

Как захватить Enum из AnnotationValue в обработчике аннотаций

5 голосов
/ 21 июня 2010

Я пытаюсь прочитать значение перечисления в аннотации, используя процессор аннотаций и зеркало аннотаций, но я получаю нулевое значение.Я думаю, что это связано с тем, что AnnotationValue упаковывает Enum в качестве VariableElement.Документ для VariableElement # getConstantValue () говорит: «Возвращает значение этой переменной, если это последнее поле, инициализированное константой времени компиляции».Хорошо, но final не является допустимым модификатором для элемента аннотации.Также следует отметить, что у меня нет проблем с чтением других значений аннотаций, только перечисления.

Я сделал некоторые утешения, и создается впечатление, что AnnotationValue создается во время выполнения как Symbol.VarSymbol, но Symbol.VarSymbol #getConstantValue () выглядит так, как будто он должен просто возвращать объект.

Наконец, если я делаю toString () для AnnotationValue, я получаю правильное значение.

Аннотация: 

package annotation;
public @interface AnAnnotation
{
    String value();
    Behavior defaultBehavior() default Behavior.NEW;

    public static enum Behavior
    {
        NEW, NULL;
    }
}

Часть моего Процессора, вложенная во множество циклов, чтобы получить правильное AnnotaionMirror: 

Map<? extends ExecutableElement, ? extends AnnotationValue> annotationValues = elemUtils.getElementValuesWithDefaults(annotationMirror);
for (ExecutableElement method : annotationValues.keySet())
{
    ...
    else if ("defaultBehavior".equals(method.getSimpleName().toString()))
    {

        defaultBehavior = (Behavior)( (VariableElement)annotationValues.get(method).getValue()).getConstantValue();

        // This prints "NEW" or "NULL" correctly
        processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE,annotationValues.get(method).toString());
        // This prints null incorrectly (expect "NEW" or "NULL")
        processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE, defaultBehavior + "");

    }
    ...
}

РЕДАКТИРОВАТЬ: более полную версию Процессора. 

package annotation.processor;

import java.util.*;

import javax.annotation.processing.*;
import javax.lang.model.element.*;
import javax.lang.model.type.*;
import javax.lang.model.util.*;
import javax.tools.*;

import annotation.AnAnnotation;
import annotation.AnAnnotation.Behavior;

@SupportedAnnotationTypes("annotation.AnAnnotation")
public class AnAnnotationProcessor extends AbstractProcessor
{
    Types typeUtils;
    Elements elemUtils;

    @Override
    public void init(ProcessingEnvironment processingEnv)
    {
        super.init(processingEnv);
        typeUtils = processingEnv.getTypeUtils();
        elemUtils = processingEnv.getElementUtils();
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations,
                           RoundEnvironment roundEnv)
    {
        processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE,
            "Entering AnnotationNullableClassProcessor");

        /****** Iterate over all annotaions being processed (only AnAnnotation) ******/
        for (TypeElement annotation : annotations)
        {
            /****** Iterate over all elements that are annotated with the annotation ******/
            for (Element element : roundEnv.getElementsAnnotatedWith(annotation))
            {
                /****** Iterate over all the declared annotations of the element ******/
                for (AnnotationMirror annotationMirror :  element.getAnnotationMirrors())
                {
                    final String annotationTypeName = annotationMirror.getAnnotationType().toString();

                    // Process annotations of type AnAnnotation
                    if (annotationTypeName.equals(AnAnnotation.class.getName()))
                    {
                        Map<? extends ExecutableElement, ? extends AnnotationValue> annotationValues = elemUtils.getElementValuesWithDefaults(annotationMirror);

                        /****** Iterate over the annotation's values. ******/
                        for (ExecutableElement method : accessorValues.keySet())
                        {
                            if ("defaultBehavior".equals(method.getSimpleName().toString()))
                            {
                                Behavior defaultBehavior = (Behavior)( (VariableElement)annotationValues.get(method).getValue()).getConstantValue();

                                // This prints "NEW" or "NULL" correctly
                                processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE,annotationValues.get(method).toString());
                                // This prints null incorrectly (expect "NEW" or "NULL")
                                processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE, defaultBehavior + "");
                            }
                        }
                    }
                }
            }
        }

        return true;
    }
}

Ответы [ 2 ]

3 голосов
/ 22 июня 2010

Из документации по getConstantValue:

"В частности, константы enum не считаются константами времени компиляции. Чтобы иметь постоянное значение, тип поля должен быть либо примитивным типом, либо String."

http://java.sun.com/javase/6/docs/api/javax/lang/model/element/VariableElement.html#getConstantValue()

Чтобы получить значение константы перечисления, используйте API getAnnotation или AnnotationValueVisitor.

1 голос
/ 21 марта 2012

У меня была проблема, аналогичная вашей (за исключением того, что я не имел дело с перечислениями, мне нужно было значение не-String / не примитивной константы), и я решил ее, получив доступ к исходному коду через CompilerДерево API .

Вот общий рецепт:

1.Создайте пользовательский TreePathScanner: 

private static class CodeAnalyzerTreeScanner extends TreePathScanner<Object, Trees> {

private String fieldName;

private String fieldInitializer;

public void setFieldName(String fieldName) {
    this.fieldName = fieldName;
}

public String getFieldInitializer() {
    return this.fieldInitializer;
}

@Override
public Object visitVariable(VariableTree variableTree, Trees trees) {
    if (variableTree.getName().toString().equals(this.fieldName)) {
        this.fieldInitializer = variableTree.getInitializer().toString();
    }

    return super.visitVariable(variableTree, trees);
}

2.В вашем AbstractProcessor сохраните ссылку на текущее дерево компиляции, переопределив метод init: 

@Override
public void init(ProcessingEnvironment pe) {
    super.init(pe);
    this.trees = Trees.instance(pe);
}

3.Получите исходный код инициализации для VariableElement (в вашем случае перечисление): 

// assuming theClass is a javax.lang.model.element.Element reference
// assuming theField is a javax.lang.model.element.VariableElement reference
String fieldName = theField.getSimpleName().toString();
CodeAnalyzerTreeScanner codeScanner = new CodeAnalyzerTreeScanner();
TreePath tp = this.trees.getPath(theClass);

codeScanner.setFieldName(fieldName);
codeScanner.scan(tp, this.trees);
String fieldInitializer = codeScanner.getFieldInitializer();

И это все!После этого вы сможете получить значение инициализации для аннотированного поля, которое вы не можете получить с помощью VariableElement.getContantValue (т. Е. Любой «константы», которая не является String или примитивом).больше чтения и примеров читайте в этой статье : Анализ исходного кода с использованием API Java 6 .

...