Tutoriels

Fournir des règles de conservation plus intelligentes : comment les fournisseurs de bibliothèques peuvent débloquer l'optimisation du code DEX au niveau de l'application

Temps de lecture : 6 min
Voir le profil de Breana Tate
Breana Tate Ingénieur Developer Relations

En tant que développeurs d'applications et de bibliothèques Android, nous poursuivons tous le même objectif : créer des applications performantes qui offrent une expérience utilisateur fluide. Cela implique en grande partie d'utiliser R8, l'optimiseur d'applications Android. R8 améliore les performances de l'application en supprimant le code inutilisé, et en optimisant et en obscurcissant le reste.

Google Play a récemment annoncé de nouveaux seuils d'optimisation du code DEX pour les applications et les jeux. Ils permettent d'améliorer les temps de démarrage, de réduire l'espace mémoire utilisé et de s'aligner sur l'engagement d'Android à protéger l'expérience utilisateur des applications qui utilisent trop de mémoire. Bien que ces seuils s'appliquent aux applications et aux jeux, leur respect est une responsabilité partagée par l'ensemble de l'écosystème. R8 ne peut optimiser une application que dans les limites des paramètres qui lui sont fournis, ce qui inclut les règles de conservation regroupées par les bibliothèques dont dépend l'application.

L'analyseur de configuration R8 est un excellent outil pour évaluer les pourcentages d'optimisation, de réduction et d'obscurcissement des applications, qui sont au cœur des exigences techniques de Google Play. En plus de suivre ces pourcentages, l'analyseur de configuration R8 met également en évidence les règles de conservation inefficaces provenant non seulement des applications, mais aussi des règles de conservation des consommateurs intégrées aux bibliothèques dont dépendent les applications.

Ce guide explique comment résoudre certains des problèmes les plus courants auxquels sont confrontés les fournisseurs de bibliothèques et comment proposer des règles précises et performantes pour aider vos clients à respecter les exigences techniques de Google Play.

Que sont les règles de conservation des consommateurs ?

Les règles de conservation des consommateurs sont des instructions regroupées dans une bibliothèque Android ou JAR qui indiquent à R8 quelles parties du code de la bibliothèque ne peuvent pas être optimisées pendant le processus de compilation au niveau de l'application. Contrairement aux règles de conservation standards écrites par l'application ou la bibliothèque utilisée pour la minimisation de leurs artefacts, les règles de conservation des consommateurs sont intégrées aux bibliothèques et affectent la façon dont la bibliothèque est minimisée lors de l'optimisation de l'application entière. Cela garantit que les cibles de réflexion internes et les interfaces natives restent intactes sans que le développeur de l'application ait besoin de les identifier manuellement.

Les règles de conservation intentionnelles et à champ d'application restreint constituent une bonne pratique essentielle qui profite à la fois à la bibliothèque et aux applications qui l'utilisent. Les règles de conservation trop larges conservent le code inutilisé et, par conséquent, ont un impact sur l'optimisation et les performances d'une application. Grâce aux insights sur l'optimisation du code DEX ajoutés à la Play Console, les métriques que les développeurs d'applications verront représentent l'impact combiné des règles de l'application et de ses bibliothèques intégrées.

Trouver le bon équilibre entre stabilité et performances

Les fournisseurs de bibliothèques sont souvent bien intentionnés lorsqu'ils fournissent des règles de conservation générales pour les consommateurs. Personne ne souhaite que son SDK déclenche un plantage en raison de la suppression d'une classe lors de la réflexion. 

Toutefois, nous vous déconseillons d'utiliser des règles de conservation à l'échelle du package ou d'autres règles de conservation générales comme solution à long terme pour éviter les plantages, car elles limitent considérablement le potentiel d'optimisation de l'application par R8. Voici quelques stratégies recommandées pour vous aider à déployer des règles précises et performantes sans sacrifier la stabilité :

1. Tester et déployer des règles précises

