Pour activer l'optimisation des applications, vous devez utiliser des bibliothèques compatibles avec l'optimisation Android. Si une bibliothèque n'est pas configurée pour l'optimisation Android (par exemple, si elle utilise la réflexion sans regrouper les règles de conservation associées), elle n'est peut-être pas adaptée à une application Android. Cette page explique pourquoi certaines bibliothèques sont mieux adaptées à l'optimisation des applications et fournit des conseils généraux pour vous aider à faire votre choix.
Conseils généraux pour choisir des bibliothèques
Suivez ces conseils pour vous assurer que vos bibliothèques sont compatibles avec l'optimisation des applications.
Préférer la génération de code à la réflexion
Choisissez des bibliothèques qui utilisent la génération de code (codegen) au lieu de la réflexion. Avec la génération de code, l'optimiseur peut déterminer quel code est réellement utilisé au moment de l'exécution et quel code peut être supprimé. Il peut être difficile de déterminer si une bibliothèque utilise la génération de code ou la réflexion, mais certains signes peuvent vous aider. Consultez les conseils pour en savoir plus.
Pour en savoir plus sur la génération de code par rapport à la réflexion, consultez Optimisation pour les auteurs de bibliothèques.
Vérifier l'utilisation de la réflexion (avancé)
Vous pouvez savoir si une bibliothèque utilise la réflexion en inspectant son code. Si la bibliothèque utilise la réflexion, vérifiez qu'elle fournit des règles de conservation associées. Une bibliothèque utilise probablement la réflexion si elle effectue les opérations suivantes :
- Utilise des classes ou des méthodes des packages
kotlin.reflectoujava.lang.reflect. - Utilise les fonctions
Class.forNameouclassLoader.getClass. - Lit les annotations au moment de l'exécution, par exemple s'il stocke une valeur d'annotation à l'aide de
val value = myClass.getAnnotation()ouval value = myMethod.getAnnotation(), puis effectue une action avecvalue. Appelle des méthodes en utilisant le nom de la méthode sous forme de chaîne, comme dans l'exemple suivant :
// Calls the private `processData` API with reflection myObject.javaClass.getMethod("processData", DataType::class.java) ?.invoke(myObject, data)
Vérifier les problèmes d'optimisation
Lorsque vous envisagez d'utiliser une nouvelle bibliothèque, consultez l'Issue Tracker et les discussions en ligne de la bibliothèque pour vérifier s'il existe des problèmes liés à la minimisation ou à la configuration de l'optimisation de l'application. Si c'est le cas, essayez de trouver des alternatives à cette bibliothèque. Tenez compte des informations suivantes :
- Les bibliothèques AndroidX et les bibliothèques telles que Hilt fonctionnent bien avec l'optimisation des applications, car elles utilisent principalement la génération de code au lieu de la réflexion. Lorsqu'elles utilisent la réflexion, elles fournissent des règles de conservation minimales pour ne conserver que le code nécessaire.
- Les bibliothèques de sérialisation utilisent fréquemment la réflexion pour éviter le code récurrent lors de l'instanciation ou de la sérialisation d'objets. Au lieu d'approches basées sur la réflexion (comme Gson pour JSON), recherchez des bibliothèques qui utilisent la génération de code pour éviter ces problèmes, par exemple en utilisant la sérialisation Kotlin ou Moshi avec la génération de code.
- Si possible, évitez les bibliothèques qui incluent des règles de conservation à l'échelle du package. Les règles de conservation à l'échelle du package peuvent aider à résoudre les erreurs, mais les règles de conservation générales doivent être affinées pour ne conserver que le code nécessaire. Pour en savoir plus, consultez Adopter des optimisations de manière incrémentielle.
- Avant de publier une application qui utilise une bibliothèque tierce, utilisez l'analyseur de configuration R8 pour auditer les règles de conservation fournies. En examinant le rapport, vous pouvez vérifier si les règles de conservation de la bibliothèque sont trop larges, ce qui empêche R8 d'effectuer des optimisations critiques sur votre codebase. Cette vérification permet de s'assurer que les bibliothèques que vous sélectionnez sont conformes aux objectifs de performances de votre application et n'introduisent pas de surcharge de configuration inutile.
- Les bibliothèques ne doivent pas vous obliger à copier et coller des règles de conservation de la documentation dans un fichier de votre projet, en particulier les règles de conservation à l'échelle du package. Ces règles deviennent une charge de maintenance pour le développeur d'applications à long terme, et sont difficiles à optimiser et à modifier au fil du temps.
Activer l'optimisation après l'ajout d'une bibliothèque
Lorsque vous ajoutez une bibliothèque, activez l'optimisation, puis vérifiez s'il y a des erreurs. En cas d'erreurs, recherchez des alternatives à cette bibliothèque ou écrivez des règles de conservation. Si une bibliothèque n'est pas compatible avec l'optimisation, signalez un bug pour cette bibliothèque.
Filtrer les règles de conservation incorrectes (avancé)
Les règles de conservation sont cumulables. Cela signifie que certaines règles incluses dans une dépendance de bibliothèque ne peuvent pas être supprimées et peuvent affecter la compilation d'autres parties de votre application. Par exemple, si une bibliothèque inclut une règle permettant de désactiver les optimisations de code, cette règle désactive les optimisations pour l'ensemble de votre projet.
Évitez les bibliothèques avec des règles de conservation qui conservent du code qui devrait être supprimé. Toutefois, si vous devez les utiliser, vous pouvez filtrer les règles comme indiqué dans le code suivant :
// If you're using AGP 8.4 and higher
buildTypes {
release {
optimization.keepRules {
it.ignoreFrom("com.somelibrary:somelibrary")
}
}
}
// If you're using AGP 7.3-8.3
buildTypes {
release {
optimization.keepRules {
it.ignoreExternalDependencies("com.somelibrary:somelibrary")
}
}
}
Workflow recommandé pour les règles de bibliothèque générales
Si l'analyseur de configuration R8 révèle qu'une bibliothèque regroupe des règles de conservation trop larges, filtrez ces règles uniquement dans les builds locaux, et non dans les builds de production. Pour tester l'impact des règles sur votre application, procédez comme suit :
- Mettez à jour la bibliothèque : assurez-vous d'utiliser la dernière version de la bibliothèque signalée par l'analyseur de configuration R8, car les versions plus récentes peuvent inclure des règles de conservation plus strictes pour les consommateurs. Pour trouver la dernière version, consultez la documentation de la bibliothèque ou son dépôt Maven. Android Studio signale également les versions plus récentes de nombreuses dépendances. Après la mise à jour, exécutez à nouveau l'analyseur de configuration R8 pour vérifier si les règles de conservation générales sont toujours présentes.
- Vérifiez l'amélioration potentielle localement : copiez les règles de consommation groupées de la bibliothèque dans votre fichier de règles de conservation local, filtrez les règles groupées comme indiqué dans Filtrer les règles de conservation incorrectes, puis affinez les règles copiées. Exécutez l'analyseur de configuration R8 avant et après avoir affiné les règles pour comparer les scores de réduction, d'optimisation et d'obscurcissement de votre application.
- Signalez les résultats : envoyez un rapport de bug au responsable de la bibliothèque contenant les données empiriques de votre rapport de l'analyseur de configuration R8 (par exemple, en indiquant le nombre spécifique de classes ou de méthodes non référencées conservées par leur règle de caractère générique).
Étude de cas : pourquoi Gson ne fonctionne pas avec les optimisations
Gson est une bibliothèque de sérialisation qui cause souvent des problèmes d'optimisation des applications, car elle utilise beaucoup la réflexion. L'extrait de code suivant montre comment Gson est généralement utilisé, ce qui peut entraîner des plantages au moment de l'exécution. Notez que lorsque vous utilisez Gson pour obtenir une liste d'objets User, vous n'appelez pas le constructeur et ne transmettez pas de fabrique à la fonction fromJson(). La construction ou l'utilisation de classes définies par l'application sans l'un des éléments suivants indique qu'une bibliothèque peut utiliser la réflexion ouverte :
- Classe d'application implémentant une bibliothèque, ou interface ou classe standard
- Plug-in de génération de code tel que KSP
class User(val name: String)
class UserList(val users: List<User>)
// This code runs in debug mode, but crashes when optimizations are enabled
Gson().fromJson("""[{"name":"myname"}]""", User::class.java).toString()
Pour comprendre le fonctionnement de R8 sur Gson, consultez les règles d'utilisation de Gson. Lorsque R8 analyse ce code et ne voit pas l'instanciation de UserList ou User, il peut renommer des champs ou supprimer des constructeurs qui ne semblent pas être utilisés, ce qui entraîne le plantage de votre application. Si vous utilisez d'autres bibliothèques de manière similaire, vous devez vérifier qu'elles n'interfèrent pas avec l'optimisation de l'application. Si c'est le cas, évitez-les.
Utiliser @SerializedName avec les versions ultérieures de Gson
Pour définir vos modèles de données de manière compatible avec les règles de consommation de Gson, annotez vos champs avec @SerializedName, comme indiqué dans l'extrait de code suivant :
import com.google.gson.annotations.SerializedName
class User(@SerializedName("name") val name: String)
class UserList(@SerializedName("users") val users: List<User>)
En utilisant l'annotation @SerializedName, vous permettez à R8 de faire correspondre vos classes de modèle aux règles de conservation incluses dans Gson version 2.11.0 et ultérieure.
R8 conserve automatiquement les champs annotés et les constructeurs nécessaires, ce qui vous permet de vous appuyer sur les règles groupées de la bibliothèque sans avoir à gérer manuellement les configurations ProGuard dans votre projet.
Notez que Room, Hilt et Moshi avec codegen construisent des types définis par l'application, mais utilisent codegen pour éviter d'avoir recours à la réflexion.