Memastikan Kode Android Kualitas Atas Dengan Static Analysis Tools

() translation by (you can also view the original English article)

Dalam tutorial hari ini, kita akan belajar tentang cara memastikan kode Android berkualitas tinggi dalam proyek kami menggunakan beberapa fasilitas analisis kode statis untuk Java. Kita akan melihat Checkstyle, FindBugs, PMD, dan Android Studio Lint — semuanya gratis dan open source!

Apa itu Fasilitas Analisis Kode Statis?

Ini adalah fasilitas yang mengurai dan menganalisis source code Anda tanpa benar-benar mengeksekusinya. Tujuannya adalah untuk menemukan potensi kerentanan terhadap kesalahan akibat bug dan keamanan. Fasilitas analisis kode statis gratis yang populer seperti FindBugs memeriksa kode Anda terhadap serangkaian aturan yang harus dipatuhi kode Anda — jika kode tidak mengikuti aturan ini, itu adalah tanda bahwa ada sesuatu yang salah. Pikirkanlah bahwa fasilitas analisis kode statis sebagai kompiler tambahan yang dijalankan sebelum kompilasi akhir ke dalam bahasa sistem.

Banyak perusahaan perangkat lunak yang mewajibkan proyek untuk lulus uji analisis kode statis, selain melakukan tinjauan kode dan pengujian unit dalam proses pembuatan. Bahkan pengelola proyek open-source sering kali menyertakan satu atau beberapa langkah analisis kode statis dalam proses pembuatan. Jadi belajar tentang analisis statis merupakan langkah penting dalam menulis kode yang kualitas. Ketahuilah bahwa analisis kode statis — juga dikenal sebagai pengujian "kotak putih" atau lebih dikenal sebagai "white-box" testing — tidak boleh dilihat sebagai pengganti unit-testing terhadap source-code Anda.

Dalam tutorial ini, kita akan belajar tentang beberapa fasilitas analisis statis populer yang tersedia untuk Android dan Java. Tapi pertama-tama, mari kita lihat beberapa manfaat menggunakan analisis statis.

Manfaat

Membantu mendeteksi potensi bug yang bahkan unit atau pengujian manual mungkin terlewatkan.
Menentukan aturan spesifik proyek. Misalnya, analisis statis sebagai bagian dari rangkaian proses pembuatan yang dapat membantu pendatang baru mendapatkan percepatan terhadap standar kode dari tim baru mereka.
Membantu Anda meningkatkan pengetahuan tentang bahasa baru.
Memindai seluruh proyek Anda, termasuk file yang mungkin belum pernah Anda baca.

Pengaturan

Semua fasilitas analisis kode yang akan kita pelajari dalam tutorial ini tersedia sebagai plugin Gradle, sehingga kita dapat membuat gradle secara individu untuk masing-masing tugas. Mari gunakan satu file Gradle yang akan menyertakan semuanya. Tapi sebelum itu, mari kita buat folder yang akan berisi semua file untuk analisis kode statis.

Buka Android Studio dan di dalam modul aplikasi (dalam tampilan Project), buat folder baru dan beri nama code_quality_tools. Folder ini akan berisi file XML untuk fasilitas analisis kode, dan itu juga akan memiliki file Gradle, yaiutu quality.gradle, yang akan menjalankan tugas analisis statis kami.

Android studio project structure screenshot

Akhirnya, kunjungi build.gradle Anda pada folder app module dan sertakan baris ini di akhir file:

1	apply from: '/code_quality_tools/quality.gradle'

Di sini, script Gradle quality.gradle kami sedang diterapkan dengan referensi ke lokasi file lokalnya.

Checkstyle

Dengan aturan yang Anda tetapkan dalam file XML untuk melaksanakan standar kode untuk proyek Anda, Checkstyle memberlakukan aturan tersebut dengan menganalisis source code Anda dan membandingkannya dengan standar atau konvensi kode yang dikenal.