Pour vous aider à publier des règles précises en toute confiance, tenez compte des bonnes pratiques suivantes :

  • Tester dans un exemple d'application : les conseils de test local de la section Tester votre optimisation s'appliquent également aux exemples d'applications. Après avoir activé R8, testez les critical user journeys pour vous assurer que les fonctionnalités fonctionnent comme prévu.
  • Exécutez l'analyseur de configuration R8 sur votre application exemple pour voir ce que les développeurs d'applications voient lorsqu'ils auditent leur configuration R8. Il vous permet de visualiser facilement l'impact de vos règles de conservation sur les applications en aval.
  • Utilisez la commande analyze de la CLI Android pour évaluer l'optimisation de votre fichier AAR ou JAR, y compris les méthodes, classes et champs conservés. Vous pouvez comparer ces chiffres entre les versions pour surveiller les régressions.
  • Surveillez l'utilisation des versions de la bibliothèque et les plantages dans la Google Play SDK Console.
  • Consultez les conseils de la section Optimisation pour les auteurs de bibliothèques et la documentation R8 pour connaître les bonnes pratiques.

2. Préserver les cibles de réflexion et JNI sans règles de conservation générales

La livraison d'une bibliothèque avec des règles de conservation étendues ou à l'échelle du package n'affecte pas seulement votre SDK. Elle oblige également les développeurs à accepter un code volumineux qui ralentit le temps de démarrage de l'application et augmente la taille de téléchargement de l'application, l'utilisation de la mémoire et les taux d'erreurs ANR. Il est également possible que les applications axées sur les performances écrivent des règles personnalisées qui remplacent celles fournies avec votre bibliothèque, ce qui les dissuade également d'adopter les futures mises à jour de la bibliothèque afin de réduire les risques.

Si votre SDK cible du code natif, comme celui des jeux ou des éditeurs de photos et de vidéos, fournissez des règles pour toutes les classes qui utilisent JNI. La plupart des jeux s'exécutent sur des moteurs de jeu tels que Unity et Unreal, qui compilent le jeu en code natif. Le code natif du jeu et votre plug-in communiquent avec le framework Android via des appels JNI.

Les annotations Jetpack Keep, désormais en version alpha, peuvent vous aider à réduire la maintenance requise par la réflexion en vous permettant d'annoter l'utilisation de la réflexion, qui peut ensuite être utilisée pour générer des règles de conservation au moment de la compilation.

Envisager la génération de code plutôt que la réflexion

Pour éviter les plantages dus à la réflexion, notre meilleur conseil est d'éviter la réflexion et d'utiliser codegen dans la mesure du possible. 

La réflexion d'exécution masque l'utilisation du code à R8 lors de la compilation, ce qui nécessite des règles de conservation pour éviter les plantages. Si vous utilisez la génération de code, le code est optimisé pendant le processus de compilation, ce qui permet à R8 de disposer de la visibilité nécessaire pour optimiser le code de manière sécurisée avec un minimum de règles de conservation. La sérialisation et la désérialisation, ainsi que l'injection de dépendances (Hilt est un exemple de bibliothèque qui utilise la génération de code) sont des scénarios courants dans lesquels la génération de code est un excellent choix.

Cependant, la génération de code n'est pas le bon choix pour tous les scénarios. Pour les modèles tels que les dépendances facultatives, la réflexion reste nécessaire. Nous vous recommandons d'associer la réflexion à des règles de conservation strictes qui ne protègent que les points d'entrée requis, comme décrit dans les conseils sur la réflexion pour prendre en charge les dépendances facultatives. 

Définissez des règles de manière précise, même pour les builds de bibliothèque pré-optimisés

S'il n'est pas possible d'éviter la réflexion, assurez-vous que les règles de conservation de votre consommateur ne spécifient que ce sur quoi votre bibliothèque réfléchit. Lorsque votre bibliothèque accède à une classe ou à une méthode de manière dynamique, il vous suffit de spécifier le point d'entrée. R8 s'occupe du reste. R8 utilise les points d'entrée pour créer un graphique du code référencé et supprimer les classes, méthodes et champs non référencés.

Cela s'applique également si vous avez déjà optimisé ou obscurci le build de votre bibliothèque, ce qui est une excellente pratique pour garantir un SDK performant et léger. Comme vos règles s'appliquent lors de l'étape de compilation de l'application, R8 peut encore optimiser votre bibliothèque en fonction des classes et des méthodes réellement utilisées par l'application en aval. La commande d'analyse de la CLI Android affiche de manière proactive les règles de conservation utilisées et inutilisées à l'échelle du package qui contribuent au blocage de l'optimisation.

Limitez la portée des règles de conservation pour les dépendances tierces

