En tant que développeur Android, nous utilisons tous Android Studio pour développer nos applications. Il existe de nombreux autres éditeurs qui peuvent être utilisés pour le développement d’applications Android, mais la meilleure partie qui m’attire à utiliser Android Studio est le support qu’il fournit aux développeurs Android. Le soutien peut être sous forme d’auto-suggestion ou il peut être de la forme de montrer les erreurs dans notre code(dans tous les fichiers présents dans notre projet).
Donc, dans ce blog, nous allons voir l’une des meilleures fonctionnalités d’Android Studio qui nous aide à améliorer notre façon d’écrire du code sans erreur et cette fonctionnalité est Lint. Les sujets qui seront abordés dans ce blog sont :
- Qu’est-ce que Lint ?
- Configuration de Lint
- Aider Lint
- Utiliser Baseline
- Lancer manuellement des inspections
- Conclusion
Alors, commençons.
Qu’est-ce que Lint ?
Lint est un outil d’analyse de code fourni par le Studio Android pour identifier, suggérer et corriger le code erroné ou le code à risque présent dans le projet.
Lint est comme un framework d’analyse de pile à part entière
Nous avons tous utilisé le Lint depuis que nous avons commencé à utiliser le Studio Android car par défaut le studio Android fournit le support pour le Lint dans notre chaque projet. Les problèmes détectés dans votre code par le Lint vous seront rapportés avec quelques suggestions et un niveau d’avertissement. Vous pouvez utiliser ces suggestions pour corriger votre code. La meilleure partie de Lint est que vous pouvez l’utiliser en fonction de vos besoins. Si vous voulez voir un type particulier d’erreur dans votre projet, Lint ne vous montrera que ce type d’erreur. Lint est personnalisable par nature. Par défaut, Android Studio exécute le processus d’inspection chaque fois que vous construisez votre projet, mais en dehors de cela, vous pouvez inspecter votre code avec l’aide de Lint manuellement ou à partir de la ligne de commande.
L’image suivante montre le fonctionnement de Lint:
Picture courtesy : Site web des développeurs Android
L’ensemble du processus de Lint peut être résumé en trois étapes :
- Création du fichier lint.xml : Vous pouvez personnaliser les vérifications de Lint dans le fichier lint.xml. Dans ce fichier, vous pouvez écrire les vérifications que vous voulez inclure et ignorer les vérifications que vous ne voulez pas inclure. Par exemple, si vous voulez vérifier le problème des variables inutilisées et ne voulez pas vérifier les problèmes de nom, vous pouvez le faire dans le fichier lint.xml. En dehors de cela, vous pouvez également personnaliser les vérifications de Lint manuellement. Nous verrons comment faire des contrôles Lint manuels dans la prochaine partie de ce blog.
- Fichier source de l’application : L’étape suivante consiste à sélectionner les fichiers sources sur lesquels vous souhaitez effectuer le contrôle Lint. Il peut s’agir de votre fichier .java ou .kt ou de tout fichier xml de votre projet.
- L’outil Lint : Enfin, l’outil lint prend les fichiers source et lint.xml et vérifie les problèmes structurels du code et suggère quelques améliorations dans le code le cas échéant. Il est suggéré d’utiliser la suggestion de lint avant de publier notre application.
Quand utiliser Lint?
Si vous voulez publier votre application sur le play store ou n’importe quel app store alors vous aimeriez avoir une application sans erreur. Pour ce faire, vous devez effectuer de nombreux tests sur votre application manuellement. Mais si vous voulez vous débarrasser de certains de ces tests manuels, vous pouvez utiliser Lint dans votre projet. Vous pouvez inspecter chaque fichier de votre code pour trouver une erreur et Lint identifiera les erreurs et suggérera des réponses. Ces erreurs ou avertissements peuvent être de:
- Variables inutilisées
- Exceptions non maîtrisées
- Imports qui ne sont pas utilisés dans le projet, et bien d’autres
Donc, avant de publier votre application, vous devriez utiliser Lint pour inspecter complètement votre code.
Aussi, vous pouvez configurer la vérification de lint pour différents niveaux de votre projet :
- Globalement (tout le projet)
- Module de projet
- Module de production
- Module de test
- Fichiers ouverts
- Class. hierarchy
- Version Control System (VCS) scopes
Configuration de Lint
Pour utiliser Lint ou simplement exécuter des inspections dans votre projet, vous pouvez ajouter l’inspection Lint dans le fichier lint.xml ou vous pouvez sélectionner manuellement la liste des problèmes à configurer par la lint dans votre projet en utilisant Android Studio.
- Configurer le fichier lint : Afin de spécifier des vérifications manuelles dans votre application, ajoutez la liste des problèmes à configurer dans le fichier lint.xml. Si vous faites un nouveau fichier lint.xml, alors assurez-vous de le mettre dans le répertoire racine de votre projet Android.
Voici un exemple de fichier lint.xml:
<?xml version="1.0" encoding="UTF-8"?><lint> <!-- Disable the given check in this project --> <issue severity="ignore" /> <!-- Ignore the ObsoleteLayoutParam issue in the specified files --> <issue> <ignore path="res/layout/activation.xml" /> <ignore path="res/layout-xlarge/activation.xml" /> </issue> <!-- Ignore the UselessLeaf issue in the specified file --> <issue> <ignore path="res/layout/main.xml" /> </issue> <!-- Change the severity of hardcoded strings to "error" --> <issue severity="error" /></lint>- Configurer le lint manuellement : Par défaut, lint vérifie un certain nombre de problèmes mais pas tous les problèmes. Cela n’est pas fait parce que si vous allez exécuter toute la vérification des problèmes que lint peut vérifier, alors les performances de l’Android Studio seront ralenties. Ainsi, seul un nombre limité de vérifications lint est utilisé par défaut dans Android Studio. Mais vous pouvez ajouter plus de vérifications et supprimer les vérifications de la lint en suivant les étapes ci-dessous:
Allez dans Files > Settings > Editor > Inspections et ensuite cochez les vérifications de problèmes que vous souhaitez que la lint
Helping Lint
Il y a plusieurs fois où vous écrivez un code risqué ou plein d’erreurs mais la lint ne montre aucune erreur ou avertissement à votre code. Par exemple, écrivez le code ci-dessous dans Android Studio:
fun updateUi() { // code goes here networkRequest()}fun networkRequest() { // code goes here }Les lignes de code ci-dessus ne vous montreront pas d’erreur, mais logiquement il devrait montrer une erreur parce que, pendant la mise à jour de l’interface utilisateur, la demande de réseau ne devrait pas être appelée. Donc, ce que vous pouvez faire ici est d’aider le lint.
Aidez le lint vous aide
Oui, si vous allez aider le lint alors le lint vous aidera aussi. Donc, afin d’aider la lint à comprendre le code d’une manière plus précise, essayez toujours d’utiliser des annotations dans votre projet. Maintenant, écrivez le même quelque que vous avez écrit précédemment et ensuite vérifiez l’erreur:
@UiThreadfun updateUi() { // code goes here networkRequest()}@WorkerThreadfun networkRequest() { // code goes here}Donc, aidez Lint en utilisant des annotations dans votre code.
Utilisation de la ligne de base
Si vous travaillez sur un très grand projet et que vous êtes intéressé à trouver les erreurs futures qui pourraient venir en ajoutant quelques codes supplémentaires à votre projet, alors vous pouvez ajouter une ligne de base à votre projet et en faisant cela, lint générera les erreurs qui se sont produites après cette ligne de base. Ainsi, lint ignorera les problèmes de code précédents et vous avertira uniquement sur les nouvelles lignes de code ajoutées après la ligne de base.
Pour ajouter une ligne de base dans votre projet, ajoutez la ligne ci-dessous dans le fichier build.gradle de votre projet:
android { lintOptions { baseline file("lint-baseline.xml") }}Cela créera un lint-baseline.xml qui établira une ligne de base de votre projet. Pour ajouter une autre baseline, supprimez le fichier et le lint à nouveau.
Une autre chose que vous pouvez faire ici est, vous pouvez activer n’importe quel type de vérification des problèmes ici seulement. Par exemple, afin d’activer la vérification de l’interopérabilité Kotlin, écrivez le code ci-dessous :
android { lintOptions { baseline file("lint-baseline.xml") }}enable "Interoperability"Exécuter manuellement des inspections
Afin d’inspecter manuellement un fichier dans Android Studio, suivez les étapes ci-dessous :
Étape 1 : Allez au fichier que vous voulez inspecter.
Étape 2 : Cliquez avec le bouton droit de la souris, puis allez à Analyser > Inspecter le code. La fenêtre ci-dessous s’ouvrira :
Courtoise image : Site web des développeurs Android
Vous pouvez ici sélectionner la portée de votre inspection, c’est-à-dire le projet entier ou le module ou simplement un fichier. Après avoir sélectionné la portée, cliquez sur OK.
La fenêtre suivante s’ouvrira :
Courtoise image : Site web des développeurs Android
Une liste des catégories d’erreurs, des types et des problèmes sera là. Vous pouvez voir le résultat de l’inspection en développant l’erreur dans l’arborescence du volet de gauche.
Dans l’autre volet, c’est-à-dire le volet de droite, s’affiche le rapport d’inspection pour l’erreur sélectionnée.
Conclusion
Dans ce blog, nous avons appris à utiliser le Lint dans Android Studio. Nous avons vu que si nous voulons analyser notre code, alors nous n’avons pas besoin de le faire manuellement. Android Studio fournit un outil de vérification de code Lint, qui nous aide à nettoyer notre code et à utiliser le code nécessaire et correct pour le développement d’applications.
Donc, utilisez Lint pour la suppression de différents types d’erreurs dans votre projet et aidez également le lint à vous aider.
Keep Learning 🙂
Team MindOrks.