Checkstyle adalah fasilitas open source yang secara aktif dikelola oleh komunitas. Ini berarti Anda dapat membuat pemeriksaan kustom Anda sendiri atau memodifikasi yang sudah ada sesuai dengan kebutuhan Anda. Sebagai contoh, Checkstyle dapat menjalankan pemeriksaan pada nama konstanta (final, static, atau keduanya) pada class Anda. Jika nama-nama konstanta Anda tidak menempel pada aturan yang berada dalam huruf besar dengan kata-kata dipisahkan oleh garis bawah, masalah akan ditandai dalam laporan akhir.

// incorrect 
private final static String myConstant = "myConstant";

// correct
private final static String MY_CONSTANT = "myConstant";

Mengintegrasikan Checkstyle

Saya akan menunjukkan cara mengintegrasikan Checkstyle ke dalam proyek Android Studio kami dan menunjukkan contoh praktis.

Pertama, kita perlu membuat aturan kode kita. Di dalam checkstyle.xml, kami membuat beberapa aturan konfigurasi Checkstyle yang akan dijalankan terhadap kode kami.

<?xml version="1.0"?><!DOCTYPE module PUBLIC
        "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
        "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
<module name="Checker">
    <module name="FileTabCharacter"/>
    <module name="TreeWalker">

        <!-- Checks for Naming Conventions                            -->
        <!-- See http://checkstyle.sourceforge.net/config_naming.html -->
        <module name="MethodName"/>
        <module name="ConstantName"/>

        <!-- Checks for Imports                                 -->
        <!-- See http://checkstyle.sourceforge.net/config_imports.html-->
        <module name="AvoidStarImport"/>
        <module name="UnusedImports"/>

        <!-- Checks for Size                                          -->
        <!-- See http://checkstyle.sourceforge.net/config_sizes       -->
        <module name="ParameterNumber">
            <property name="max" value="6"/>
        </module>
        
        <!-- other rules ignored for brevity -->
</module>

Pada kode di atas, kami menyertakan aturan atau pemeriksaan yang kami inginkan Checkstyle untuk memvalidasi dalam source code kami. Salah satu aturan adalah AvoidStarImport seperti namanya, memeriksa apakah source code Anda termasuk pernyataan impor seperti java.util.*. (Sebaliknya, Anda harus secara eksplisit menentukan paket untuk diimpor, misalnya java.util.Obsable).

Beberapa aturan memiliki properti, yang dapat kita atur seperti yang kita lakukan untuk ParameterNumber — ini membatasi jumlah parameter dari suatu method atau constructor. Secara default, properti max adalah 7, tetapi kami mengubahnya menjadi 6 sebagai gantinya. Lihatlah beberapa cara pemeriksaan lainnya di situs website Checkstyle.

Untuk menjalankan pemeriksaan ini, kita perlu membuat tugas untuk Gradle. Jadi kunjungi file quality.gradle dan buat tugas yang disebut checkstyle:

apply plugin: 'checkstyle'

task checkstyle(type: Checkstyle) {
    description 'Check code standard'
    group 'verification'

    configFile file('./code_quality_tools/checkstyle.xml')
    source 'src'
    include '**/*.java'
    exclude '**/gen/**'

    classpath = files()
    ignoreFailures = false
}

Perhatikan bahwa dalam kode di atas, pertama kali kami menerapkan plugin Checkstyle Gradle. Kami memberikan deskripsi dan menambahkannya ke grup Gradle yang sudah ditentukan yang disebut verifikasi.

Properti utama tugas Checkstyle Gradle yang kami perhatikan adalah:

configFile: file konfigurasi Checkstyle untuk digunakan.
IgnoreFailures: mengizinkan atau tidak untuk melanjutkan proses build jika ada peringatan.
include: termasuk kumpulan pattern.
exclude: kumpulan pattern pengecualian. Dalam hal ini, kami tidak memindai class yang dihasilkan.

Akhirnya, Anda dapat menjalankan skrip Gradle dengan mengunjungi jendela fasilitas Gradle di Android Studio, membuka grup verification, dan kemudian klik checkstyle untuk menjalankan tugas.

Gradle toolbar open to run checkstyle task

Cara lain adalah dengan menggunakan command line:

1	gradle checkstyle

Setelah tugas selesai dijalankan, laporan akan dibuat, yang tersedia di app modul > build > reports > checkstyle. Anda dapat membuka checkstyle.html untuk melihat laporan.

Android Studio Checkstyle report folder location

