Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / Java

Odczytywanie adnotacji klas za pomocą refleksji

Odczytuj powtarzalne adnotacje jako tablicę i sprawdzaj obecność adnotacji znacznikowej. Rozróżniaj wyszukiwanie z dziedziczeniem od odczytu ograniczonego do deklaracji klasy.

Wersja: Java SE 21

Składnia

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)

Literał klasy Child.class daje obiekt Class<Child> reprezentujący badaną klasę; Tag.class daje obiekt Class<Tag> wskazujący typ szukanej adnotacji. To metody instancyjne Class: nie trzeba tworzyć obiektu Child. Aby odczytać adnotacje deklaracji klasy przez refleksję, oznacz typ adnotacji metaanotacją @Retention(RetentionPolicy.RUNTIME).

getAnnotationsByType(Tag.class) zwraca Tag[], a przy braku dopasowań — pustą tablicę, nie null. Rozpakowuje kontener wskazany przez @Repeatable, zachowując kolejność elementów w kontenerze. Jeśli klasa nie ma adnotacji szukanego typu ani bezpośrednio, ani w kontenerze, a typ ma @Inherited, metoda szuka w nadklasach, nie w interfejsach. Nie łączy wyników z różnych poziomów hierarchii. getDeclaredAnnotationsByType też rozpakowuje kontener, ale sprawdza tylko badaną klasę.

isAnnotationPresent(A.class) zwraca boolean i odpowiada wyrażeniu getAnnotation(A.class) != null. Nadaje się do sprawdzania znaczników, czyli adnotacji bez elementów. Gdy szukanej adnotacji nie ma bezpośrednio na klasie i jej typ ma @Inherited, metoda szuka w nadklasach, nie w interfejsach. Nie zagląda do kontenera, więc sama obecność powtórzeń w kontenerze nie daje wyniku true dla typu powtarzalnego. getDeclaredAnnotation sprawdza tylko adnotację bezpośrednią i zwraca null, jeśli jej nie ma.

Wszystkie wymienione metody przyjmujące typ adnotacji zgłaszają NullPointerException dla argumentu null. Do sprawdzania, czy istnieje choć jedna adnotacja, również ukryta w kontenerze, użyj getAnnotationsByType(Tag.class).length > 0.

Przykłady

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();
    }
}

Wynik

Child tags: [alpha, beta]
Child declared tags: 0
Child flag: true
Child declared flag: false
Base Tag present: false
Local tags: [local]

`Child` dziedziczy `@Flag` i oba wystąpienia `@Tag`, ale sam nie deklaruje żadnego z nich. Dwa wystąpienia `@Tag` na `Base` są zapisane w kontenerze `@Tags`, dlatego test obecności `Tag.class` na `Base` zwraca `false`. Własna adnotacja `@Tag` klasy `Local` zastępuje w wyniku odziedziczone wystąpienia.

Powiązane lekcje

  • Java · Lekcja 58 · Zaawansowany · Wersja: 2

Źródła