Les bonnes pratiques décrites ici servent de guide pour développer des interfaces AIDL de manière efficace et en tenant compte de la flexibilité de l'interface, en particulier lorsque AIDL est utilisé pour définir une API ou interagir avec des surfaces d'API.
AIDL peut être utilisé pour définir une API lorsque des applications doivent communiquer entre elles dans un processus en arrière-plan ou avec le système. Pour en savoir plus sur le développement d'interfaces de programmation dans des applications avec AIDL, consultez Langage de définition d'interface Android (AIDL). Pour obtenir des exemples pratiques d'AIDL, consultez AIDL pour les HAL et AIDL stable.
Gestion des versions
Chaque instantané rétrocompatible d'une API AIDL correspond à une version.
Pour prendre un instantané, exécutez la commande m <module-name>-freeze-api. Chaque fois qu'un client ou un serveur de l'API est publié (par exemple, dans un train Mainline), vous devez prendre un instantané et créer une nouvelle version. Pour les API système-fournisseur, cela devrait se produire avec la révision annuelle de la plate-forme.
Pour en savoir plus et obtenir des informations sur les types de modifications autorisées, consultez Interfaces de gestion des versions.
Consignes de conception d'API
Général
1. Tout documenter
- Documentez chaque méthode pour sa sémantique, ses arguments, son utilisation des exceptions intégrées, ses exceptions spécifiques au service et sa valeur de retour.
- Documentez la sémantique de chaque interface.
- Documentez la signification sémantique des énumérations et des constantes.
- Documentez tout ce qui pourrait ne pas être clair pour un développeur.
- Fournissez des exemples, si nécessaire.
2. Boîtier
Utilisez la casse camel supérieure pour les types et la casse camel inférieure pour les méthodes, les champs et les arguments. Par exemple, MyParcelable pour un type Parcelable et anArgument pour un argument. Pour les acronymes, considérez-les comme des mots (NFC -> Nfc).
[-Wconst-name] Les valeurs d'énumération et les constantes doivent être ENUM_VALUE et CONSTANT_NAME
Interfaces
1. Dénominations
[-Winterface-name] Le nom d'une interface doit commencer par I, comme IFoo.
2. Éviter les grandes interfaces avec des "objets" basés sur des ID
Privilégiez les sous-interfaces lorsqu'il existe de nombreux appels liés à une API spécifique. Cela présente les avantages suivants :
- Facilite la compréhension du code client ou serveur
- Simplifie le cycle de vie des objets
- Tire parti de l'inviolabilité des liants.
Approche déconseillée : une interface unique et volumineuse avec des objets basés sur des ID
interface IManager {
int getFooId();
void beginFoo(int id); // clients in other processes can guess an ID
void opFoo(int id);
void recycleFoo(int id); // ownership not handled by type
}
Recommandation : interfaces individuelles
interface IManager {
IFoo getFoo();
}
interface IFoo {
void begin(); // clients in other processes can't guess a binder
void op();
}
3. Ne mélangez pas les méthodes unidirectionnelles et bidirectionnelles.
[-Wmixed-oneway] Ne mélangez pas les méthodes unidirectionnelles et non unidirectionnelles, car cela complique la compréhension du modèle de threading pour les clients et les serveurs. Plus précisément, lorsque vous lisez le code client d'une interface particulière, vous devez rechercher pour chaque méthode si elle bloquera ou non.
4. Éviter de renvoyer des codes d'état
Les méthodes doivent éviter les codes d'état comme valeurs de retour, car toutes les méthodes AIDL ont un code d'état de retour implicite. Consultez ServiceSpecificException ou EX_SERVICE_SPECIFIC. Par convention, ces valeurs sont définies comme des constantes dans une interface AIDL. Pour en savoir plus, consultez la section Gestion des erreurs des backends AIDL.
5. Les tableaux en tant que paramètres de sortie sont considérés comme dangereux
[-Wout-array] Les méthodes comportant des paramètres de sortie de tableau, comme void foo(out String[] ret), sont généralement à éviter, car la taille du tableau de sortie doit être déclarée et allouée par le client en Java. Le serveur ne peut donc pas choisir la taille de la sortie du tableau. Ce comportement indésirable est dû au fonctionnement des tableaux en Java (ils ne peuvent pas être réalloués). Privilégiez plutôt les API telles que String[] foo().
6. Éviter les paramètres d'entrée/sortie
[-Winout-parameter] Cela peut dérouter les clients, car même les paramètres in ressemblent à des paramètres out.
7. Éviter les paramètres @nullable non matriciels out et inout
[-Wout-nullable] Étant donné que le backend Java ne gère pas l'annotation @nullable, contrairement à d'autres backends, out/inout @nullable T peut entraîner un comportement incohérent entre les backends. Par exemple, les backends non Java peuvent définir un paramètre @nullable de sortie sur "null" (en C++, en le définissant sur std::nullopt), mais le client Java ne peut pas le lire comme "null".
Parcelables structurés
1. Quand l'utiliser
Utilisez des parcelables structurés lorsque vous avez plusieurs types de données à envoyer.
Ou encore, lorsque vous n'avez qu'un seul type de données, mais que vous prévoyez de l'étendre à l'avenir. Par exemple, n'utilisez pas String username. Utilisez un élément Parcelable extensible, comme suit :
parcelable User {
String username;
}
Vous pourrez ainsi l'étendre ultérieurement, comme suit :
parcelable User {
String username;
int id;
}
2. Fournir des valeurs par défaut de manière explicite
[-Wexplicit-default, -Wenum-explicit-default] Indiquez des valeurs par défaut explicites pour les champs.
Parcelables non structurés
1. Quand l'utiliser
Les Parcelables non structurés sont disponibles en Java avec @JavaOnlyStableParcelable et dans le backend NDK avec @NdkOnlyStableParcelable. Il s'agit généralement d'anciens éléments Parcelable existants qui ne peuvent pas être structurés.
Constantes et énumérations
1. Les champs de bits doivent utiliser des champs constants
Les champs de bits doivent utiliser des champs constants (par exemple, const int FOO = 3; dans une interface).
2. Les énumérations doivent être des ensembles fermés.
Les énumérations doivent être des ensembles fermés. Remarque : Seul le propriétaire de l'interface peut ajouter des éléments enum. Si les fournisseurs ou les OEM doivent étendre ces champs, un autre mécanisme est nécessaire. Dans la mesure du possible, il est préférable d'intégrer les fonctionnalités du fournisseur en amont. Toutefois, dans certains cas, des valeurs de fournisseur personnalisées peuvent être autorisées (bien que les fournisseurs doivent disposer d'un mécanisme pour les versionner, peut-être AIDL lui-même, elles ne doivent pas être en conflit les unes avec les autres et ces valeurs ne doivent pas être exposées aux applications tierces).
3. Évitez les valeurs telles que "NUM_ELEMENTS".
Étant donné que les énumérations sont versionnées, les valeurs qui indiquent le nombre de valeurs présentes doivent être évitées. En C++, il est possible de contourner ce problème avec enum_range<>. Pour Rust, utilisez enum_values(). En Java, aucune solution n'est disponible pour le moment.
Option déconseillée : utiliser des valeurs numérotées
@Backing(type="int")
enum FruitType {
APPLE = 0,
BANANA = 1,
MANGO = 2,
NUM_TYPES, // BAD
}
4. Éviter les préfixes et suffixes redondants
[-Wredundant-name] Évitez les préfixes et suffixes redondants ou répétitifs dans les constantes et les énumérateurs.
Option déconseillée : utiliser un préfixe redondant
enum MyStatus {
STATUS_GOOD,
STATUS_BAD // BAD
}
Recommandé : nommer directement l'énumération
enum MyStatus {
GOOD,
BAD
}
FileDescriptor
[-Wfile-descriptor] L'utilisation de FileDescriptor comme argument ou valeur de retour d'une méthode d'interface AIDL est fortement déconseillée. En particulier, lorsque l'AIDL est implémenté en Java, cela peut entraîner une fuite de descripteur de fichier, sauf si elle est gérée avec soin. En gros, si vous acceptez un FileDescriptor, vous devez le fermer manuellement lorsqu'il n'est plus utilisé.
Pour les backends natifs, vous êtes en sécurité, car FileDescriptor correspond à unique_fd, qui est auto-fermant. Toutefois, quel que soit le langage de backend que vous utiliserez, il est judicieux de ne pas utiliser FileDescriptor du tout, car cela limitera votre liberté de changer de langage de backend à l'avenir.
Utilisez plutôt ParcelFileDescriptor, qui peut être fermé automatiquement.
Unités de variables
Assurez-vous que les unités de variables sont incluses dans le nom afin qu'elles soient bien définies et comprises sans avoir besoin de consulter la documentation.
Exemples
long duration; // Bad
long durationNsec; // Good
long durationNanos; // Also good
double energy; // Bad
double energyMilliJoules; // Good
int frequency; // Bad
int frequencyHz; // Good
Les codes temporels doivent indiquer leur référence
Les codes temporels (en fait, toutes les unités) doivent indiquer clairement leurs unités et leurs points de référence.
Exemples
/**
* Time since device boot in milliseconds
*/
long timestampMs;
/**
* UTC time received from the NTP server in units of milliseconds
* since January 1, 1970
*/
long utcTimeMs;