CKTIS / Java
Klasseannotaties uitlezen met reflectie
Lees herhaalbare annotaties uit als array en controleer of een markerannotatie aanwezig is. Maak onderscheid tussen zoeken in superklassen en zoeken in alleen de klassedeclaratie.
Versie: 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)De klasseliteral Child.class geeft het te onderzoeken Class<Child>-object; Tag.class geeft het Class<Tag>-object dat het gezochte annotatietype aanduidt. Dit zijn instantiemethoden op Class: je hoeft geen Child-object te maken. Voor reflectieve toegang tot annotaties op een klassedeclaratie voorzie je het annotatietype van @Retention(RetentionPolicy.RUNTIME).
getAnnotationsByType(Tag.class) retourneert een Tag[]; zonder treffers krijg je een lege array, niet null. De methode haalt de annotaties uit de door @Repeatable aangewezen container, in de volgorde waarin ze daarin staan. Heeft het gezochte type @Inherited en is er op de klasse geen treffer, direct noch in de container, dan zoekt de methode in superklassen, niet in interfaces. Ze voegt geen treffers uit verschillende niveaus samen. getDeclaredAnnotationsByType pakt de container ook uit, maar bekijkt alleen de onderzochte klasse.
isAnnotationPresent(A.class) retourneert een boolean en is gelijkwaardig aan getAnnotation(A.class) != null. Dit is handig voor markerannotaties, die geen elementen hebben. Is er geen directe treffer en heeft het gezochte type @Inherited, dan controleert de methode superklassen, niet interfaces. Ze kijkt niet in de container: herhalingen die alleen daarin staan, leveren geen true op voor het herhaalbare type. getDeclaredAnnotation controleert alleen op een directe treffer op de klasse en retourneert anders null.
Alle genoemde methoden die een annotatietype aannemen, gooien een NullPointerException bij een null-argument. Gebruik getAnnotationsByType(Tag.class).length > 0 om te testen op minstens één treffer, inclusief treffers in de container.
Voorbeelden
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();
}
}Resultaat
Child tags: [alpha, beta] Child declared tags: 0 Child flag: true Child declared flag: false Base Tag present: false Local tags: [local]
`Child` erft `@Flag` en beide voorkomens van `@Tag`, maar declareert er zelf geen. De twee voorkomens van `@Tag` op `Base` zitten in de container `@Tags`, dus de aanwezigheidscontrole voor `Tag.class` op `Base` geeft `false`. De eigen `@Tag` van `Local` komt in het resultaat in de plaats van de geërfde voorkomens en wordt er niet aan toegevoegd.
Gerelateerde lessen
- Java · Les 58 · Gevorderd · Versie: 2
Bronnen
- 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