Voici un schéma courant que nous avons observé :

-keep public class com.google.android.gms.** { *; }

Si une application intégrant votre SDK utilise également une autre bibliothèque GMS et inclut une règle de conservation pour limiter la quantité de code conservé, cette règle générale la remplace, ce qui contribue à l'augmentation inutile de la taille de l'application. 

Lorsque vous appelez des bibliothèques externes, vous devez concevoir des règles de conservation qui ne préservent strictement que les éléments spécifiques auxquels votre bibliothèque accède par réflexion. De plus, en réalité, de nombreuses bibliothèques (y compris GMS) fournissent déjà leurs propres règles de conservation des consommateurs. L'introduction d'une règle de conservation à l'échelle du package peut également englober des règles de consommation soigneusement écrites et à portée limitée de la bibliothèque en aval.

Envisager des règles de conservation conditionnelle pour les adaptateurs de médiation d'annonces

Si votre bibliothèque d'annonces est chargée à l'aide d'adaptateurs de médiation, vous pouvez toujours utiliser des règles de conservation étroites. Dans ce scénario, nous vous recommandons d'utiliser des règles de conservation conditionnelles pour ne conserver que certaines fonctionnalités ou certains formats si l'application inclut l'adaptateur correspondant. Cela permet à R8 de continuer à minifier les fonctionnalités que l'application n'utilise pas. Vous pouvez également utiliser les annotations Jetpack Keep pour annoter vos appels de réflexion directement dans le code source et générer automatiquement des règles de conservation conditionnelles pour les consommateurs, y compris pour les modules complémentaires facultatifs, plutôt que d'écrire des règles complexes à la main.

Livrez des règles dans des règles de consommateur, pas de la documentation

En fournissant des règles client avec votre bibliothèque, vous vous assurez que les applications dont le build est compatible avec R8 peuvent utiliser votre bibliothèque sans configuration supplémentaire et bénéficier d'une optimisation maximale. 

La spécification de règles dans votre documentation ajoute des frictions de configuration manuelle (en particulier parce que les règles de conservation des consommateurs groupées sont compatibles avec les fichiers AAR et JAR depuis des années) et crée des frais de maintenance continus. Lorsque vous mettez à jour votre bibliothèque (y compris en refactorisant, en renommant des classes et en modifiant l'utilisation de la réflexion), vous devez penser à mettre à jour la documentation, et les applications doivent penser à vérifier les nouvelles règles. Au fil du temps, à mesure que les applications sont mises à niveau via plusieurs versions de votre bibliothèque, elles peuvent accumuler des règles de conservation obsolètes qui ne sont plus nécessaires, ce qui entraîne une augmentation inutile de la taille de l'application.

3. Lire les traces de la pile de version

Vous avez peut-être rencontré une trace de la pile illisible en raison d'un code obscurci. Pour débloquer l'analyse critique, il peut être tentant d'utiliser keepnames, qui permet la réduction, mais empêche d'autres optimisations telles que le changement de nom dans l'application consommatrice, c'est-à-dire les valeurs précises dont vous avez besoin lors du débogage d'une trace de la pile. 

Vous n'avez pas besoin d'empêcher d'autres optimisations pour obtenir des traces de la pile lisibles.

Firebase Crashlytics, la Play Console et Logcat dans Android Studio désobscurcissent les traces de la pile pour les développeurs d'applications. Cela signifie que si un développeur d'applications partage une trace de la pile avec vous, vous n'avez pas besoin d'empêcher l'obscurcissement pour pouvoir la lire.

Si vous importez votre fichier de mappage dans la SDK Console, vous pourrez voir les traces de la pile désobscurcies dans la SDK Console.

Ne laissez plus le hasard décider de l'optimisation

L'optimisation de votre bibliothèque ne doit pas se faire par tâtonnements.

En conservant les règles de conservation des consommateurs, les fournisseurs de bibliothèques peuvent s'assurer que les applications de l'écosystème ne sont pas bloquées par l'optimisation.

Lorsque les bibliothèques fournissent de meilleures règles, les applications deviennent plus petites et plus rapides. Commencez dès aujourd'hui à auditer vos règles de conservation des consommateurs pour aider les applications qui dépendent de votre bibliothèque à fonctionner de manière optimale.

Écrit par :
Continuer la lecture