CKTIS / Java
Čitanje anotacija klasa refleksijom
Dohvati ponovljive anotacije kao polje i provjeri prisutnost označne anotacije. Razlikuj pretraživanje s nasljeđivanjem od pretraživanja samo deklaracije klase.
Verzija: Java SE 21
Sintaksa
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)Literal klase Child.class daje objekt Class<Child> koji pregledavaš; Tag.class daje objekt Class<Tag> koji određuje traženi tip anotacije. Riječ je o metodama instance klase Class: ne moraš stvarati objekt Child. Za čitanje anotacija deklaracije klase refleksijom označi tip anotacije s @Retention(RetentionPolicy.RUNTIME).
getAnnotationsByType(Tag.class) vraća Tag[]; kad nema podudaranja, vraća prazno polje, a ne null. Iz spremnika određenog s @Repeatable izdvaja pojedinačne anotacije redoslijedom kojim su u njemu navedene. Ako traženi tip ima @Inherited i u klasi nema podudaranja ni izravno ni u spremniku, metoda pretražuje nadklase, a ne sučelja. Ne spaja rezultate s različitih razina. getDeclaredAnnotationsByType također raspakirava spremnik, ali provjerava samo pregledavanu klasu.
isAnnotationPresent(A.class) vraća boolean i odgovara izrazu getAnnotation(A.class) != null. Koristan je za označne anotacije, koje nemaju elemenata. Ako nema izravnog podudaranja i traženi tip ima @Inherited, metoda provjerava nadklase, a ne sučelja. Ne gleda u spremnik, pa ponavljanja koja su samo u njemu ne daju true za ponovljivi tip. getDeclaredAnnotation provjerava samo izravno podudaranje na klasi i vraća null ako ga nema.
Sve navedene metode koje primaju tip anotacije bacaju NullPointerException ako je argument null. Za provjeru barem jednog podudaranja, uključujući stavke u spremniku, upotrijebi getAnnotationsByType(Tag.class).length > 0.
Primjeri
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();
}
}Rezultat
Child tags: [alpha, beta] Child declared tags: 0 Child flag: true Child declared flag: false Base Tag present: false Local tags: [local]
`Child` nasljeđuje `@Flag` i obje pojave `@Tag`, ali ne deklarira nijednu. Obje pojave `@Tag` na `Base` pohranjene su u spremniku `@Tags`, pa provjera prisutnosti `Tag.class` na `Base` vraća `false`. Vlastita anotacija `@Tag` klase `Local` u rezultatu zamjenjuje naslijeđene pojave umjesto da im se pridruži.
Povezane lekcije
- Java · Lekcija 58 · Napredno · Verzija: 2
Izvori
- 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