Kotlin Academy · Leçon

Définir des annotations

Créer des annotations personnalisées

Définir des annotations est une leçon Kotlin Academy gratuite sur CoddyKit. Ceci est la leçon 2 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage Kotlin Academy, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours Kotlin Academy comprend 4 leçons au total.

Déclarer une annotation

Vous définissez une annotation avec les mots-clés annotation class. La plus simple ne contient aucune donnée et sert de marqueur.

annotation class Beta

@Beta
fun newFeature() = "experimental"

fun main() {
    println(newFeature())
}

Paramètres des annotations

Les annotations peuvent contenir des données par l'intermédiaire de paramètres de constructeur. Les types autorisés sont limités : types primitifs, String, énumérations, autres annotations, KClass et tableaux de ces types.

annotation class ApiVersion(val value: Int)

@ApiVersion(2)
fun endpoint() = "v2"

fun main() {
    println(endpoint())
}

@Target

@Target restreint les endroits où votre annotation peut être appliquée. Vous transmettez une ou plusieurs valeurs de AnnotationTarget, telles que CLASS, FUNCTION ou PROPERTY.

@Target(AnnotationTarget.FUNCTION)
annotation class Loggable

@Loggable
fun process() = "processing"

fun main() {
    println(process())
}

@Retention

@Retention contrôle la durée de conservation de l'annotation :

SOURCE — supprimée par le compilateur
BINARY — conservée dans le fichier de classe, mais invisible pour la réflexion
RUNTIME — conservée et visible pour la réflexion (valeur par défaut)

@Retention(AnnotationRetention.RUNTIME)
annotation class Important

@Important
class Order

fun main() {
    println("Important is readable at runtime")
}

Cibles multiples

Répertoriez plusieurs cibles pour autoriser une annotation à plusieurs endroits. Ici, l'annotation fonctionne à la fois sur les classes et sur les fonctions.

@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
annotation class Audited

@Audited
class Account {
    @Audited
    fun withdraw() = "ok"
}

fun main() {
    println(Account().withdraw())
}

Valeurs par défaut des paramètres

Les paramètres des annotations peuvent avoir des valeurs par défaut, ce qui permet aux appelants de les omettre. Les cas courants restent ainsi concis.

annotation class Cache(val seconds: Int = 60)

@Cache
fun cheap() = 1

@Cache(seconds = 300)
fun expensive() = 2

fun main() {
    println("" + cheap() + " " + expensive())
}

Paramètres de tableau

Vous pouvez utiliser des types de tableau. Fournissez les valeurs avec la syntaxe littérale de tableau [ ... ] lors de l'utilisation de l'annotation.

annotation class Roles(val names: Array<String>)

@Roles(["admin", "editor"])
fun restricted() = "secret"

fun main() {
    println(restricted())
}

@Repeatable

Par défaut, une annotation ne peut apparaître qu'une seule fois par élément. Marquez-la avec @Repeatable pour l'appliquer plusieurs fois.

@Repeatable
annotation class Tag(val value: String)

@Tag("db")
@Tag("cache")
fun layered() = "ok"

fun main() {
    println(layered())
}

Paramètres d'annotations imbriquées

Un paramètre d'annotation peut lui-même être une autre annotation, ce qui vous permet de construire des métadonnées structurées.

annotation class Author(val name: String)
annotation class Module(val owner: Author)

@Module(Author("Grace"))
class Payments

fun main() {
    println("Nested annotation metadata defined")
}

Concevoir de bonnes annotations

Une annotation bien conçue :

A un objectif clair et unique
Définit @Target afin qu'une mauvaise utilisation produise une erreur de compilation
Utilise la conservation RUNTIME uniquement lorsque la réflexion est nécessaire
Fournit des valeurs par défaut pertinentes

De la définition à l'utilisation

Définir une annotation ne représente que la moitié du travail. À elle seule, elle constitue des métadonnées inertes. Quelque chose doit la lire — généralement la réflexion à l'exécution ou un processeur d'annotations au moment de la compilation. Vous utiliserez bientôt la réflexion.

Vérification rapide

Vérifiez votre compréhension de la définition des annotations.

Récapitulatif

Vous avez appris à définir des annotations :

annotation class avec des paramètres
@Target pour restreindre l'emplacement
@Retention pour contrôler la durée de vie
@Repeatable et les valeurs par défaut

Ensuite : inspecter les types avec la réflexion.

Questions Fréquemment Posées

La leçon « Définir des annotations » est-elle gratuite ?

Oui — le texte complet de « Définir des annotations » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours Kotlin Academy, passe à CoddyKit PRO. Le cours Kotlin Academy comprend 4 leçons au total.

Qu'est-ce que j'apprendrai dans « Définir des annotations » ?

Créer des annotations personnalisées Tu pratiques Kotlin Academy avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.

Dois-je avoir de l'expérience pour commencer Kotlin Academy ?

Aucune expérience préalable n'est requise. Kotlin Academy sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 2 sur 4.

Combien de temps prend la leçon « Définir des annotations » ?

La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.

Peux-tu écrire et exécuter du code dans cette leçon Kotlin Academy ?

Oui. Chaque leçon Kotlin Academy inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.

Toutes les leçons de ce cours

← Retour à Kotlin Academy