Als Android-Entwickler verwenden wir alle Android Studio für die Entwicklung unserer Anwendungen. Es gibt viele andere Editoren, die für die Entwicklung von Android-Apps verwendet werden können, aber der beste Teil, der mich dazu bringt, Android Studio zu verwenden, ist die Unterstützung, die es den Android-Entwicklern bietet. Die Unterstützung kann in Form von automatischen Vorschlägen oder durch die Anzeige von Fehlern in unserem Code (in allen Dateien in unserem Projekt) erfolgen.
In diesem Blog werden wir uns also eine der besten Funktionen von Android Studio ansehen, die uns hilft, unsere Art und Weise, fehlerfreien Code zu schreiben, zu verbessern, und diese Funktion ist Lint. Die Themen, die in diesem Blog behandelt werden, sind:
- Was ist Lint?
- Konfiguration von Lint
- Hilfe für Lint
- Verwendung von Baseline
- Manuelle Inspektionen
- Abschluss
So, lasst uns anfangen.
Was ist Lint?
Lint ist ein Code-Scan-Tool, das von Android Studio zur Verfügung gestellt wird, um den falschen oder riskanten Code im Projekt zu identifizieren, vorzuschlagen und zu korrigieren.
Lint ist wie ein vollwertiges Stack-Analyse-Framework
Wir alle haben Lint benutzt, seit wir angefangen haben, Android Studio zu benutzen, weil Android Studio standardmäßig die Unterstützung für Lint in jedem unserer Projekte bietet. Die von Lint in Ihrem Code entdeckten Probleme werden Ihnen mit einigen Vorschlägen und einer Warnstufe gemeldet. Sie können die Vorschläge nutzen, um Ihren Code zu korrigieren. Der beste Teil von Lint ist, dass Sie Lint nach Ihren Bedürfnissen einsetzen können. Wenn Sie einen bestimmten Fehlertyp in Ihrem Projekt sehen wollen, wird Lint Ihnen nur diesen Fehlertyp anzeigen. Lint ist von Natur aus anpassbar. Standardmäßig führt Android Studio den Inspektionsprozess aus, wenn Sie Ihr Projekt erstellen, aber abgesehen davon können Sie Ihren Code mit Hilfe von Lint manuell oder von der Kommandozeile aus überprüfen.
Das folgende Bild zeigt die Funktionsweise von Lint:
Bild mit freundlicher Genehmigung: Android Developer Website
Der gesamte Prozess von Lint lässt sich in drei Schritten zusammenfassen:
- Erstellen der Datei lint.xml: Sie können die Lint-Prüfungen in der Datei lint.xml anpassen. In diese Datei können Sie die Prüfungen eintragen, die Sie einbeziehen wollen, und die Prüfungen ignorieren, die Sie nicht einbeziehen wollen. Wenn Sie zum Beispiel das Problem der unbenutzten Variablen prüfen wollen und nicht auf Benennungsprobleme prüfen wollen, können Sie dies in der Datei lint.xml tun. Abgesehen davon können Sie die Lint-Prüfungen auch manuell anpassen. Wir werden im nächsten Teil dieses Blogs sehen, wie man manuelle Lint-Prüfungen durchführt.
- Quelldatei der Anwendung: Der nächste Schritt besteht darin, die Quelldateien auszuwählen, für die Sie die Lint-Prüfung durchführen möchten. Das kann Ihre .java-Datei oder .kt-Datei oder eine beliebige xml-Datei Ihres Projekts sein.
- Das Lint-Tool: Schließlich nimmt das Lint-Tool die Quell- und lint.xml-Dateien und prüft auf strukturelle Code-Probleme und schlägt ggf. Verbesserungen im Code vor. Es wird empfohlen, den Lint-Vorschlag zu verwenden, bevor wir unsere App veröffentlichen.
Wann sollte man Lint verwenden?
Wenn Sie Ihre App im Play Store oder einem anderen App Store veröffentlichen möchten, dann möchten Sie eine fehlerfreie App haben. Zu diesem Zweck müssen Sie so viele Tests für Ihre App manuell durchführen. Wenn Sie jedoch einige der manuellen Tests loswerden möchten, können Sie Lint in Ihrem Projekt verwenden. Sie können jede einzelne Datei Ihres Codes untersuchen, um einen Fehler zu finden, und Lint wird die Fehler identifizieren und einige Antworten vorschlagen. Diese Fehler oder Warnungen können sein:
- Unverwendete Variablen
- Unbehandelte Ausnahmen
- Imports, die im Projekt nicht verwendet werden, und viele mehr
So, bevor Sie Ihre Anwendung veröffentlichen, sollten Sie Lint verwenden, um Ihren Code vollständig zu überprüfen.
Außerdem können Sie die Lint-Prüfung für verschiedene Ebenen Ihres Projekts konfigurieren:
- Global (gesamtes Projekt)
- Projektmodul
- Produktionsmodul
- Testmodul
- Geöffnete Dateien
- Klasse Hierarchie
- Versionskontrollsystem (VCS)-Bereiche
Konfiguration von Lint
Um Lint zu verwenden oder einfach Inspektionen in Ihrem Projekt durchzuführen, können Sie die Lint-Inspektion in der Datei lint.xml-Datei hinzufügen oder Sie können die Liste der Probleme, die von Lint in Ihrem Projekt konfiguriert werden sollen, manuell auswählen, indem Sie Android Studio verwenden.
- Konfigurieren Sie die Lint-Datei: Um manuelle Prüfungen in Ihrer App festzulegen, fügen Sie die Liste der zu konfigurierenden Probleme in der Datei lint.xml hinzu. Wenn Sie eine neue lint.xml-Datei erstellen, stellen Sie sicher, dass Sie sie in das Stammverzeichnis Ihres Android-Projekts legen.
Nachfolgend ein Beispiel für eine lint.xml-Datei:
<?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>- Lint manuell konfigurieren: Standardmäßig prüft lint auf eine Reihe von Problemen, aber nicht auf alle Probleme. Dies wird nicht gemacht, weil die Leistung von Android Studio verlangsamt wird, wenn Sie alle Probleme überprüfen, die Lint überprüfen kann. Daher wird in Android Studio standardmäßig nur eine begrenzte Anzahl von Lint-Prüfungen verwendet. Sie können jedoch weitere Prüfungen hinzufügen und Prüfungen aus dem Lint entfernen, indem Sie die folgenden Schritte befolgen:
Gehen Sie zu Dateien > Einstellungen > Editor > Inspektionen und markieren Sie dann die Fehlerprüfungen, die vom Lint durchgeführt werden sollen
Hilfe für Lint
Es gibt viele Fälle, in denen Sie einen riskanten oder fehlerhaften Code schreiben, aber das Lint zeigt keine Fehler oder Warnungen für Ihren Code an. Schreiben Sie zum Beispiel den folgenden Code in Android Studio:
fun updateUi() { // code goes here networkRequest()}fun networkRequest() { // code goes here }Die obigen Codezeilen zeigen keinen Fehler an, aber logischerweise sollten sie einen Fehler anzeigen, da während der Aktualisierung der Benutzeroberfläche keine Netzwerkanforderung aufgerufen werden sollte. Also, was Sie hier tun können, ist dem Lint zu helfen.
Help Lint helps you
Ja, wenn Sie dem Lint helfen, dann wird Lint auch Ihnen helfen. Um also dem Lint zu helfen, den Code genauer zu verstehen, versuchen Sie immer, Anmerkungen in Ihrem Projekt zu verwenden. Schreiben Sie nun denselben Code, den Sie zuvor geschrieben haben, und suchen Sie dann nach Fehlern:
@UiThreadfun updateUi() { // code goes here networkRequest()}@WorkerThreadfun networkRequest() { // code goes here}So helfen Sie Lint, indem Sie Anmerkungen in Ihrem Code verwenden.
Benutzung der Baseline
Wenn Sie an einem sehr großen Projekt arbeiten und daran interessiert sind, zukünftige Fehler zu finden, die beim Hinzufügen von weiteren Codes zu Ihrem Projekt auftreten könnten, dann können Sie eine Baseline zu Ihrem Projekt hinzufügen, und dadurch wird Lint die Fehler generieren, die nach dieser Baseline aufgetreten sind. So wird Lint die vorherigen Codeprobleme ignorieren und Sie nur vor den neuen Codezeilen warnen, die nach der Baseline hinzugefügt wurden.
Um eine Baseline zu Ihrem Projekt hinzuzufügen, fügen Sie die folgende Zeile in die build.gradle-Datei Ihres Projekts ein:
android { lintOptions { baseline file("lint-baseline.xml") }}Dadurch wird eine lint-baseline.xml erstellt, die eine Baseline für Ihr Projekt erstellt. Um eine weitere Baseline hinzuzufügen, löschen Sie die Datei und die lint erneut.
Eine weitere Möglichkeit, die Sie hier nutzen können, ist, dass Sie hier jede Art von Fehlerprüfung aktivieren können. Um zum Beispiel die Kotlin-Interoperabilitätsprüfung zu aktivieren, schreiben Sie den folgenden Code:
android { lintOptions { baseline file("lint-baseline.xml") }}enable "Interoperability"Inspektionen manuell ausführen
Um eine Datei in Android Studio manuell zu inspizieren, folgen Sie den folgenden Schritten:
Schritt 1: Gehen Sie zu der Datei, die Sie inspizieren möchten.
Schritt 2: Klicken Sie mit der rechten Maustaste und gehen Sie dann auf Analysieren > Code inspizieren. Das folgende Fenster wird geöffnet:
Bild mit freundlicher Genehmigung: Android Developer Website
Hier können Sie Ihren Prüfbereich auswählen, d.h. das gesamte Projekt oder Modul oder einfach eine Datei. Nachdem Sie den Bereich ausgewählt haben, klicken Sie auf OK.
Das folgende Fenster wird geöffnet:
Bild mit freundlicher Genehmigung: Android Developer Website
Eine Liste der Fehlerkategorien, -typen und -probleme wird angezeigt. Sie können das Inspektionsergebnis anzeigen, indem Sie den Fehler in der Baumansicht des linken Bereichs erweitern.
Im anderen Bereich, d.h. dem rechten Bereich, wird der Inspektionsbericht für den ausgewählten Fehler angezeigt.
Abschluss
In diesem Blog haben wir gelernt, wie man Lint in Android Studio verwendet. Wir haben gesehen, dass wir, wenn wir unseren Code analysieren wollen, dies nicht manuell tun müssen. Android Studio bietet ein Codeüberprüfungs-Tool Lint, das uns hilft, unseren Code zu säubern und den notwendigen und richtigen Code für die Anwendungsentwicklung zu verwenden.
So, verwenden Sie Lint für die Beseitigung verschiedener Arten von Fehlern in Ihrem Projekt und helfen Sie auch dem Lint, Ihnen zu helfen.
Keep Learning 🙂
Team MindOrks.