Поле доступа к константе в процессоре аннотаций

Question

Предположим, что класс определяет постоянное поле:

public class Foo {
  public static final int CONSTANT_FIELD = 3;
}

И предположим, что интерфейс аннотации объявлен следующим образом:

public @interface Something {
  int value();
}

Наконец, предположим, что аннотация используется следующим образом:

@Something(Foo.CONSTANT_FIELD)

Вопрос: Как обработчик аннотации получить элемент для CONSTANT_FIELD от его использования в установке значения @Something?

---

Изменить: Включение конкретного примера в сам вопрос.

У меня есть аннотация, которая используется следующим образом:

@RuleDependency(recognizer = BQLParser.class,
                rule = BQLParser.RULE_statement,
                version = 0)

Обработчик аннотаций должен знать, что RULE_statement константа, определенная в BQLParser учебный класс. Если бы я мог получить доступ к Element за BQLParser.RULE_statement непосредственно от установки rule свойство аннотации, это устранит необходимость recognizer имущество. Эта аннотация используется тысячи раз в реальных приложениях, и recognizer всегда просто декларирующий тип rule постоянная. Решение этого вопроса упростит использование аннотации до следующего:

@RuleDependency(rule = BQLParser.RULE_statement, version = 0)

Answer 1

Мне удалось реализовать эту функцию с помощью API деревьев компиляции.

1. Обновите файл pom.xml, включив в него следующие профили, чтобы убедиться, что на tools.jar есть ссылки в системах, где на него нет ссылок по умолчанию.

   <profiles>
       <profile>
           <!-- Java 6 and earlier have java.vendor set to "Sun Microsystems Inc." -->
           <id>default-tools-6.jar</id>
           <activation>
               <property>
                   <name>java.vendor</name>
                   <value>Sun Microsystems Inc.</value>
               </property>
           </activation>
           <dependencies>
               <dependency>
                   <groupId>com.sun</groupId>
                   <artifactId>tools</artifactId>
                   <version>1.6</version>
                   <scope>system</scope>
                   <systemPath>${java.home}/../lib/tools.jar</systemPath>
               </dependency>
           </dependencies>
       </profile>
   
       <profile>
           <!-- Java 7 and later have java.vendor set to "Oracle Corporation" -->
           <id>default-tools.jar</id>
           <activation>
               <property>
                   <name>java.vendor</name>
                   <value>Oracle Corporation</value>
               </property>
           </activation>
           <dependencies>
               <dependency>
                   <groupId>com.sun</groupId>
                   <artifactId>tools</artifactId>
                   <version>1.6</version>
                   <scope>system</scope>
                   <systemPath>${java.home}/../lib/tools.jar</systemPath>
               </dependency>
           </dependencies>
       </profile>
   </profiles>
   

2. Override Processor.init получить экземпляр Trees,

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

3. Реализовать TreePathScanner<TypeMirror, Void>, который используется для получения TypeMirror декларирующего типа, назначенного rule собственность в аннотации.

   private class AnnotationVisitor extends TreePathScanner<TypeMirror, Void> {
       @Override
       public TypeMirror visitAnnotation(AnnotationTree node, Void p) {
           for (ExpressionTree expressionTree : node.getArguments()) {
               if (!(expressionTree instanceof AssignmentTree)) {
                   continue;
               }
   
               AssignmentTree assignmentTree = (AssignmentTree)expressionTree;
               ExpressionTree variable = assignmentTree.getVariable();
               if (!(variable instanceof IdentifierTree) || !((IdentifierTree)variable).getName().contentEquals("rule")) {
                   continue;
               }
   
               return scan(expressionTree, p);
           }
   
           return null;
       }
   
       @Override
       public TypeMirror visitAssignment(AssignmentTree at, Void p) {
           return scan(at.getExpression(), p);
       }
   
       @Override
       public TypeMirror visitMemberSelect(MemberSelectTree mst, Void p) {
           return scan(mst.getExpression(), p);
       }
   
       @Override
       public TypeMirror visitIdentifier(IdentifierTree it, Void p) {
           return trees.getTypeMirror(this.getCurrentPath());
       }
   }
   

