Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / Java

Branje anotacij razredov z refleksijo

Preberi ponovljive anotacije kot tabelo in preveri prisotnost označevalne anotacije. Razlikuj iskanje po nadrazredih od iskanja samo v deklaraciji pregledanega razreda.

Različica: 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)

Razredni literal Child.class vrne objekt Class<Child> za pregled; Tag.class vrne objekt Class<Tag>, ki označuje iskani tip anotacije. To so metode primerka razreda Class: objekta Child ni treba ustvariti. Če želiš anotacije deklaracije razreda brati z refleksijo, tip anotacije označi z @Retention(RetentionPolicy.RUNTIME).

getAnnotationsByType(Tag.class) vrne Tag[], če ni zadetkov pa prazno tabelo, ne null. Anotacije vzame iz vsebnika, določenega z @Repeatable, in ohrani vrstni red njegovih elementov. Če ima iskani tip @Inherited in v razredu ni zadetka niti neposredno niti v vsebniku, metoda išče po nadrazredih, ne po vmesnikih. Zadetkov z različnih ravni ne združuje. getDeclaredAnnotationsByType prav tako razpakira vsebnik, vendar pregleda samo obravnavani razred.

isAnnotationPresent(A.class) vrne boolean in je enakovreden izrazu getAnnotation(A.class) != null. Uporaben je za označevalne anotacije, ki nimajo elementov. Če ni neposrednega zadetka in ima iskani tip @Inherited, metoda preveri nadrazrede, ne vmesnikov. V vsebnik ne pogleda, zato ponovitve, ki so samo v njem, pri preverjanju ponovljivega tipa ne dajo rezultata true. getDeclaredAnnotation išče le neposreden zadetek na razredu; če ga ni, vrne null.

Vse omenjene metode, ki sprejmejo tip anotacije, za argument null sprožijo NullPointerException. Če želiš preveriti, ali obstaja vsaj en zadetek, tudi v vsebniku, uporabi getAnnotationsByType(Tag.class).length > 0.

Primeri

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` podeduje `@Flag` in obe pojavitvi `@Tag`, vendar nobene ne deklarira sam. Obe pojavitvi `@Tag` na `Base` sta shranjeni v vsebniku `@Tags`, zato preverjanje prisotnosti `Tag.class` na `Base` vrne `false`. Lastna anotacija `@Tag` na `Local` v rezultatu nadomesti podedovani pojavitvi, namesto da bi se jima pridružila.

Povezane lekcije

  • Java · Lekcija 58 · Napredna · Različica: 2

Viri