Sebuah plugin Checkstyle tersedia secara gratis untuk Android Studio atau IntelliJ IDEA. Ini menawarkan pemindaian real-time file Java Anda.

PMD

PMD adalah fasilitas kode analisis yang open source terbuka lain yang menganalisis source code Anda. Ia menemukan kekurangan umum seperti variabel yang tidak digunakan, empty catch block, pembuatan objek yang tidak perlu dan sebagainya. PMD memiliki banyak set aturan yang dapat Anda pilih. Contoh aturan yang merupakan bagian dari set Aturan Desain adalah:

SimplifyBooleanExpressions: hindari perbandingan yang tidak perlu dalam ekspresi boolean yang memperumit kode sederhana. Sebagai contoh:

public class Bar {
 // can be simplified to
 // bar = isFoo();
 private boolean bar = (isFoo() == true);

 public isFoo() { return false;}
}

PMD dikonfigurasi dengan file pmd.xml. Di dalamnya, kami akan menyertakan beberapa aturan konfigurasi seperti untuk Android, Naming, dan Desain.

<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Android Application Rules"
         xmlns="http://pmd.sf.net/ruleset/1.0.0"
         xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"
         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd">

    <description>Custom ruleset for Android application</description>

    <exclude-pattern>.*/R.java</exclude-pattern>
    <exclude-pattern>.*/gen/.*</exclude-pattern>

    <!-- Android --->
    <!-- http://pmd.sourceforge.net/pmd-4.3.0/rules/android.html -->
    <rule ref="rulesets/java/android.xml"/>
    
    <!-- Design -->
    <!-- http://pmd.sourceforge.net/pmd-4.3.0/rules/design.html -->
    <rule ref="rulesets/java/design.xml">
        <exclude name="UncommentedEmptyMethod"/>
    </rule>

    <!-- Naming -->
    <!-- http://pmd.sourceforge.net/pmd-4.3.0/rules/naming.html -->
    <rule ref="rulesets/java/naming.xml/ShortClassName">
        <properties>
            <property name="minimum" value="3"/>
        </properties>
    </rule>
    <!-- other rules ignored for brevity -->
</ruleset>

Seperti yang kami lakukan untuk Checkstyle, kami juga perlu membuat tugas PMD Gradle untuk pemeriksaan yang akan dijalankan di dalam file quality.gradle.

apply plugin: 'pmd'

task pmd(type: Pmd) {
    description 'Run PMD'
    group 'verification'
    ruleSetFiles = files("./code_quality_tools/pmd.xml")
    source 'src'
    include '**/*.java'
    exclude '**/gen/**'
    reports {
        xml.enabled = false
        html.enabled = true
    }

    ignoreFailures = false
}

PMD juga tersedia sebagai plugin Gradle.

Properti utama dari tugas yang kami buat adalah:

ruleSetFiles: Aturan khusus mengatur file yang akan digunakan.
source: source untuk tugas ini
reports: Laporan yang dihasilkan oleh tugas ini.

Akhirnya, Anda dapat menjalankan script Gradle dengan mengunjungi fasilitas jendela Gradle, membuka folder grup verifikasi, dan kemudian klik pmd untuk menjalankan tugas. Atau Anda dapat menjalankannya melalui baris perintah:

1	gradle pmd

Laporan juga akan dihasilkan setelah mengeksekusi tugas yang tersedia di app module > build > reports > pmd. Ada juga plugin PMD yang tersedia untuk IntelliJ atau Android Studio untuk Anda unduh dan integrasikan jika Anda mau.

FindBugs

FindBugs adalah fasilitas analisis statis gratis yang menganalisis class Anda yang mencari potensi masalah dengan memeriksa bytecode Anda terhadap daftar pola dari bug yang diketahui. Beberapa dari mereka adalah:

Class mendifinisakn hashCode() but not equals(): Sebuah kelas mengimplementasikan method hashCode() but not equals() - oleh karena itu dua instance mungkin sama tetapi tidak memiliki kode hash yang sama. Ini termasuk kategori praktik yang buruk.
Pembandingan buruk nilai int dengan konstanta long: Kode ini membandingkan nilai int dengan konstanta long yang berada di luar rentang nilai yang dapat direpresentasikan sebagai nilai int. Perbandingan ini kosong dan mungkin akan menghasilkan hasil yang tidak diharapkan. Ini termasuk dalam cara kategori yang benar.
TestCase tidak memiliki tes: class adalah JUnit TestCase tetapi belum menerapkan metode uji apa pun. Pola ini juga berada di bawah kategori kebenaran.

