如何强制 Java 子类定义 Annotation?
-
01-07-2019 - |
题
如果一个类定义了一个注释,是否可以强制其子类定义相同的注释?
例如,我们有一个简单的类/子类对,它们共享 @Author @interface.
我想做的是强制每个进一步的子类定义相同的 @Author
注释,防止 RuntimeException
沿着路的某个地方。
测试类.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 ) );
}
}
测试子类.java:
@Author( name = "bar" )
public abstract class TestSubClass extends TestClass {}
我知道我可以在运行时枚举所有注释并检查丢失的注释 @Author
, ,但如果可能的话,我真的很想在编译时执行此操作。
其他提示
我非常确定这在编译时是不可能做到的。
然而,这对于“单元”测试来说是一项显而易见的任务。如果您希望强制执行这样的约定,但编译器很难或不可能检查这些约定,那么“单元”测试是检查它们的简单方法。
另一种可能性是在静态分析器中实现自定义规则。这里也有很多选择。
(我将单位放在引号中,因为这实际上是对约定的测试,而不是对特定单位的测试。但它应该与您的单元测试一起运行)。
您可以做一个注释(例如@EnforceAuthor)与超类上的 @Inherited 并使用编译器注释(自 Java 1.6 起)在编译时赶上。然后您就有了对子类的引用,并且可以检查是否有另一个注释(例如@作者))丢失了。这将允许取消编译并显示错误消息。
不隶属于 StackOverflow