Memilih library dengan bijak

Untuk mengaktifkan pengoptimalan aplikasi, Anda harus menggunakan library yang kompatibel dengan pengoptimalan Android. Jika library tidak dikonfigurasi untuk pengoptimalan Android—misalnya, jika library menggunakan refleksi tanpa memaketkan aturan keep terkait—library tersebut mungkin tidak cocok untuk aplikasi Android. Halaman ini menjelaskan alasan beberapa library lebih cocok untuk pengoptimalan aplikasi dan memberikan tips umum untuk membantu Anda memilih.

Tips umum saat memilih library

Gunakan tips ini untuk membantu memastikan bahwa library Anda kompatibel dengan pengoptimalan aplikasi.

Lebih memilih codegen daripada refleksi

Pilih library yang menggunakan pembuatan kode (codegen), bukan refleksi. Dengan codegen, pengoptimal dapat menentukan kode apa yang benar-benar digunakan saat runtime dan kode apa yang dapat dihapus. Mungkin sulit untuk mengetahui apakah library menggunakan codegen atau refleksi, tetapi ada beberapa tanda—lihat tips untuk mendapatkan bantuan.

Untuk mengetahui informasi selengkapnya tentang codegen versus refleksi, lihat Pengoptimalan untuk penulis library.

Memeriksa penggunaan refleksi (lanjutan)

Anda dapat mengetahui apakah library menggunakan refleksi dengan memeriksa kodenya. Jika library menggunakan refleksi, pastikan library tersebut menyediakan aturan keep terkait. Library kemungkinan menggunakan refleksi jika melakukan hal berikut:

  • Menggunakan class atau metode dari paket kotlin.reflect atau java.lang.reflect.
  • Menggunakan fungsi Class.forName atau classLoader.getClass.
  • Membaca anotasi saat runtime, misalnya jika menyimpan nilai anotasi menggunakan val value = myClass.getAnnotation() atau val value = myMethod.getAnnotation(), lalu melakukan sesuatu dengan value.
  • Memanggil metode menggunakan nama metode sebagai string, seperti dalam contoh berikut:

    // Calls the private `processData` API with reflection
    myObject.javaClass.getMethod("processData", DataType::class.java)
    ?.invoke(myObject, data)
    

Memeriksa masalah pengoptimalan

Saat mempertimbangkan library baru, lihat issue tracker dan diskusi online library untuk memeriksa apakah ada masalah terkait minifikasi atau konfigurasi pengoptimalan aplikasi. Jika ada, Anda harus mencoba mencari alternatif untuk library tersebut. Perhatikan hal berikut:

  • Library AndroidX dan library seperti Hilt berfungsi dengan baik dalam pengoptimalan aplikasi karena sebagian besar menggunakan codegen, bukan refleksi. Saat menggunakan refleksi, library tersebut memberikan aturan keep minimal untuk hanya mempertahankan kode yang diperlukan.
  • Library serialisasi sering menggunakan refleksi untuk menghindari kode boilerplate saat membuat instance atau melakukan serialisasi objek. Alih-alih pendekatan berbasis refleksi (seperti Gson untuk JSON), cari library yang menggunakan codegen untuk menghindari masalah ini, misalnya dengan menggunakan Kotlin Serialization atau Moshi dengan codegen.
  • Jika memungkinkan, hindari library yang menyertakan aturan keep di seluruh paket. Aturan keep di seluruh paket dapat membantu menyelesaikan error, tetapi aturan keep yang luas pada akhirnya harus disaring untuk hanya mempertahankan kode yang diperlukan. Untuk mengetahui informasi selengkapnya, lihat Menerapkan pengoptimalan secara bertahap.
  • Sebelum memublikasikan aplikasi yang menggunakan library pihak ketiga, gunakan R8 Configuration Analyzer untuk mengaudit aturan keep yang disediakan. Dengan meninjau laporan, Anda dapat memverifikasi apakah aturan keep library terlalu luas, sehingga mencegah R8 melakukan pengoptimalan penting pada codebase Anda. Pemeriksaan ini memastikan bahwa library yang Anda pilih sesuai dengan sasaran performa aplikasi dan tidak menimbulkan bloatware konfigurasi yang tidak perlu.
  • Library tidak mengharuskan Anda menyalin dan menempelkan aturan keep dari dokumentasi ke dalam file di project Anda, terutama aturan keep di seluruh paket. Aturan ini menjadi beban pemeliharaan bagi developer aplikasi dalam jangka panjang, serta sulit dioptimalkan dan diubah seiring waktu.

Mengaktifkan pengoptimalan setelah menambahkan library baru

Saat Anda menambahkan library baru, aktifkan pengoptimalan setelahnya dan periksa apakah ada error. Jika terjadi error, cari alternatif untuk library tersebut atau tulis aturan keep. Jika library tidak kompatibel dengan pengoptimalan, laporkan bug ke library tersebut.

Memfilter aturan keep yang buruk (lanjutan)

Aturan simpan bersifat kumulatif. Artinya, aturan tertentu yang disertakan oleh dependensi library tidak dapat dihapus dan mungkin memengaruhi kompilasi bagian lain dari aplikasi Anda. Misalnya, jika library menyertakan aturan untuk menonaktifkan pengoptimalan kode, aturan tersebut akan menonaktifkan pengoptimalan untuk seluruh project Anda.

