CKTIS / Java
Čítanie anotácií tried pomocou reflexie
Načítajte opakovateľné anotácie ako pole a overujte prítomnosť značkovacej anotácie. Rozlišujte vyhľadávanie s dedením od vyhľadávania obmedzeného na deklaráciu triedy.
Verzia: Java SE 21
Syntax
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)Triedny literál Child.class poskytuje objekt Class<Child> skúmanej triedy; Tag.class poskytuje objekt Class<Tag>, ktorý určuje hľadaný typ anotácie. Ide o inštančné metódy triedy Class: objekt Child vytvárať netreba. Ak chcete čítať anotácie deklarácie triedy pomocou reflexie, označte typ anotácie metaanotáciou @Retention(RetentionPolicy.RUNTIME).
getAnnotationsByType(Tag.class) vráti Tag[], pri absencii zhody prázdne pole, nie null. Rozbalí kontajner určený pomocou @Repeatable a zachová poradie jeho položiek. Ak má hľadaný typ @Inherited a v triede nie je zhoda ani priamo, ani v kontajneri, metóda hľadá v nadtriedach, nie v rozhraniach. Výsledky z rôznych úrovní nespája. getDeclaredAnnotationsByType tiež rozbalí kontajner, ale kontroluje len skúmanú triedu.
isAnnotationPresent(A.class) vracia boolean a zodpovedá výrazu getAnnotation(A.class) != null. Hodí sa pre značkovacie anotácie, ktoré nemajú prvky. Ak neexistuje priama zhoda a hľadaný typ má @Inherited, metóda kontroluje nadtriedy, nie rozhrania. Do kontajnera sa nepozerá, takže opakovania uložené len v ňom nevedú k výsledku true pre opakovateľný typ. getDeclaredAnnotation kontroluje iba priamu zhodu v danej triede a inak vráti null.
Všetky uvedené metódy prijímajúce typ anotácie pri argumente null vyvolajú výnimku NullPointerException. Na overenie aspoň jednej zhody vrátane položiek v kontajneri použite getAnnotationsByType(Tag.class).length > 0.
Prí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ýsledok
Child tags: [alpha, beta] Child declared tags: 0 Child flag: true Child declared flag: false Base Tag present: false Local tags: [local]
`Child` dedí `@Flag` aj oba výskyty `@Tag`, ale žiadny z nich sám nedeklaruje. Oba výskyty `@Tag` na `Base` sú v kontajneri `@Tags`, preto test prítomnosti `Tag.class` na `Base` vráti `false`. Vlastná anotácia `@Tag` triedy `Local` vo výsledku nahradí zdedené výskyty, nepridá sa k nim.
Súvisiace lekcie
- Java · Lekcia 58 · Pokročilá · Verzia: 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