Lint: mga batayan, static na tagasuri para sa mga proyektong Android

Ano ang Lint — static na tagasuri ng code?

Android Lint — kasangkapan ng static na pagsusuri na bahagi ng Android SDK at Android Studio. Ini-scan ng Lint ang source code ng app nang hindi ito pinapatakbo at natatagpuan ang mga problemang hindi napapansin ng compiler: hindi nagamit na mga resource, maling lokalisasyon, potensyal na pagtagas ng memorya, hindi pagkakatugma ng API sa minSdkVersion at paglabag sa mga rekomendasyon ng Google tungkol sa performance.

Static na pagsusuri — paraan ng pagsusuri ng software nang walang aktwal na pagpapatupad ng code. Hindi tulad ng compiler na sumusuri lamang ng syntax at mga uri, ang static na tagasuri ay naghahanap ng mga lohikal na error, anti-pattern at paglihis mula sa mga pinakamahusay na kasanayan. Ang Lint ay nagsasagawa ng higit sa 200 nakapaloob na pagsusuri ayon sa kategorya: correctness, performance, security, accessibility, usability at I18N.

Gumagana ang Lint sa maraming antas: Pagsusuri ng XML sumusuri ng mga layout, resource (strings, colors, dimens), manifest at mga file ng configuration. Pagsusuri ng Java/Kotlin — source code para sa mga tawag sa lumang API, problema sa thread at pagtagas ng konteksto. Pagsusuri ng Gradle — configuration ng build para sa pagkakatugma ng bersyon.

Paano sinusuri ng Lint ang code ng mga proyektong Android

Pagsusuri ng Lint ay pinapatakbo sa pamamagitan ng Android Studio (Analyze > Inspect Code) o utos ng Gradle: ./gradlew lint. Resulta — ulat ng HTML sa folder na build/reports/lint-results.html at ulat ng XML para sa mga sistema ng CI. Sinusuri ng Lint ang bawat file nang nakapag-iisa, na naglalapat ng isang hanay ng mga panuntunan (Issue), bawat isa ay may natatanging ID, paglalarawan, kategorya at antas ng kalubhaan.

Mga antas ng kalubhaan ng Lint: Error (error — humaharang sa build), Warning (babala — nakakaapekto sa kalidad), Informational (impormasyon — para sa kaalaman), Ignore (hindi pinapansin bilang default). Ang mga antas ay isinasaayos sa lint.xml. Ang mga error ng Lint ay maaaring isaayos upang ang Gradle build ay mabigo kapag mayroon sila sa pamamagitan ng lintOptions.abortOnError true.

android {
    lintOptions {
        abortOnError true
        checkAllWarnings true
        baselineFile file("lint-baseline.xml")
        htmlReport true
        xmlReport true
        lintConfig file("lint.xml")
    }
}

Lint baseline — file na nag-aayos ng mga kasalukuyang babala bilang katanggap-tanggap. Ginagawa gamit ang utos na lint --baseline baseline.xml. Pagkatapos idagdag ang baseline sa proyekto, ang Lint ay nag-uulat lamang ng mga bagong problema. Ito ay maginhawa para sa pagpapatupad ng Lint sa isang lumang proyekto na may daan-daang babala — unti-unting inaayos ng koponan ang mga error.

Pagsasaayos ng mga panuntunan ng Lint sa mga file ng configuration

lint.xml — file ng configuration sa ugat ng proyekto para sa pagtatakda ng mga panuntunan ng Lint. Dito tinutukoy ang mga hindi pinapansin na panuntunan, antas ng kalubhaan at mga eksepsiyon para sa mga partikular na file o direktoryo. Ang file ay ginagawa nang manu-mano at inilalapat nang pandaigdigan sa lahat ng modyul ng proyekto. Kung walang lint.xml, lahat ng panuntunan ay gumagana sa mga default na setting.

