CKTIS / Java
Четене на анотации на класове чрез рефлексия
Извличай повторяеми анотации като масив и проверявай за маркираща анотация. Разграничавай търсенето с наследяване от търсенето само в декларацията на класа.
Версия: Java SE 21
Синтаксис
On java.lang.Class<T> (instance methods; Annotation is java.lang.annotation.Annotation):
<A extends Annotation> A[] getAnnotationsByType(Class<A> annotationClass)
boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)
<A extends Annotation> A[] getDeclaredAnnotationsByType(Class<A> annotationClass)
<A extends Annotation> A getDeclaredAnnotation(Class<A> annotationClass)
Class literals: Child.class has type Class<Child>; Tag.class has type Class<Tag>.
Example call: Child.class.getAnnotationsByType(Tag.class)Литералът на клас Child.class дава обекта Class<Child>, който ще провериш; Tag.class дава обекта Class<Tag>, който определя търсения тип анотация. Това са методи на обект от тип Class: не е нужно да създаваш обект Child. За да четеш чрез рефлексия анотации върху декларации на класове, отбележи типа на анотацията с @Retention(RetentionPolicy.RUNTIME).
getAnnotationsByType(Tag.class) връща Tag[], а при липса на съвпадения — празен масив, не null. Методът извлича анотациите от контейнера, указан чрез @Repeatable, като запазва реда им в него. Ако търсеният тип има @Inherited и в класа няма съвпадение нито пряко, нито в контейнера, методът търси в суперкласовете, а не в интерфейсите. Не обединява резултати от различни нива. getDeclaredAnnotationsByType също извлича анотациите от контейнера, но проверява само разглеждания клас.
isAnnotationPresent(A.class) връща boolean и е равностоен на getAnnotation(A.class) != null. Полезен е за маркиращи анотации, които нямат елементи. Ако няма пряко съвпадение и търсеният тип има @Inherited, методът проверява суперкласовете, а не интерфейсите. Не проверява съдържанието на контейнера, затова повторения, съхранени само в него, не дават true при проверка за повторяемия тип. getDeclaredAnnotation проверява само за пряко съвпадение върху класа и връща null, ако няма такова.
Всички посочени методи, които приемат тип анотация, хвърлят NullPointerException при аргумент null. За да провериш за поне едно съвпадение, включително в контейнера, използвай getAnnotationsByType(Tag.class).length > 0.
Примери
import java.lang.annotation.*;
import java.util.Arrays;
public class AnnotationDemo {
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Inherited
@interface Flag {}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Inherited
@Repeatable(Tags.class)
@interface Tag { String value(); }
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Inherited
@interface Tags { Tag[] value(); }
@Flag
@Tag("alpha")
@Tag("beta")
static class Base {}
static class Child extends Base {}
@Tag("local")
static class Local extends Child {}
public static void main(String[] args) {
System.out.println("Child tags: " + values(Child.class.getAnnotationsByType(Tag.class)));
System.out.println("Child declared tags: " + Child.class.getDeclaredAnnotationsByType(Tag.class).length);
System.out.println("Child flag: " + Child.class.isAnnotationPresent(Flag.class));
System.out.println("Child declared flag: " + (Child.class.getDeclaredAnnotation(Flag.class) != null));
System.out.println("Base Tag present: " + Base.class.isAnnotationPresent(Tag.class));
System.out.println("Local tags: " + values(Local.class.getAnnotationsByType(Tag.class)));
}
private static String values(Tag[] tags) {
return Arrays.stream(tags).map(Tag::value).toList().toString();
}
}Резултат
Child tags: [alpha, beta] Child declared tags: 0 Child flag: true Child declared flag: false Base Tag present: false Local tags: [local]
`Child` наследява `@Flag` и двете срещания на `@Tag`, но не декларира нито едно от тях. Двете срещания на `@Tag` върху `Base` са в контейнера `@Tags`, затова проверката за наличие на `Tag.class` върху `Base` връща `false`. Собствената анотация `@Tag` на `Local` замества наследените срещания в резултата, вместо да се добавя към тях.
Свързани уроци
- Java · Урок 58 · Напреднало · Версия: 2
Източници
- Java SE 21 API — Class.getAnnotationsByType
- Java SE 21 API — Class.isAnnotationPresent
- Java SE 21 API — Class.getDeclaredAnnotationsByType
- Java SE 21 API — Class.getDeclaredAnnotation
- Java SE 21 API — AnnotatedElement: kinds of annotation presence
- Java SE 21 API — Inherited
- Java SE 21 API — RetentionPolicy.RUNTIME
- Java Language Specification, Java SE 21 — §9.6.3 Repeatable Annotation Interfaces
- Java Language Specification, Java SE 21 — §9.7.5 Multiple Annotations of the Same Interface
- Java Language Specification, Java SE 21 — §15.8.2 Class Literals