Annotations dans AIDL

AIDL accepte les annotations qui fournissent au compilateur AIDL des informations supplémentaires sur l'élément annoté, ce qui affecte également le code bouchon généré.

La syntaxe est semblable à celle de Java:

@AnnotationName(argument1=value, argument2=value) AidlEntity

Ici, AnnotationName est le nom de l'annotation et AidlEntity est une entité AIDL telle que interface Foo, void method() ou int arg. Une annotation est associée à l'entité qui la suit.

Certaines annotations peuvent avoir des arguments définis entre parenthèses, comme indiqué ci-dessus. Les parenthèses sans argument ne sont pas nécessaires pour les annotations qui n'ont pas d'argument. Par exemple :

@AnnotationName AidlEntity

Ces annotations ne sont pas les mêmes que les annotations Java, bien qu'elles paraissent très similaires. Les utilisateurs ne peuvent pas définir d'annotations AIDL personnalisées ; les annotations sont toutes prédéfinies. Certaines annotations n'affectent qu'un certain backend et ne fonctionnent pas dans les autres backends. Elles sont soumises à différentes restrictions.

Voici la liste des annotations AIDL prédéfinies:

Annotations	Ajouté à la version Android
nullable	7
utf8InCpp	7
VintfStability	11
UnsupportedAppUsage	10
Hide	11
Backing	11
NdkOnlyStableParcelable	14
JavaOnlyStableParcelable	11
JavaDerive	12
JavaPassthrough	12
FixedSize	12
Descriptor	12

Remarque :Le compilateur AIDL analyse @hide et @deprecated dans les commentaires.

pouvant avoir une valeur nulle

nullable déclare que la valeur de l'entité annotée ne peut pas être fournie.

Cette annotation ne peut être associée qu'à des types renvoyés de méthode, des paramètres de méthode et des champs parcelables.

interface IFoo {
    // method return types
    @nullable Data method();

    // method parameters
    void method2(in @nullable Data d);
}

parcelable Data {
    // parcelable fields
    @nullable Data d;
}

Les annotations ne peuvent pas être associées à des types primitifs. Voici une erreur.

void method(in @nullable int a); // int is a primitive type

Cette annotation est no-op pour le backend Java. En effet, en Java, tous les types non primitifs sont transmis par référence, qui peut être null.

Dans le backend CPP, @nullable T correspond à std::unique_ptr<T> sous Android 11 ou version antérieure, et à std::optional<T> sous Android 12 ou version ultérieure.

Dans le backend du NDK, @nullable T est toujours mappé sur std::optional<T>.

Pour un type L de type liste tel que T[] ou List<T>, @nullable L est mappé à std::optional<std::vector<std::optional<T>>> (ou std::unique_ptr<std::vector<std::unique_ptr<T>>> dans le cas du backend CPP pour Android 11 ou version antérieure).

Il existe une exception à ce mappage. Lorsque T est défini sur IBinder ou sur une interface AIDL, @nullable est sans opération. En d'autres termes, @nullable IBinder et IBinder sont tous deux mappés à android::sp<IBinder>, qui peut déjà avoir une valeur nulle, car il s'agit d'un pointeur fort (les lectures CPP appliquent toujours la possibilité de valeur nulle, mais le type est toujours android::sp<IBinder>).

À partir d'Android 13, @nullable(heap=true) peut être utilisé pour les champs parcelables afin de modéliser des types récursifs. Vous ne pouvez pas utiliser @nullable(heap=true) avec des paramètres de méthode ou des types renvoyés. Lorsqu'il est annoté avec ce code, le champ est mappé sur une référence attribuée à un tas de mémoire std::unique_ptr<T> dans les backends CPP/NDK. @nullable(heap=true) est no-op dans le backend Java.

utf8InCpp

utf8InCpp déclare qu'un élément String est représenté au format UTF8 pour le backend CPP. Comme son nom l'indique, l'annotation est une opération no-op pour les autres backends. Plus précisément, String est toujours UTF16 dans le backend Java et UTF8 dans le backend NDK.

Cette annotation peut être associée partout où le type String peut être utilisé, y compris les valeurs renvoyées, les paramètres, les déclarations de constantes et les champs parcelables.

Pour le backend CPP, @utf8InCpp String dans AIDL correspond à std::string, tandis que String sans l'annotation est mappé à android::String16 où UTF16 est utilisé.