FindBugs adalah proyek open source, sehingga Anda dapat melihat, berkontribusi, atau memantau kemajuan kode sumber di GitHub.

Di file findbugs-exclude.xml, kami ingin mencegah FindBugs dari pemindaian beberapa class (menggunakan ekspresi reguler) dalam proyek kami, seperti class resource yang dibuat secara otomatis dan class manifest yang dibuat secara otomatis. Juga, jika Anda menggunakan Dagger, kami ingin FindBugs tidak memeriksa class Dagger yang dihasilkan. Kami juga dapat memberi tahu FindBugs untuk mengabaikan beberapa aturan jika kami mau.

<FindBugsFilter>
    <!-- Do not check auto-generated resources classes -->
    <Match>
        <Class name="~.*R\$.*"/>
    </Match>

    <!-- Do not check auto-generated manifest classes -->
    <Match>
        <Class name="~.*Manifest\$.*"/>
    </Match>

    <!-- Do not check auto-generated classes (Dagger puts $ into class names) -->
    <Match>
        <Class name="~.*Dagger*.*"/>
    </Match>
    
    <!-- http://findbugs.sourceforge.net/bugDescriptions.html#ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD-->
     <Match>
        <Bug pattern="ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD" />
    </Match>
</FindBugsFilter>

Dan akhirnya, kami akan menyertakan tugas findbugs di quality.gradle:

apply plugin: 'findbugs'

task findbugs(type: FindBugs) {
    description 'Run findbugs'
    group 'verification'
    classes = files("$project.buildDir/intermediates/classes")
    source 'src'
    classpath = files()
    effort 'max'
    reportLevel = "high"
    excludeFilter file('./code_quality_tools/findbugs-exclude.xml')
    reports {
        xml.enabled = false
        html.enabled = true
    }
    ignoreFailures = false
}

Pada baris pertama di atas, kami menerapkan FindBugs sebagai Plugin Gradle dan kemudian membuat tugas yang disebut findbugs. Properti utama dari tugas findbugs yang benar-benar kami perhatikan adalah:

classes: class yang akan dianalisis.
effort: tingkat usaha analisis. Nilai yang ditentukan harus berupa min, default, atau max. Ketahuilah bahwa tingkat yang lebih tinggi meningkatkan ketepatan dan menemukan lebih banyak bug dengan mengorbankan running-time dan konsumsi memori.
reportLevel: ambang prioritas untuk melaporkan bug. Jika diatur ke rendah, semua bug dilaporkan. Jika ditetapkan ke sedang (default), bug prioritas menengah dan tinggi dilaporkan. Jika diatur ke tinggi, hanya bug prioritas tinggi yang dilaporkan.
excludeFilter: nama file dari filter yang menentukan bug untuk dikecualikan dari yang dilaporkan, yang sudah kami buat.

Anda kemudian dapat menjalankan skrip Gradle dengan mengunjungi jendela alat Gradle, membuka folder grup verifikasi, dan kemudian mengklik findbugs untuk menjalankan tugas. Atau luncurkan dari command line:

1	gradle findbugs

Laporan juga akan dihasilkan ketika tugas telah selesai dijalankan. Ini akan tersedia di modul app module > build > reports > findbugs. Plugin FindBugs adalah plugin lain yang tersedia secara gratis untuk diunduh dan terintegrasi dengan IntelliJ IDEA atau Android Studio.

Android Lint

Lint adalah fasilitas analisis kode lainnya, tetapi yang ini hadir dengan Android Studio secara default. Ini memeriksa file sumber proyek Android Anda untuk bug potensial dan optimasi untuk kebenaran, keamanan, kinerja, kegunaan, aksesibilitas, dan internasionalisasi.

Untuk mengonfigurasi Lint, Anda harus menyertakan blok lintOptions {} di file build.gradle tingkat modul Anda:

