Všichni jako vývojáři Androidu používáme při vývoji aplikací Android Studio. Existuje mnoho dalších editorů, které lze použít pro vývoj aplikací pro Android, ale to nejlepší, co mě láká k používání Android Studia, je podpora, kterou poskytuje vývojářům pro Android. Podpora může mít podobu automatických návrhů nebo může mít podobu zobrazení chyb v našem kódu (ve všech souborech přítomných v našem projektu).
V tomto blogu se tedy podíváme na jednu z nejlepších funkcí aplikace Android Studio, která nám pomáhá zlepšit způsob psaní bezchybného kódu, a tou je funkce Lint. Témata, která budeme v tomto blogu probírat, jsou:
- Co je to Lint?
- Konfigurace Lint
- Pomoc Lint
- Používání Baseline
- Ruční spouštění kontrol
- Závěr
Takže začněme.
Co je Lint?
Lint je nástroj pro kontrolu kódu poskytovaný aplikací Android Studio, který slouží k identifikaci, návrhu a opravě chybného nebo rizikového kódu přítomného v projektu.
Lint je jako plnohodnotný rámec pro analýzu zásobníku
Všichni používáme Lint od chvíle, kdy jsme začali používat Android Studio, protože Android Studio ve výchozím nastavení poskytuje podporu pro Lint v každém našem projektu. Problémy, které Lint ve vašem kódu zjistí, vám nahlásí s určitými návrhy a úrovní varování. Tyto návrhy můžete použít k opravě svého kódu. Nejlepší na funkci Lint je, že ji můžete používat podle svých potřeb. Pokud chcete ve svém projektu vidět určitý typ chyby, pak vám Lint zobrazí pouze tento typ chyby. Lint je svou povahou přizpůsobitelný. Ve výchozím nastavení spouští Android Studio proces kontroly vždy, když sestavujete svůj projekt, ale kromě toho můžete svůj kód kontrolovat pomocí Lint ručně nebo z příkazového řádku.
Následující obrázek ukazuje fungování Lint:
Obrázek s laskavým svolením: Webové stránky Android Developer
Celý proces lint lze shrnout do tří kroků:
- Vytvoření souboru lint.xml: V souboru lint.xml můžete přizpůsobit kontroly Lint. V tomto souboru můžete zapsat kontroly, které chcete zahrnout, a ignorovat kontroly, které zahrnout nechcete. Pokud například chcete zkontrolovat problém nepoužívané proměnné a nechcete kontrolovat problémy s pojmenováním, pak to můžete udělat v souboru lint.xml. Kromě toho můžete kontroly Lint přizpůsobit také ručně. V další části tohoto blogu si ukážeme, jak provádět ruční kontroly Lint.
- Zdrojový soubor aplikace: Dalším krokem je výběr zdrojových souborů, u kterých chcete provést kontrolu Lint. Může to být váš soubor .java nebo .kt nebo jakýkoli soubor xml vašeho projektu.
- Nástroj Lint: Nakonec nástroj lint vezme zdrojové soubory a soubor lint.xml a zkontroluje strukturální problémy kódu a navrhne případná vylepšení kódu. Doporučuje se použít návrh nástroje lint před zveřejněním naší aplikace.
Kdy použít nástroj Lint?
Pokud chcete zveřejnit svou aplikaci v obchodě Play nebo jiném obchodě s aplikacemi, pak byste chtěli mít aplikaci bez chyb. Za tímto účelem musíte na své aplikaci provést tolik testů ručně. Pokud se však chcete některých ručních testů zbavit, můžete ve svém projektu použít nástroj Lint. Můžete zkontrolovat každý soubor svého kódu a najít nějakou chybu a Lint tyto chyby identifikuje a navrhne nějaké odpovědi. Tyto chyby nebo varování mohou být z:
- Použité proměnné
- Nevyužité výjimky
- Importy, které se v projektu nepoužívají, a mnoho dalších
Před zveřejněním své aplikace byste tedy měli použít Lint k úplné kontrole svého kódu.
Také můžete nastavit kontrolu Lint pro různé úrovně vašeho projektu:
- Globálně (celý projekt)
- Modul projektu
- Modul výroby
- Testovací modul
- Otevřené soubory
- Třída hierarchie
- Obsah systému řízení verzí (VCS)
Konfigurace Lint
Pro použití Lint nebo prosté spuštění kontrol v projektu, můžete přidat inspekci Lint v nástroji lint.xml nebo můžete pomocí aplikace Android Studio ručně vybrat seznam problémů, které má lint ve vašem projektu konfigurovat.
- Konfigurace souboru lint: Chcete-li v aplikaci zadat ruční kontroly, přidejte seznam problémů, které mají být nakonfigurovány v souboru lint.xml. Pokud vytváříte nový soubor lint.xml, nezapomeňte jej umístit do kořenového adresáře projektu Android.
Následuje příklad souboru 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>- Konfigurace lint ručně: Ve výchozím nastavení lint kontroluje řadu problémů, ale ne všechny problémy. To se nedělá, protože pokud budete spouštět kontrolu všech problémů, které může lint kontrolovat, pak se zpomalí výkon aplikace Android Studio. Ve výchozím nastavení se tedy v aplikaci Android Studio používá pouze omezený počet kontrol lint. Můžete však přidat další kontroly a odebrat kontroly z lint podle následujících kroků:
Přejděte do Soubory > Nastavení > Editor > Kontroly a poté zaškrtněte kontroly problémů, které chcete, aby lint prováděl
Pomoc Lint
Mnohdy se stává, že píšete rizikový kód nebo kód plný chyb, ale lint nezobrazuje žádnou chybu nebo varování vašeho kódu. Například napište níže uvedený kód v aplikaci Android Studio:
fun updateUi() { // code goes here networkRequest()}fun networkRequest() { // code goes here }Výše uvedené řádky kódu vám nezobrazí žádnou chybu, ale logicky by měly zobrazit nějakou chybu, protože během aktualizace uživatelského rozhraní by se neměl volat síťový požadavek. Takže to, co zde můžete udělat, je pomoci lintu.
Pomůže vám Lint
Ano, pokud pomůžete lintu, pak vám pomůže i lint. Abyste tedy pomohli lintu přesněji pochopit kód, snažte se ve svém projektu vždy používat anotace. Nyní napište stejný nějaký, který jste napsali dříve, a pak zkontrolujte, zda v něm není chyba:
@UiThreadfun updateUi() { // code goes here networkRequest()}@WorkerThreadfun networkRequest() { // code goes here}Pomozte tedy lintu tím, že ve svém kódu použijete anotace.
Použití základní linie
Pokud pracujete na velmi rozsáhlém projektu a máte zájem o zjištění budoucích chyb, které mohou nastat při přidávání dalších kódů do projektu, pak můžete do projektu přidat základní linii a tím lint vygeneruje chyby, které se vyskytly po této základní linii. Lint tedy bude ignorovat předchozí problémy s kódem a upozorní vás pouze na nové řádky kódu přidané po základní linii.
Pro přidání základní linie do vašeho projektu přidejte do souboru build.gradle níže uvedený řádek:
android { lintOptions { baseline file("lint-baseline.xml") }}Tím vytvoříte soubor lint-baseline.xml, který vytvoří základní linii vašeho projektu. Chcete-li přidat další základní linii, odstraňte tento soubor a opět lint.
Další věc, kterou zde můžete udělat, je, že zde můžete povolit pouze jakýkoli typ kontroly problémů. Chcete-li například povolit kontrolu interoperability jazyka Kotlin, napište následující kód:
android { lintOptions { baseline file("lint-baseline.xml") }}enable "Interoperability"Ruční spuštění kontroly
Chcete-li ručně zkontrolovat soubor v aplikaci Android Studio, postupujte podle následujících kroků:
Krok 1: Přejděte na soubor, který chcete zkontrolovat.
Krok 2: Klikněte pravým tlačítkem myši a poté přejděte na položku Analyze > Inspect Code. Otevře se následující okno:
Obrázek s laskavým svolením: Vývojářské stránky Androidu
Zde můžete vybrat rozsah kontroly, tj. celý projekt nebo modul, nebo jen soubor. Po výběru rozsahu klepněte na tlačítko OK.
Otevře se následující okno:
Obrázek s laskavým svolením: Vývojářské stránky Androidu
Bude tam seznam kategorií chyb, typů a problémů. Výsledek kontroly můžete zobrazit rozbalením chyby ve stromovém zobrazení levého podokna.
V druhém podokně, tj. v pravém podokně, se zobrazí zpráva o kontrole vybrané chyby.
Závěr
V tomto blogu jsme se naučili používat nástroj Lint v aplikaci Android Studio. Viděli jsme, že pokud chceme analyzovat náš kód, pak to nemusíme dělat ručně. Android Studio poskytuje nástroj pro kontrolu kódu Lint, který nám pomůže vyčistit náš kód a použít potřebný a správný kód pro vývoj Aplikace.
Používejte tedy Lint pro odstranění různých typů chyb ve vašem projektu a také pomozte Lintu, aby vám pomohl.
Učte se dál 🙂
Tým MindOrks.