Как заставить подкласс Java определить аннотацию? - PullRequest
Новая
       21

Как заставить подкласс Java определить аннотацию?

11 голосов
/ 18 сентября 2008

Если класс определил аннотацию, возможно ли каким-либо образом заставить его подкласс определить ту же аннотацию?

Например, у нас есть простая пара класс / подкласс, которая разделяет @Author @interface. То, что я хотел бы сделать, это заставить каждый следующий подкласс определять ту же самую аннотацию @Author, предотвращая RuntimeException где-то в будущем.

TestClass.java: 

import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME)
@interface Author { String name(); }

@Author( name = "foo" )
public abstract class TestClass
{
    public static String getInfo( Class<? extends TestClass> c )
    {
        return c.getAnnotation( Author.class ).name();
    }

    public static void main( String[] args )
    {
        System.out.println( "The test class was written by "
                        + getInfo( TestClass.class ) );
        System.out.println( "The test subclass was written by " 
                        + getInfo( TestSubClass.class ) );
    }
}

TestSubClass.java: 

@Author( name = "bar" )
public abstract class TestSubClass extends TestClass {}

Я знаю, что могу перечислить все аннотации во время выполнения и проверить отсутствие @Author, но я бы очень хотел сделать это во время компиляции, если это возможно.

Ответы [ 3 ]

4 голосов
/ 18 октября 2008

Вы можете сделать это с JSR 269 во время компиляции. Смотри: http://today.java.net/pub/a/today/2006/06/29/validate-java-ee-annotations-with-annotation-processors.html#pluggable-annotation-processing-api

3 голосов
/ 18 сентября 2008

Я совершенно уверен, что это невозможно сделать во время компиляции.

Однако, это очевидная задача для «юнит-теста». Если у вас есть подобные соглашения, которые вы хотели бы применять, но которые может быть трудно или невозможно проверить с помощью компилятора, тесты «unit» - это простой способ проверить их.

Еще одна возможность - реализовать пользовательское правило в статическом анализаторе. Здесь тоже есть много вариантов.

(Я помещаю единицу в кавычки, так как это действительно тест соглашений, а не конкретного юнита. Но он должен работать вместе с вашими юнит-тестами).

2 голосов
/ 18 сентября 2008

Вы можете создать аннотацию (например, @EnforceAuthor) с @Inherited для суперкласса и использовать аннотации компилятора (начиная с Java 1.6), чтобы наверстать упущенное во время компиляции. Затем у вас есть ссылка на подкласс, и вы можете проверить, отсутствует ли другая аннотация (например, @Author)). Это позволит отменить компиляцию с сообщением об ошибке.

...