Notez que l'existence de l'annotation utf8InCpp ne modifie pas la façon dont les chaînes sont transmises sur le réseau. Les chaînes sont toujours transmises au format UTF16 via le câble. Une chaîne annotée utf8InCpp est convertie au format UTF16 avant d'être transmise. Lorsqu'une chaîne est reçue, elle est convertie de UTF16 à UTF8 si elle a été annotée en tant que utf8InCpp.

VintfStability

VintfStability déclare qu'un type défini par l'utilisateur (interface, parcelable et enum) peut être utilisé dans les domaines du système et du fournisseur. Pour en savoir plus sur l'interopérabilité système-fournisseur, consultez la page AIDL pour les HAL.

L'annotation ne modifie pas la signature du type, mais lorsqu'elle est définie, l'instance du type est marquée comme stable afin qu'elle puisse traverser les processus du fournisseur et du système.

L'annotation ne peut être associée qu'à des déclarations de type définies par l'utilisateur, comme indiqué ici:

@VintfStability
interface IFoo {
    ....
}

@VintfStability
parcelable Data {
    ....
}

@VintfStability
enum Type {
    ....
}

Lorsqu'un type est annoté avec VintfStability, tout autre type référencé dans le type doit également être annoté en tant que tel. Dans l'exemple suivant, Data et IBar doivent tous deux être annotés avec VintfStability.

@VintfStability
interface IFoo {
    void doSomething(in IBar b); // references IBar
    void doAnother(in Data d); // references Data
}

@VintfStability // required
interface IBar {...}

@VintfStability // required
parcelable Data {...}

De plus, les fichiers AIDL qui définissent des types annotés avec VintfStability ne peuvent être créés qu'à l'aide du type de module Soong aidl_interface, avec la propriété stability définie sur "vintf".

aidl_interface {
    name: "my_interface",
    srcs: [...],
    stability: "vintf",
}

Utilisation de l'application non compatible

L'annotation UnsupportedAppUsage indique que le type AIDL annoté fait partie de l'interface non SDK qui était accessible aux anciennes applications. Pour en savoir plus sur les API masquées, consultez la section Restrictions concernant les interfaces non SDK.

L'annotation UnsupportedAppUsage n'affecte pas le comportement du code généré. L'annotation n'annotera que la classe Java générée avec l'annotation Java du même nom.

// in AIDL
@UnsupportedAppUsage
interface IFoo {...}

// in Java
@android.compat.annotation.UnsupportedAppUsage
public interface IFoo {...}

Il s'agit d'une opération no-op pour les backends non Java.

Support

L'annotation Backing spécifie le type de stockage d'un type d'énumération AIDL.

@Backing(type="int")
enum Color { RED, BLUE, }

Dans le backend CPP, cela émet une classe d'énumération C++ de type int32_t.

enum class Color : int32_t {
    RED = 0,
    BLUE = 1,
}

Si l'annotation est omise, la valeur type est supposée être byte, ce qui correspond à int8_t pour le backend CPP.

L'argument type ne peut être défini que sur les types entiers suivants:

• byte (largeur 8 bits)
• int (largeur 32 bits)
• long (largeur 64 bits)

NdkOnlyStableParcelable (NdkOnlyStableParcelable)

NdkOnlyStableParcelable marque une déclaration parcelable (et non une définition) comme stable afin qu'elle puisse être référencée à partir d'autres types AIDL stables. Cette méthode est semblable à JavaOnlyStableParcelable, mais NdkOnlyStableParcelable marque une déclaration parcelable comme stable pour le backend du NDK plutôt que pour Java.

Pour utiliser cet élément parcelable:

• Vous devez spécifier ndk_header.
• Vous devez disposer d'une bibliothèque NDK spécifiant le parcelable, et la bibliothèque doit être compilée dans la bibliothèque. Par exemple, dans le système de compilation principal d'un module cc_*, utilisez static_libs ou shared_libs. Pour aidl_interface, ajoutez la bibliothèque sous additional_shared_libraries dans Android.bp.

JavaOnlyStableParcelable

JavaOnlyStableParcelable marque une déclaration parcelable (et non une définition) comme stable afin qu'elle puisse être référencée à partir d'autres types AIDL stables.

