Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / Java

Anotace v Javě: cíle, uchování, opakování a reflexe

Deklarace anotace v Java SE 21 určuje její data, povolená místa použití a dostupnost za běhu. Nauč se číst metadata pomocí reflexe, rozlišovat vlastní a zděděné anotace a potlačovat varování jen tam, kde je to potřeba.

Verze: Java SE 21

Syntaxe

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.CONSTRUCTOR})
@interface Marker {}

@Target({ElementType.FIELD, ElementType.METHOD})
@interface MemberMarker {}

@Inherited
@Repeatable(Tags.class)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface Tag { String value(); }

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface Tags { Tag[] value(); }

Consumer<? super Integer> subscriber = new Consumer<Number>() {
    @Override public void accept(Number value) { System.out.println(value); }
};
Class<?> type = String.class;
Object payload = List.of("ok");
@SuppressWarnings("unchecked")
List<String> names = (List<String>) payload;

@interface deklaruje anotační rozhraní. String value(); definuje prvek a @Tag("core") je zkratka za @Tag(value = "core"). Metaanotace Target z java.lang.annotation určuje povolená místa použití. @Target(ElementType.TYPE/FIELD/CONSTRUCTOR) je popisná zkratka, nikoli syntaxe Javy: použij @Target({ElementType.TYPE, ElementType.FIELD, ElementType.CONSTRUCTOR}). ElementType.TYPE se vztahuje na deklarace tříd a rozhraní, nikoli na použití typu (TYPE_USE). ElementType.FIELD/METHOD označuje dvě konstanty: ElementType.FIELD pro pole a ElementType.METHOD pro metody. Konstruktory mají vlastní cíl.

Retention řídí dobu uchování: SOURCE se do souboru třídy nezapisuje, výchozí CLASS se zapíše, ale za běhu není dostupné přes reflexi, a @Retention(RetentionPolicy.RUNTIME) zpřístupňuje anotace z příkladu přes reflexi. Výjimkou jsou deklarace lokálních proměnných a parametrů lambda výrazů: jejich deklarativní anotace se do souboru třídy neukládají. Třídní literál Base.class dává objekt Class<Base>; Class<?> ho přijme, aniž by zpřístupnil konkrétní typový argument. ConfigKey, Init, Component a Inject jsou vlastní metadata. Bez kódu, který je zpracuje, nic nenastavují, nevolají ani nevkládají.

@Repeatable(Tags.class) dovoluje zapsat více @Tag na jedno místo. Kompilátor opakování zabalí do kontejneru s Tag[] value(); další prvky kontejneru musí mít výchozí hodnoty. Kontejner musí mít alespoň stejně dlouhou dobu uchování a kompatibilní cíle; v příkladu jsou cíle stejné. Má-li Tag anotaci @Inherited, musí ji mít i kontejner. getAnnotationsByType(Tag.class) rozbalí kontejner a díky Inherited hledá v nadtřídách, pokud třída nemá vlastní tagy. Neslučuje tagy z různých úrovní, neprohledává rozhraní a nedědí anotace metod ani polí. getDeclaredAnnotationsByType také rozbalí kontejner, ale v nadtřídách nehledá; getAnnotation kontejner nerozbaluje.

new Consumer<Number>() { ... } deklaruje a vytvoří instanci anonymní třídy. @Override umožní kompilátoru ověřit, že accept(Number) implementuje metodu rozhraní, místo aby ji omylem přetížila. Java 21 připouští také signatury ekvivalentní z hlediska přepisování veřejným metodám Object a explicitní přístupové metody komponent recordu.

Consumer<? super Integer> přijme konzumenta typu Integer nebo některého jeho nadtypu, například Number či Object, a umožní mu předat Integer. Neohraničený zástupný symbol ?, například v Consumer<?>, ponechává typový argument neznámý, takže nelze předat Integer odlišný od null. @SuppressWarnings("unchecked") potlačí varování kompilátoru, ale nekontroluje typy prvků seznamu a nezabrání ClassCastException. Vyhýbej se zbytečným přetypováním; je-li přetypování odůvodněné, potlač varování na nejmenší deklaraci, kde to funguje.

Příklady

import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.List;
import java.util.function.Consumer;

public class Demo {
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.FIELD)
    @interface ConfigKey { String value(); }

    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.METHOD)
    @interface Init {}

    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @interface Component {}

    @Retention(RetentionPolicy.RUNTIME)
    @Target({ElementType.FIELD, ElementType.CONSTRUCTOR})
    @interface Inject {}

    @Inherited
    @Repeatable(Tags.class)
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @interface Tag { String value(); }

    @Inherited
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @interface Tags { Tag[] value(); }

    @Component
    @Tag("core")
    @Tag("fast")
    static class Base {
        @ConfigKey("port") final int port = 8080;
        boolean started;

        @Inject Base() {}
        @Init void start() { started = true; }
    }

    static class Child extends Base {}

    static void publish(Consumer<? super Integer> subscriber) {
        subscriber.accept(21);
    }

    public static void main(String[] args) throws ReflectiveOperationException {
        Class<?> type = Base.class;
        Base service = new Base();
        var field = type.getDeclaredField("port");
        System.out.println("Config: " + field.getAnnotation(ConfigKey.class).value());
        boolean before = service.started;
        var method = type.getDeclaredMethod("start");
        if (method.isAnnotationPresent(Init.class)) {
            method.invoke(service);
        }
        System.out.println("Started: " + before + " -> " + service.started);
        System.out.println("Component/Inject: " + type.isAnnotationPresent(Component.class)
                + "/" + type.getDeclaredConstructor().isAnnotationPresent(Inject.class));

        Tag[] tags = Child.class.getAnnotationsByType(Tag.class);
        int declared = Child.class.getDeclaredAnnotationsByType(Tag.class).length;
        System.out.println("Tags: " + tags[0].value() + ", " + tags[1].value()
                + "; declared: " + declared);

        publish(new Consumer<Number>() {
            @Override public void accept(Number value) {
                System.out.println("Subscriber: " + value);
            }
        });

        Object payload = List.of("ok"); // This list is known here to contain only strings.
        @SuppressWarnings("unchecked")
        List<String> names = (List<String>) payload;
        System.out.println("Cast: " + names.get(0));
    }
}

Výsledek

Config: port
Started: false -> true
Component/Inject: true/true
Tags: core, fast; declared: 0
Subscriber: 21
Cast: ok

`started` se změní až po explicitním volání `method.invoke(service)`. `Child` přečte dva tagy z `Base`, ačkoli sám žádné nedeklaruje. Přetypování je zde odůvodněné známým původem seznamu z `List.of("ok")`, nikoli přítomností `@SuppressWarnings`.

Související lekce

  • Java · Lekce 44 · Pokročilá · Verze: 2
  • Java · Lekce 54 · Pokročilá · Verze: 2
  • Java · Lekce 58 · Pokročilá · Verze: 2
  • Java · Lekce 59 · Pokročilá · Verze: 2

Zdroje