Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / Java

Tipi di annotazione — @interface

Una dichiarazione @interface definisce un tipo di annotazione, cioè metadati associati al codice. Gli elementi descrivono i dati dell’annotazione, mentre le meta-annotazioni controllano le posizioni consentite, la conservazione, la ripetibilità e l’ereditarietà.

Versione: Java SE 21; repository runtime, production runtime not attested

Sintassi

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.CONSTRUCTOR})
@interface Label {
    String value();
    int priority() default 0;
}

@interface definisce un tipo di annotazione. Un elemento come String value(); è un metodo senza parametri e senza corpo. I tipi consentiti sono i primitivi, String, Class, gli enum, i tipi di annotazione e i relativi array unidimensionali; il valore non può essere null. Un elemento senza default è obbligatorio. @Label("demo") è una forma abbreviata di @Label(value = "demo") quando gli altri elementi hanno valori predefiniti.

@Retention stabilisce per quanto tempo vengono conservati i metadati: RetentionPolicy.SOURCE significa che il compilatore li scarta; RetentionPolicy.CLASS significa che vengono registrati nel file di classe senza garanzia di disponibilità tramite reflection; RetentionPolicy.RUNTIME significa che vengono conservati anche durante l’esecuzione. La possibilità di accedervi tramite reflection dipende però da dove si usa l’annotazione. Ad esempio, un’annotazione con RetentionPolicy.RUNTIME applicata all’uso di un tipo in un cast può essere registrata nel file di classe, ma l’API di reflection standard di Java SE 21 non consente di accedervi. Le annotazioni applicate alle dichiarazioni di variabili locali o di parametri di espressioni lambda non vengono registrate nel file di classe, nemmeno con RetentionPolicy.RUNTIME. In assenza di @Retention, si applica RetentionPolicy.CLASS. Un’annotazione non esegue logica da sola: deve essere interpretata da uno strumento o dal codice.

@Target limita le posizioni consentite. ElementType.TYPE comprende le dichiarazioni di classi, interfacce, enum e record; ElementType.FIELD comprende i campi, incluse le costanti enum; ElementType.METHOD comprende i metodi; ElementType.CONSTRUCTOR comprende i costruttori. ElementType.TYPE non indica un uso qualsiasi di un tipo: a questo serve ElementType.TYPE_USE.

@Repeatable indica un contenitore che consente di ripetere annotazioni dello stesso tipo. Il contenitore dichiara value(), che restituisce un array del tipo ripetuto, e i suoi altri elementi devono avere valori predefiniti. Deve inoltre rispettare le regole di compatibilità del JLS relative a conservazione, obiettivi e meta-annotazioni.

@Inherited consente alle query di reflection appropriate sulle annotazioni di classe di esaminare le superclassi. Non trasferisce le annotazioni dalle interfacce implementate e non fa ereditare le annotazioni di metodi, campi o costruttori. L’esempio mostra quattro obiettivi consentiti e legge un valore esplicito e uno predefinito.

Esempi

import java.lang.annotation.*;

public class Main {
    @Retention(RetentionPolicy.RUNTIME)
    @Target({ElementType.TYPE, ElementType.FIELD,
             ElementType.METHOD, ElementType.CONSTRUCTOR})
    public @interface Label {
        String value();
        int priority() default 0;
    }

    @Label("demo")
    static class Item {
        @Label("id")
        int id;

        @Label("create")
        Item() {}

        @Label(value = "read", priority = 2)
        void read() {}
    }

    public static void main(String[] args) throws ReflectiveOperationException {
        Label type = Item.class.getAnnotation(Label.class);
        Label method = Item.class.getDeclaredMethod("read").getAnnotation(Label.class);
        System.out.println(type.value() + ":" + type.priority());
        System.out.println(method.value() + ":" + method.priority());
    }
}

Risultato

demo:0
read:2

Il codice mostrato e il risultato dichiarato sono stati verificati in un ambiente isolato con il metodo registrato nella prova di verifica di questa versione esatta.

Fonti