CKTIS / Java
Čtení anotací tříd pomocí reflexe
Načítejte opakovatelné anotace jako pole a ověřujte přítomnost značkovací anotace. Rozlišujte hledání s děděním od hledání omezeného na deklaraci dané třídy.
Verze: Java SE 21
Syntaxe
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)Třídní literál Child.class poskytne objekt Class<Child> zkoumané třídy; Tag.class poskytne objekt Class<Tag> určující hledaný typ anotace. Jde o instanční metody třídy Class: objekt Child při tom nevytváříte. Aby šlo anotace deklarace třídy číst pomocí reflexe, opatřete typ anotace metaanotací @Retention(RetentionPolicy.RUNTIME).
getAnnotationsByType(Tag.class) vrací Tag[], při absenci výsledků prázdné pole, nikoli null. Rozbalí kontejner určený pomocí @Repeatable a zachová pořadí jeho položek. Pokud má hledaný typ @Inherited a na třídě není žádná odpovídající anotace ani přímo, ani v kontejneru, metoda hledá v nadtřídách, nikoli v rozhraních. Výsledky z různých úrovní neslučuje. getDeclaredAnnotationsByType kontejner také rozbalí, ale kontroluje jen zkoumanou třídu.
isAnnotationPresent(A.class) vrací boolean a odpovídá výrazu getAnnotation(A.class) != null. Hodí se pro značkovací anotace, které nemají žádné prvky. Pokud na třídě není přímá shoda a hledaný typ má @Inherited, metoda kontroluje nadtřídy, nikoli rozhraní. Do kontejneru se nedívá, takže opakování uložená pouze v něm nedají pro opakovatelný typ výsledek true. getDeclaredAnnotation hledá pouze přímou shodu na třídě, a pokud žádná není, vrátí null.
Všechny uvedené metody přijímající typ anotace vyvolají při argumentu null výjimku NullPointerException. Alespoň jednu shodu, včetně položek v kontejneru, ověříte pomocí getAnnotationsByType(Tag.class).length > 0.
Příklady
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();
}
}Výsledek
Child tags: [alpha, beta] Child declared tags: 0 Child flag: true Child declared flag: false Base Tag present: false Local tags: [local]
`Child` dědí `@Flag` i oba výskyty `@Tag`, ale žádný sám nedeklaruje. Oba výskyty `@Tag` na `Base` jsou v kontejneru `@Tags`, takže test přítomnosti `Tag.class` na `Base` vrátí `false`. Vlastní `@Tag` třídy `Local` ve výsledku zděděné výskyty nahradí, místo aby se k nim přidal.
Související lekce
- Java · Lekce 58 · Pokročilá · Verze: 2
Zdroje
- 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