Como faço para forçar uma subclasse Java para definir uma anotação?
-
01-07-2019 - |
Pergunta
Se uma classe definida uma anotação, é de alguma forma possível forçar sua subclasse para definir a mesma anotação?
Por exemplo, temos um simples par de classe / subclasse que a parte @Author @interface.
O que eu gostaria de fazer é forçar cada novo subclasse para definir a mesma anotação @Author
, impedindo a algum lugar RuntimeException
abaixo da estrada.
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 {}
Eu sei que posso enumerar todas as anotações em tempo de execução e verificar a @Author
faltando, mas eu realmente gostaria de fazer isso em tempo de compilação, se possível.
Solução
Você pode fazer isso com JSR 269, em tempo de compilação. Veja: http://today.java.net/pub/a/today/2006/06/29/validate-java-ee-annotations-with-annotation-processors.html#pluggable- anotação de processamento-api
Outras dicas
Estou certo de que isso é impossível de fazer em tempo de compilação.
No entanto, esta é uma tarefa óbvia para uma "unidade" -teste. Se você tem convenções como este que você gostaria aplicada, mas que pode ser difícil ou impossível de verificar com o compilador, -Testes "unidade" são uma maneira simples de verificar-los.
Outra possibilidade é implementar uma regra personalizada em um analisador estático. Há muitas opções também.
(eu coloquei aparelho em assustar aspas, uma vez que este é realmente um teste de convenções, ao invés de uma unidade específica. Mas ele deve ser executado em conjunto com a sua unidade-testes).
Você poderia fazer uma anotação (por exemplo @EnforceAuthor) com @Inherited nas anotações superclasse e uso do compilador (desde Java 1.6) para recuperar o atraso em tempo de compilação. Então você tem uma referência para a subclasse e pode verificar se outra anotação (por exemplo @author)) está em falta. Isso permitiria que para cancelar a compilação com uma mensagem de erro.