Sebaiknya hindari library dengan aturan keep yang mempertahankan kode yang seharusnya dihapus. Namun, jika Anda harus menggunakannya, Anda dapat memfilter aturan tersebut seperti yang ditunjukkan dalam kode berikut:

// If you're using AGP 8.4 and higher
buildTypes {
    release {
        optimization.keepRules {
          it.ignoreFrom("com.somelibrary:somelibrary")
        }
    }
}

// If you're using AGP 7.3-8.3
buildTypes {
    release {
        optimization.keepRules {
          it.ignoreExternalDependencies("com.somelibrary:somelibrary")
        }
    }
}

Alur kerja yang direkomendasikan untuk aturan library yang luas

Jika R8 Configuration Analyzer menunjukkan bahwa library menggabungkan aturan keep yang terlalu luas, filter aturan tersebut hanya dalam build lokal, bukan dalam build produksi. Untuk menguji seberapa besar pengaruh aturan terhadap aplikasi Anda, ikuti langkah-langkah berikut:

  1. Update library: Pastikan Anda menggunakan versi terbaru library yang ditandai oleh R8 Configuration Analyzer, karena versi yang lebih baru mungkin mengirimkan aturan keep konsumen yang lebih sempit. Untuk menemukan versi terbaru, periksa dokumentasi library atau repositori Maven-nya. Android Studio juga menandai versi yang lebih baru dari banyak dependensi. Setelah mengupdate, jalankan kembali Penganalisis Konfigurasi R8 untuk memeriksa apakah aturan keep yang luas masih ada.
  2. Periksa potensi peningkatan secara lokal: Salin aturan konsumen yang dipaketkan library ke dalam file aturan keep lokal, filter aturan yang dipaketkan seperti yang ditunjukkan dalam Memfilter aturan keep yang buruk, dan persempit aturan yang disalin. Jalankan R8 Configuration Analyzer sebelum dan setelah mempersempit aturan untuk membandingkan skor penyingkatan, pengoptimalan, dan obfuscation aplikasi Anda.
  3. Laporkan temuan: Laporkan bug kepada pengelola library yang berisi data empiris dari laporan R8 Configuration Analyzer Anda (misalnya, menunjukkan jumlah spesifik class atau metode yang tidak direferensikan yang dipertahankan oleh aturan karakter pengganti).

Studi kasus: Alasan Gson rusak dengan pengoptimalan

Gson adalah library serialisasi yang sering menyebabkan masalah pada pengoptimalan aplikasi karena sangat mengandalkan refleksi. Cuplikan kode berikut menunjukkan cara Gson biasanya digunakan, yang dapat menyebabkan error saat runtime. Perhatikan bahwa saat Anda menggunakan Gson untuk mendapatkan daftar objek Pengguna, Anda tidak memanggil konstruktor atau meneruskan factory ke fungsi fromJson(). Membuat atau menggunakan class yang ditentukan aplikasi tanpa salah satu hal berikut adalah tanda bahwa library mungkin menggunakan refleksi terbuka:

  • Class aplikasi yang mengimplementasikan library, atau antarmuka atau class standar
  • Plugin pembuatan kode seperti KSP
class User(val name: String)
class UserList(val users: List<User>)

// This code runs in debug mode, but crashes when optimizations are enabled
Gson().fromJson("""[{"name":"myname"}]""", User::class.java).toString()

Untuk memahami cara kerja R8 di Gson, lihat Aturan konsumen Gson. Saat R8 menganalisis kode ini dan tidak melihat UserList atau User dibuat instance-nya di mana pun, R8 dapat mengganti nama kolom, atau menghapus konstruktor yang tampaknya tidak digunakan, sehingga menyebabkan aplikasi Anda error. Jika Anda menggunakan library lain dengan cara yang sama, Anda harus memeriksa apakah library tersebut tidak akan mengganggu pengoptimalan aplikasi, dan jika ya, hindari library tersebut.

Menggunakan @SerializedName dengan versi Gson yang lebih baru

Untuk menentukan model data Anda dengan cara yang kompatibel dengan aturan konsumen Gson, anotasikan kolom Anda dengan @SerializedName, seperti yang ditunjukkan dalam cuplikan berikut:

import com.google.gson.annotations.SerializedName

class User(@SerializedName("name") val name: String)
class UserList(@SerializedName("users") val users: List<User>)

Dengan menggunakan anotasi @SerializedName, Anda mengizinkan R8 mencocokkan class model Anda dengan aturan keep yang dipaketkan dalam Gson versi 2.11.0 dan yang lebih tinggi. R8 otomatis mempertahankan kolom yang dianotasi dan konstruktor yang diperlukan, sehingga Anda dapat mengandalkan aturan yang dipaketkan library tanpa harus mengelola konfigurasi ProGuard manual dalam project Anda.

Perhatikan bahwa Room, Hilt, dan Moshi dengan codegen membuat jenis yang ditentukan aplikasi, tetapi menggunakan codegen untuk menghindari kebutuhan akan refleksi.