Android-kehittäjänä me kaikki käytämme Android Studiota sovellustemme kehittämiseen. Android-sovelluskehitykseen voidaan käyttää monia muitakin editoreita, mutta paras osa, joka houkuttelee minua käyttämään Android Studiota, on tuki, jota se tarjoaa Android-kehittäjille. Tuki voi olla automaattisten ehdotusten muodossa tai se voi olla virheiden näyttämistä koodissamme (kaikissa projektissamme olevissa tiedostoissa).
Tässä blogissa näemme siis yhden Android Studion parhaista ominaisuuksista, joka auttaa meitä parantamaan tapaamme kirjoittaa virheetöntä koodia ja tämä ominaisuus on Lint. Tässä blogissa käsiteltävät aiheet ovat:
- Mikä on Lint?
- Lintin konfigurointi
- Lintin käyttäminen
- Baselineen käyttäminen
- Manuaalisesti suoritettavat tarkastukset
- Johtopäätökset
Aloitetaan siis.
Mikä on Lint?
Lint on Android Studion tarjoama koodintarkistustyökalu, jolla tunnistetaan, ehdotetaan ja korjataan projektissa oleva väärä tai riskialtis koodi.
Lint on kuin täysimittainen pinoanalyysikehys
Me kaikki olemme käyttäneet Lintiä siitä lähtien, kun aloimme käyttää Android Studiota, koska oletuksena Android Studio tarjoaa tuen Lintille jokaisessa projektissamme. Lintin koodissasi havaitsemat ongelmat raportoidaan sinulle joidenkin ehdotusten ja varoitustason kanssa. Voit käyttää ehdotuksia koodisi korjaamiseen. Parasta Lintissä on se, että voit käyttää Linttiä tarpeen mukaan. Jos haluat nähdä tietyn tyyppisen virheen projektissasi, Lint näyttää vain tämän tyyppisen virheen. Lint on luonteeltaan muokattavissa. Oletusarvoisesti Android Studio suorittaa tarkastusprosessin aina kun rakennat projektisi, mutta tämän lisäksi voit tarkastaa koodisi Lintin avulla manuaalisesti tai komentoriviltä.
Oheinen kuva näyttää Lintin toiminnan:
Kuvan kohteliaisuus: Android Developer -sivusto
Koko lintin prosessi voidaan tiivistää kolmeen vaiheeseen:
- Tee lint.xml-tiedosto: Voit mukauttaa Lintin tarkistuksia lint.xml-tiedostossa. Tähän tiedostoon voit kirjoittaa tarkistukset, jotka haluat sisällyttää, ja jättää huomiotta tarkistukset, joita et halua sisällyttää. Jos esimerkiksi haluat tarkistaa käyttämättömän muuttujan ongelman etkä halua tarkistaa nimeämisongelmia, voit tehdä tämän lint.xml-tiedostossa. Tämän lisäksi voit muokata Lint-tarkistuksia myös manuaalisesti. Näemme, miten manuaalisia Lint-tarkistuksia tehdään tämän blogin seuraavassa osassa.
- Sovelluksen lähdetiedosto: Seuraava vaihe on valita lähdetiedostot, joille haluat tehdä Lint-tarkastuksen. Se voi olla .java-tiedosto tai .kt-tiedosto tai mikä tahansa projektisi xml-tiedosto.
- Lint-työkalu: Lopuksi lint-työkalu ottaa lähde- ja lint.xml-tiedostot ja tarkistaa koodin rakenteelliset ongelmat ja ehdottaa joitakin parannuksia koodiin, jos sellaisia on. On suositeltavaa käyttää lint-ehdotusta ennen sovelluksemme julkaisemista.
Milloin kannattaa käyttää Lint-työkalua?
Jos haluat julkaista sovelluksesi Play-kaupassa tai missä tahansa sovelluskaupassa, niin haluat virheettömän sovelluksen. Tätä varten sinun on suoritettava niin monta testausta sovelluksellesi manuaalisesti. Mutta jos haluat päästä eroon joistakin manuaalisista testeistä, voit käyttää Linttiä projektissasi. Voit tarkastaa koodisi jokaisen tiedoston löytääksesi jonkin virheen, ja Lint tunnistaa virheet ja ehdottaa vastauksia. Nämä virheet tai varoitukset voivat olla:
- Käyttämättömiä muuttujia
- Käsittelemättömiä poikkeuksia
- Importteja, joita ei käytetä projektissa, ja monia muita
Siten, ennen kuin julkaiset sovelluksesi, sinun kannattaa käyttää Linttiä tarkastamaan koodisi kokonaan.
Myös voit määrittää lint-tarkastuksen projektisi eri tasoille:
- Globaalisesti (koko projekti)
- Projektimoduuli
- Tuotantomoduuli
- Testimoduuli
- Avoinna olevat tiedostot
- Luokan hierarkia
- Versiohallintajärjestelmän (VCS) laajuudet
Lintin konfigurointi
Käyttääksesi Linttiä tai yksinkertaisesti suorittaaksesi tarkastuksia projektissasi, voit lisätä Lint-tarkastuksen linttiin.xml-tiedostoon tai voit manuaalisesti valita projektissasi Android Studion avulla luettelon lintin konfiguroitavista ongelmista.
- Konfiguroi lint-tiedosto: Jos haluat määrittää sovelluksessasi manuaaliset tarkistukset, lisää lint.xml-tiedostoon määritettävien ongelmien luettelo. Jos teet uuden lint.xml-tiedoston, varmista, että laitat sen Android-projektisi juurihakemistoon.
Seuraavassa on esimerkki lint.xml-tiedostosta:
<?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>- Määritä lint manuaalisesti: Oletusarvoisesti lint tarkistaa osan ongelmista, mutta ei kaikkia. Näin ei tehdä, koska jos suoritat kaikki ongelmien tarkistukset, jotka lint voi tarkistaa, Android Studion suorituskyky hidastuu. Android Studiossa käytetään siis oletusarvoisesti vain rajoitettua määrää lint-tarkastuksia. Voit kuitenkin lisätä lisää tarkistuksia ja poistaa tarkistuksia lintistä noudattamalla alla olevia ohjeita:
Mene kohtaan Tiedostot > Asetukset > Editor > Tarkistukset ja tarkista sitten ne ongelmatarkistukset, jotka haluat, että lintti suorittaa
Helping Lint
Monesti on olemassa tilanteita, joissa kirjoitat riskialtista tai virheitä täynnä olevaa koodia, mutta lintti ei näytä koodissasi yhtään vikaa tai varoitusta. Kirjoita esimerkiksi alla oleva koodi Android Studiossa:
fun updateUi() { // code goes here networkRequest()}fun networkRequest() { // code goes here }Yllä olevat koodirivit eivät näytä sinulle mitään virhettä, mutta loogisesti sen pitäisi näyttää jotain virhettä, koska käyttöliittymän päivityksen aikana verkkopyyntöä ei pitäisi kutsua. Joten, mitä voit tehdä tässä, on auttaa linttiä.
Help Lint auttaa sinua
Kyllä, jos autat linttiä niin lintti auttaa myös sinua. Joten auttaaksesi linttiä ymmärtämään koodia tarkemmin, yritä aina käyttää annotaatioita projektissasi. Kirjoita nyt sama some, jonka olet kirjoittanut aiemmin, ja tarkista sitten, onko siinä virheitä:
@UiThreadfun updateUi() { // code goes here networkRequest()}@WorkerThreadfun networkRequest() { // code goes here}Auta siis Linttiä käyttämällä annotaatioita koodissasi.
Baselineen käyttäminen
Jos työskentelet hyvin ison projektin parissa ja olet kiinnostunut löytämään tulevia virheitä, joita saattaa tulla, kun lisäät projektiin lisää koodia, niin voit lisätä projektiin baselineen, jolloin lintti generoi virheet, jotka ovat ilmenneet kyseisen baselineen jälkeen. Niinpä lint jättää huomiotta aiemmat koodiongelmat ja varoittaa sinua vain uusista koodiriveistä, jotka on lisätty perustason jälkeen.
Lisätäksesi perustason projektiin lisää alla oleva rivi projektisi build.gradle-tiedostoon:
android { lintOptions { baseline file("lint-baseline.xml") }}Tämä luo lint-baseline.xml-tiedoston, joka luo projektisi perustason. Jos haluat lisätä toisen perustason, poista tiedosto ja lint uudelleen.
Toinen asia, jonka voit tehdä tässä, on, että voit ottaa käyttöön minkä tahansa ongelman tarkistuksen vain tässä. Jos haluat esimerkiksi ottaa Kotlin-yhteensopivuuden tarkistuksen käyttöön, kirjoita alla oleva koodi:
android { lintOptions { baseline file("lint-baseline.xml") }}enable "Interoperability"Tarkastusten suorittaminen manuaalisesti
Voidaksesi tarkastaa tiedoston manuaalisesti Android Studiossa, noudata alla olevia vaiheita:
Vaihe 1: Siirry tiedostoon, jonka haluat tarkastaa.
Vaihe 2: Napsauta hiiren kakkospainiketta hiiren oikealla painikkeella ja siirry sen jälkeen kohteeseen: Analysoi > Tarkasta koodi. Alla oleva ikkuna avautuu:
Kuvan kohteliaisuus: Android Developer -sivusto
Tässä voit valita tarkastuksen laajuuden eli koko projektin tai moduulin tai vain tiedoston. Kun olet valinnut laajuuden, napsauta OK.
Jatkossa avautuu seuraava ikkuna:
Kuvan kohteliaisuus: Android Developer -sivusto
Luettelo virheluokista, -tyypeistä ja -ongelmista tulee näkyviin. Voit tarkastella tarkastustulosta laajentamalla virheen vasemmanpuoleisessa ruudun puunäkymässä.
Toisessa ruudussa eli oikeassa ruudussa näkyy valitun virheen tarkastusraportti.
Johtopäätös
Tässä blogissa opimme käyttämään Lintiä Android Studiossa. Näimme, että jos haluamme analysoida koodimme, meidän ei tarvitse tehdä sitä manuaalisesti. Android Studio tarjoaa koodintarkistustyökalun Lint, joka auttaa meitä puhdistamaan koodimme ja käyttämään tarvittavaa ja oikeaa koodia sovelluskehityksessä.
Käyttäkää siis Linttiä erilaisten virheiden poistamiseen projektissanne ja auttakaa myös Linttiä auttamaan teitä.
Jatkakaa oppimista 🙂
Team MindOrks.