4. Укажите значение по умолчанию для recognizer имущество. Я хотел бы, чтобы это могло быть null но Java явно запрещает это...

   /**
    * Gets the recognizer class where the dependent parser rules are defined.
    * This may reference the generated parser class directly, or for simplicity
    * in certain cases, any class derived from it.
    * <p>
    * If this value is not specified, the default value {@link Parser}
    * indicates that the declaring type of the constant value specified for
    * {@link #rule} should be used as the recognizer type.
    * </p>
    */
   Class<? extends Recognizer<?, ?>> recognizer() default Parser.class;
   

5. Обновите код, который собирает информацию о RuleDependency аннотации, применяемые к конкретному Element экземпляры в коде, чтобы сначала попытаться получить доступ к recognizer свойство, и если оно не указано, используйте объявленный тип константы в rule собственность вместо Обработка ошибок опущена в этом примере кода для краткости.

   RuleDependency dependency = element.getAnnotation(RuleDependency.class);
   
   // first try to get the parser type from the annotation
   TypeMirror recognizerType = getRecognizerType(dependency);
   if (recognizerType != null && !recognizerType.toString().equals(Parser.class.getName())) {
       result.add(new Triple<RuleDependency, TypeMirror, Element>(dependency, recognizerType, element));
       continue;
   }
   
   // fallback to compiler tree API
   AnnotationMirror annotationMirror = null;
   for (AnnotationMirror mirror : element.getAnnotationMirrors()) {
       if (processingEnv.getTypeUtils().isSameType(ruleDependencyTypeElement.asType(), mirror.getAnnotationType())) {
           annotationMirror = mirror;
           break;
       }
   }
   
   AnnotationValue annotationValue = null;
   for (Map.Entry<? extends ExecutableElement, ? extends AnnotationValue> entry : annotationMirror.getElementValues().entrySet()) {
       if (entry.getKey().getSimpleName().contentEquals("rule")) {
           annotationValue = entry.getValue();
           break;
       }
   }
   
   TreePath treePath = trees.getPath(element, annotationMirror, annotationValue);
   AnnotationVisitor visitor = new AnnotationVisitor();
   recognizerType = visitor.scan(treePath, null);
   
   result.add(new Triple<RuleDependency, TypeMirror, Element>(dependency, recognizerType, element));
   

Answer 2

Если rule является intдля процессора аннотаций будет невозможно выяснить, где это int был определен. Тем не менее, вы могли бы использовать enum вместо int для rule здесь и сгруппируйте ваши правила со ссылками на их парсеры. Может быть, что-то вроде этого:

Интерфейс парсера:

public interface RuleParser {
}

Пример реализации:

public class RuleParserImpl implements RuleParser {
}

Правило enum:

public enum Rule {

    RULE_STATEMENT(RuleParserImpl.class);

    private final Class<? extends RuleParser> ruleParserClass;

    private Rule(Class<? extends RuleParser> ruleParser) {
        this.ruleParserClass = ruleParser;
    }

    public Class<? extends RuleParser> getRuleParserClass() {
        return ruleParserClass;
    }
}

Аннотация с enum вместо поля int:

@Retention(RetentionPolicy.RUNTIME)
public @interface RuleDependency {
    Rule rule();
}

Пример использования:

@RuleDependency(rule = Rule.RULE_STATEMENT)
public class RuleProcessor {

    public static void main(String[] args) {
        RuleDependency ruleDependency = RuleProcessor.class.getAnnotation(RuleDependency.class);
        Rule rule = ruleDependency.rule();
        Class<? extends RuleParser> ruleParserClass = rule.getRuleParserClass();
        System.out.println(ruleParserClass); //Prints "class RuleParserImpl"
    }
}

Надеюсь, что это дает вам некоторые идеи.