问题
如果一个类定义了一个注解,是否可以强制其子类定义相同的注解?
例如,我们有一个简单的类/子类对,它们共享@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,但如果可能的话,我真的很想在编译时这样做。
解决方案
您可以在超类上使用@Inherited 创建一个注释(例如@EnforceAuthor),并使用编译器注释(从Java 1.6 开始)在编译时赶上。然后你有一个对子类的引用,并且可以检查是否缺少另一个注释(例如@Author)。这将允许取消编译并显示错误消息。
但是,对于“单元”测试来说,这是一项显而易见的任务。如果你有这样的约定,你想强制执行,但很难或不可能用编译器检查,“单元”测试是检查它们的简单方法。
另一种可能性是在静态分析器中实现自定义规则。这里也有很多选择。
(我把单元放在引号中,因为这实际上是对约定的测试,而不是对特定单元的测试。但它应该与您的单元测试一起运行)。
原文链接:如何强制 Java 子类定义注解?