Как мне заставить подкласс Java определять аннотацию?
-
01-07-2019 - |
Вопрос
Если класс определил аннотацию, возможно ли каким-то образом заставить его подкласс определить ту же аннотацию?
Например, у нас есть простая пара класс / подкласс, которые совместно используют @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
, но я бы действительно хотел сделать это во время компиляции, если это возможно.
Решение
Вы можете сделать это с помощью JSR 269 во время компиляции.Видишь : http://today.java.net/pub/a/today/2006/06/29/validate-java-ee-annotations-with-annotation-processors.html#pluggable-annotation-processing-api
Другие советы
Я совершенно уверен, что это невозможно сделать во время компиляции.
Однако это очевидная задача для "модульного" теста.Если у вас есть соглашения, подобные этому, которые вы хотели бы применить, но которые может быть трудно или невозможно проверить с помощью компилятора, "модульные" тесты - это простой способ проверить их.
Другая возможность заключается в реализации пользовательского правила в статическом анализаторе.Здесь тоже есть много вариантов.
(Я заключил единицу измерения в кавычки, поскольку это действительно проверка условностей, а не конкретной единицы измерения.Но он должен запускаться вместе с вашими модульными тестами).
Вы могли бы сделать аннотацию (например,@EnforceAuthor) с @Inherited в суперклассе и использовать аннотации компилятора (начиная с Java 1.6), чтобы наверстать упущенное во время компиляции.Затем у вас есть ссылка на подкласс, и вы можете проверить, есть ли другая аннотация (например@Author)) отсутствует.Это позволило бы отменить компиляцию с сообщением об ошибке.