La version stable d'AIDL nécessite que tous les types définis par l'utilisateur soient stables. Pour les parcelables, la stabilité nécessite que leurs champs soient explicitement décrits dans le fichier source AIDL.

parcelable Data { // Data is a structured parcelable.
    int x;
    int y;
}

parcelable AnotherData { // AnotherData is also a structured parcelable
    Data d; // OK, because Data is a structured parcelable
}

Si le parcelable n'était pas structuré (ou s'il a simplement été déclaré), il ne peut pas être référencé.

parcelable Data; // Data is NOT a structured parcelable

parcelable AnotherData {
    Data d; // Error
}

JavaOnlyStableParcelable vous permet d'ignorer la vérification lorsque l'élément parcelable que vous référencez est déjà disponible de manière sécurisée dans le SDK Android.

@JavaOnlyStableParcelable
parcelable Data;

parcelable AnotherData {
    Data d; // OK
}

JavaDerive

JavaDerive génère automatiquement des méthodes pour les types parcelables dans le backend Java.

@JavaDerive(equals = true, toString = true)
parcelable Data {
  int number;
  String str;
}

L'annotation nécessite des paramètres supplémentaires pour contrôler les éléments à générer. Les paramètres acceptés sont les suivants:

• equals=true génère les méthodes equals et hashCode.
• toString=true génère la méthode toString qui affiche le nom du type et les champs. Exemple : Data{number: 42, str: foo}

JavaDefault

JavaDefault, ajoutée dans Android 13, contrôle si la prise en charge de la gestion des versions d'implémentation par défaut est générée (pour setDefaultImpl). Cette compatibilité n'est plus générée par défaut afin d'économiser de l'espace.

JavaPassthrough

JavaPassthrough permet à l'API Java générée d'être annotée avec une annotation Java arbitraire.

Les annotations suivantes dans AIDL :

@JavaPassthrough(annotation="@android.annotation.Alice")
@JavaPassthrough(annotation="@com.android.Alice(arg=com.android.Alice.Value.A)")

devenir

@android.annotation.Alice
@com.android.Alice(arg=com.android.Alice.Value.A)

dans le code Java généré.

La valeur du paramètre annotation est émise directement. Le compilateur AIDL ne examine pas la valeur du paramètre. En cas d'erreur de syntaxe au niveau de Java, elle n'est pas détectée par le compilateur AIDL, mais par le compilateur Java.

Cette annotation peut être associée à n'importe quelle entité AIDL. Cette annotation est une opération no-op pour les backends autres que Java.

Taille fixe

FixedSize marque une parcelle structurée comme une taille fixe. Une fois cette case cochée, aucun nouveau champ ne pourra être ajouté au segmentable. Tous les champs de l'élément parcelable doivent également être de taille fixe, y compris les types primitifs, les énumérations, les tableaux de taille fixe et les autres éléments morcelés marqués d'un FixedSize.

Cela n'offre aucune garantie sur les différentes bits et ne doit pas être utilisé pour la communication de bits mixtes.

Titre

Descriptor spécifie de force le descripteur d'une interface.

package android.foo;

@Descriptor(value="android.bar.IWorld")
interface IHello {...}

Le descripteur de cette interface est android.bar.IWorld. Si l'annotation Descriptor est manquante, le descripteur est android.foo.IHello.

Cela s'avère utile pour renommer une interface déjà publiée. Rendre le descripteur de l'interface renommée identique au descripteur de l'interface avant le changement de nom permet aux deux interfaces de communiquer entre elles.

@masquer dans les commentaires

Le compilateur AIDL reconnaît @hide dans les commentaires et le transmet à la sortie Java pour que metalava puisse être récupéré. Ce commentaire garantit que le système de compilation Android sait que les API AIDL ne sont pas des API de SDK.

@obsolète dans les commentaires

Le compilateur AIDL reconnaît @deprecated dans les commentaires comme une balise permettant d'identifier une entité AIDL qui ne doit plus être utilisée.

interface IFoo {
  /** @deprecated use bar() instead */
  void foo();
  void bar();
}

Chaque backend marque les entités obsolètes avec une annotation ou un attribut qui leur est propre afin que le code client soit averti s'il fait référence aux entités obsolètes. Par exemple, l'annotation @Deprecated et la balise @deprecated sont associées au code généré par Java.