lintOptions {
    abortOnError false
    quiet true
    lintConfig file('./code_quality_tools/lint.xml')
}

Pilihan Kunci Lint kita perhatikan adalah:

abortOnError: apakah lint harus mengatur kode keluaran dari proses jika kesalahan ditemukan.
quiet: apakah akan mematikan analisa kemajuan dari laporan.
lintConfig: file konfigurasi default untuk digunakan.

File lint.xml Anda dapat menyertakan masalah yang Anda ingin lakukan proses Lint untuk diabaikan atau modifikasi, seperti contoh di bawah ini:

<?xml version="1.0" encoding="UTF-8"?>
<lint>
    <!-- Disable the given check in this project -->
    <issue id="IconMissingDensityFolder" severity="ignore" />

    <!-- Change the severity of hardcoded strings to "error" -->
    <issue id="HardcodedText" severity="error" />
</lint>

Anda dapat menjalankan Lint secara manual dari Android Studio dengan mengklik menu Analyze, memilih Inspect Code... (ruang lingkup pemeriksaan adalah keseluruhan proyek), dan kemudian klik tombol OK untuk melanjutkan.

Android Studio lint inspect whole project code dialog

Anda juga dapat menjalankan Lint dengan mengunjungi fasilitas dari jendela Gradle, membuka grup verification, dan kemudian mengklik lint. Akhirnya, Anda dapat menjalankannya melalui baris perintah.

Pada Windows:

1	gradlew lint

Di Linux atau Mac:

1	./gradlew lint

Laporan juga akan dihasilkan ketika tugas telah selesai dijalankan, yang tersedia di app module > build > outputs > lint-results.html.

Bonus: StrictMode

StrictMode adalah fasilitas pengembang yang membantu mencegah pengembang proyek Anda melakukan sembarang flash I/O atau network I/O di thread utama, karena ini dapat menyebabkan aplikasi menjadi lamban atau tidak responsif. Ini juga membantu mencegah dialog ANR (App Not Responding) muncul. Dengan diperbaikinya masalah StrictMode, aplikasi Anda akan menjadi lebih responsif dan pengguna akan menikmati pengalaman yang lebih lancar. StrictMode menggunakan dua set kebijakan untuk melaksanakan aturannya:

VM Policies: menjaga praktik pemrograman yang buruk seperti tidak menutup objek SQLiteCursor atau objek Closeable apa pun yang telah dibuat.
Thread Policies: berhati-hati untuk operasi seperti flash I/O dan network I/O yang dilakukan pada application thread utama bukan pada background thread.

if (BuildConfig.DEBUG) {
    StrictMode.setThreadPolicy(new StrictMode.ThreadPolicy.Builder()
            .detectDiskReads()
            .detectDiskWrites()
            .detectNetwork()   // or .detectAll() for all detectable problems
            .penaltyLog() // Log detected violations to the system log.
            .build());
    StrictMode.setVmPolicy(new StrictMode.VmPolicy.Builder()
            .detectLeakedSqlLiteObjects()
            .detectLeakedClosableObjects() 
            .penaltyLog() 
            .penaltyDeath() // Crashes the whole process on violation.
            .build());
}

Kode di atas dapat berupa Aplikasi, Activity, atau komponen aplikasi lainnya pada method onCreate().

Anda dapat mempelajari lebih lanjut tentang StrictMode di sini di Envato Tuts+.

Android SDK

Praktik Terbaik Android: StrictMode

Shane Conder & Lauren Darcey

Contoh proyek Android yang menerapkan semua hal di atas termasuk kumpulan aturan dari fasilitas untuk proyek Android yang khas dapat ditemukan di repositori GitHub postingan ini.

Kesimpulan

Dalam tutorial ini, Anda belajar tentang cara memastikan kode Android berkualitas tinggi menggunakan fasilitas analisis kode statis: apa itu, manfaat penggunaannya, dan cara menggunakan Checkstyle, FindBugs, Lint, PMD, dan StrictMode dalam aplikasi Anda. Cobalah dan coba fasilitas ini — Anda mungkin menemukan beberapa masalah dalam kode yang tidak pernah Anda duga.

Sementara itu, lihat beberapa kursus dan tutorial kami lainnya tentang pengembangan aplikasi Android!