如何强制 Java 子类定义 Annotation？

Question

如果一个类定义了一个注释，是否可以强制其子类定义相同的注释？

例如，我们有一个简单的类/子类对，它们共享@Author @interface。 我想要做的是强制每个进一步的子类定义相同的 @Author 注释，防止将来某个地方出现 RuntimeException 。

TestClass.java：TestSubClass.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 ) );
    }
}

：

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

我知道我可以在运行时枚举所有注释并检查缺少的 @Author，但如果可能的话，我真的很想在编译时执行此操作。

Answer 1

您可以在超类上使用@Inherited 进行注释（例如@EnforceAuthor），并使用编译器注释（自Java 1.6 起）在编译时赶上。 然后您就有了对子类的引用，并且可以检查是否缺少另一个注释（例如@Author））。 这将允许取消编译并显示错误消息。

Answer 2

我非常确定这在编译时是不可能做到的。

然而，这对于“单元”测试来说是一项显而易见的任务。 如果您希望强制执行这样的约定，但编译器很难或不可能检查这些约定，那么“单元”测试是检查它们的简单方法。

另一种可能性是在静态分析器中实现自定义规则。 这里也有很多选择。

（我将单元放在引号中，因为这实际上是对约定的测试，而不是对特定单元的测试。但它应该与单元测试一起运行）。

Answer 3

您可以在编译时使用 JSR 269 来做到这一点。
请参阅：http://today.java.net/pub/a/today/2006/06/29/validate-java-ee-annotations-with-annotation-processors.html#pluggable- Comments-processing-api

编辑 2020-09-20：链接已失效，存档版本在这里：https://web.archive.org/web/ 20150516080739/http://today.java.net/pub/a/today/2006/06/29/validate-java-ee-annotations-with-annotation-processors.html