<?xml version="1.0" encoding="UTF-8"?>
<lint>
    <!-- Huwag paganahin ang pagsusuri ng hindi nagamit na mga resource -->
    <issue id="UnusedResources" severity="ignore" />

    <!-- Taasan ang kalubhaan ng pagtagas ng konteksto -->
    <issue id="StaticFieldLeak" severity="error" />

    <!-- Balewalain sa mga nabuong file -->
    <issue id="MissingTranslation" severity="ignore">
        <ignore path="build/generated" />
    </issue>
</lint>

@SuppressLint — anotasyon para hindi paganahin ang Lint sa antas ng pamamaraan o klase sa Java/Kotlin. Halimbawa: @SuppressLint("SetTextI18n") para sa pamamaraan kung saan ang teksto ay dinamikong itinatakda sa TextView. Ang anotasyong @RequiresApi ay tumutukoy sa pinakamababang antas ng API para sa isang pamamaraan — hindi maglalabas ng babala ang Lint kung ang minSdk ay mas mataas kaysa sa tinukoy na halaga.

Pagpapatakbo ng pagsusuri ng Lint sa pipeline ng CI/CD

Pagsasama ng CI ng Lint — karaniwang kasanayan sa pag-develop ng Android. Ang utos na ./gradlew lint ay nagpapatakbo ng pagsusuri ng lahat ng modyul at bumubuo ng mga ulat. Sa configuration ng CI/CD (Jenkins, GitLab CI, GitHub Actions) ang Lint ay pinapatakbo sa bawat pull request. Kapag may mga error, nabigo ang build at ang developer ay makakatanggap ng notipikasyon na may ulat na HTML ng Lint.

lint-check:
  script:
    - ./gradlew lint
  artifacts:
    paths:
      - app/build/reports/lint-results.html
    when: always

Ulat na HTML ng Lint ay naglalaman ng talaan ng lahat ng nakitang problema na may kategorya, ID ng panuntunan, file, linya at paglalarawan. Ang ulat ay makukuha sa CI server o inilalathala bilang artifact ng build. Ulat na XML (lint-results.xml) ay ginagamit para sa pagsasama sa mga sistema ng pagsusuri ng code (SonarQube, CodeClimate) at awtomatikong paggawa ng mga gawain sa mga tracker (Jira, YouTrack).

Lint sa pull request — i-configure ang GitHub Actions o GitLab CI upang ang Lint ay awtomatikong tumakbo kapag gumagawa ng MR/PR. Kung ang Lint ay makakita ng mga error, ang CI ay magbabalik ng status na failure at ang pagsasama ay haharangin. Ito ay pumipigil sa problematikong code na pumasok sa pangunahing sangay at nagpapanatili ng kalidad ng base ng code.

Mga pangunahing kategorya ng mga panuntunan ng Lint sa Android

Mga kategorya ng Lint ay sumasaklaw sa lahat ng aspeto ng pag-develop ng Android. Hinahati ng Google ang mga panuntunan sa 12 kategorya, bawat isa ay responsable para sa isang partikular na uri ng problema. Ang pinakamahalagang kategorya — Correctness, Performance, Security at Accessibility. Sapat na para sa developer na malaman ang mga pangunahing pagsusuri ng bawat kategorya para epektibong magtrabaho sa Lint.

Mga panuntunan ng Performance — pinakakapaki-pakinabang sa praktika. UnusedResources ay natagpuan ang mga resource na idineklara sa XML ngunit hindi ginagamit sa code. ViewHolder ay sumusuri kung ang pattern na ViewHolder ay ginagamit sa mga adapter ng RecyclerView. DrawAllocation ay nagbababala tungkol sa paggawa ng mga bagay sa pamamaraang onDraw. Ang pag-aayos ng mga problemang ito ay nagbabawas ng laki ng APK at nagpapabilis ng paggana ng app.

Mga panuntunan ng Security ay sapilitan para sa mga nai-publish na app. ExportedContentProvider ay sumusuri kung ang ContentProvider ay na-export nang walang proteksyon. WorldReadableFiles ay nagbababala tungkol sa paggawa ng mga file na naa-access sa lahat ng app. AllowBackup ay sumusuri sa flag na allowBackup sa manifest — inirerekomenda itong huwag paganahin para sa seguridad ng data.