Mengirimkan aturan keep yang lebih cerdas: Cara penyedia library dapat mengaktifkan pengoptimalan kode DEX tingkat aplikasi
Waktu baca: 6 menit
Sebagai developer aplikasi dan library Android, kita semua berupaya mencapai tujuan yang sama: aplikasi berperforma tinggi yang memberikan pengalaman pengguna yang lancar. Sebagian besar proses ini melibatkan R8, pengoptimal aplikasi Android. R8 meningkatkan performa aplikasi dengan menghapus kode yang tidak digunakan, serta mengoptimalkan dan meng-obfuscate kode lainnya.
Google Play baru-baru ini mengumumkan nilai minimum pengoptimalan kode DEX baru untuk aplikasi dan game, yang membantu meningkatkan waktu sistem dimulai, mengurangi jejak memori, dan selaras dengan komitmen Android untuk melindungi pengalaman pengguna dari aplikasi yang menggunakan memori berlebih. Meskipun nilai minimum ini berlaku untuk aplikasi dan game, memenuhinya adalah tanggung jawab bersama di seluruh ekosistem—R8 hanya dapat mengoptimalkan aplikasi dalam parameter yang diberikan, yang mencakup aturan keep yang dipaketkan oleh library yang diandalkan aplikasi.
R8 Configuration Analyzer adalah alat yang sangat bagus untuk menilai persentase pengoptimalan, penyingkatan, dan obfuscation aplikasi, yang merupakan inti dari persyaratan teknis Google Play. Selain melacak persentase ini, R8 Configuration Analyzer juga menampilkan aturan keep yang tidak efisien yang berasal dari aplikasi, serta aturan keep konsumen yang dipaketkan dalam library yang diandalkan aplikasi.
Panduan ini menguraikan cara menyelesaikan beberapa tantangan paling umum yang dihadapi penyedia library, dan mengirimkan aturan yang sempit dan berperforma tinggi untuk membantu pelanggan Anda memenuhi persyaratan teknis Google Play.
Apa yang dimaksud dengan aturan penyimpanan konsumen?
Aturan keep konsumen adalah petunjuk yang dipaketkan dalam library Android atau JAR yang memberi tahu R8 bagian kode library mana yang tidak boleh dioptimalkan selama proses kompilasi tingkat aplikasi. Tidak seperti aturan keep standar yang ditulis oleh aplikasi atau library yang digunakan dalam minifikasi artefaknya, aturan keep konsumen disematkan di dalam library, dan memengaruhi cara library diminifikasi selama pengoptimalan seluruh aplikasi–memastikan bahwa target refleksi internal dan antarmuka native tetap utuh tanpa perlu diidentifikasi secara manual oleh developer aplikasi.
Aturan keep konsumen yang disengaja dan cakupannya sempit adalah praktik terbaik penting yang bermanfaat bagi library dan aplikasi yang menggunakannya. Aturan keep konsumen yang terlalu luas akan mempertahankan kode yang tidak digunakan dan akibatnya, memengaruhi pengoptimalan dan performa aplikasi. Dengan pengoptimalan kode DEX yang ditambahkan ke Konsol Play, metrik yang akan dilihat developer aplikasi mewakili dampak gabungan dari aturan dari aplikasi dan library terintegrasinya.
Menyeimbangkan stabilitas dan performa
Penyedia library sering kali memiliki niat baik dalam mengirimkan aturan keep konsumen yang luas. Tidak ada yang ingin SDK-nya memicu error karena penghapusan class selama refleksi.
Namun, aturan keep yang luas atau mencakup seluruh paket tidak direkomendasikan sebagai solusi jangka panjang untuk mencegah error, karena aturan tersebut sangat membatasi potensi pengoptimalan aplikasi seluruh program R8. Berikut beberapa strategi yang direkomendasikan untuk membantu Anda mengirimkan aturan yang sempit dan berperforma tinggi tanpa mengorbankan stabilitas:
1. Menguji dan meluncurkan aturan yang sempit
Untuk membantu Anda merilis aturan yang sempit dengan yakin, pertimbangkan praktik terbaik berikut:
- Menguji di aplikasi contoh: Panduan pengujian lokal di Menguji pengoptimalan juga berlaku untuk aplikasi contoh. Setelah mengaktifkan R8, uji perjalanan penting pengguna untuk memastikan fungsi berjalan seperti yang diharapkan.
- Jalankan R8 Configuration Analyzer di aplikasi contoh Anda untuk melihat apa yang dilihat developer aplikasi saat mengaudit konfigurasi R8 mereka. Dengan demikian, Anda dapat dengan mudah memvisualisasikan dampak aturan keep pada aplikasi downstream.
- Gunakan perintah analisis dari Android CLI untuk menilai pengoptimalan AAR atau JAR Anda, termasuk metode, class, dan kolom yang dipertahankan. Anda dapat membandingkan angka-angka ini di seluruh rilis untuk memantau regresi.
- Memantau penggunaan versi library dan error di Konsol Google Play SDK.
- Lihat panduan Pengoptimalan untuk penulis library, dan dokumentasi R8 untuk mengetahui praktik terbaik.
2. Mempertahankan target refleksi dan JNI tanpa aturan keep yang luas
Mengirimkan library dengan aturan keep yang luas atau di seluruh paket tidak hanya memengaruhi SDK Anda, tetapi juga memaksa developer untuk menerima kode yang membengkak sehingga memperlambat waktu mulai aplikasi dan meningkatkan ukuran download aplikasi, penggunaan memori, dan rasio ANR. Mungkin juga aplikasi yang berorientasi pada performa akan menulis aturan kustom yang menggantikan aturan yang dipaketkan dengan library Anda, yang juga mencegah aplikasi ini mengadopsi update library mendatang untuk mengurangi risiko.
Jika SDK Anda menargetkan kode native, seperti yang ada dalam game atau editor foto dan video, berikan aturan untuk semua class yang menggunakan JNI. Sebagian besar game berjalan di atas game engine seperti Unity dan Unreal, yang mengompilasi game ke kode native. Kode native game dan plugin Anda berkomunikasi dengan framework Android melalui panggilan JNI.
Anotasi Keep Jetpack, yang kini dalam versi alfa, dapat membantu mengurangi pemeliharaan yang diperlukan oleh refleksi, dengan memungkinkan Anda menganotasi penggunaan refleksi, yang kemudian dapat digunakan untuk membuat aturan keep pada waktu build.
Pertimbangkan codegen daripada refleksi
Untuk menghindari error akibat refleksi, tips terbesar kami adalah menghindari refleksi dan menggunakan codegen jika memungkinkan.
Refleksi runtime menyembunyikan penggunaan kode dari R8 selama kompilasi, yang memerlukan aturan keep untuk menghindari error. Jika Anda menggunakan codegen, kode akan dioptimalkan selama proses build, sehingga R8 memiliki visibilitas yang diperlukan untuk mengoptimalkan kode dengan aman menggunakan aturan keep minimal. Skenario umum saat codegen menjadi pilihan yang tepat mencakup serialisasi dan deserialisasi, serta injeksi dependensi (Hilt adalah contoh library yang menggunakan codegen).
Namun, codegen bukanlah pilihan yang tepat untuk setiap skenario. Untuk pola seperti dependensi opsional, refleksi masih diperlukan. Sebaiknya pasangkan refleksi dengan aturan keep yang sempit yang hanya melindungi titik entri yang diperlukan, seperti yang dijelaskan dalam panduan tentang Refleksi untuk mendukung dependensi opsional.
Cakupan aturan yang sempit, bahkan untuk build library yang telah dioptimalkan sebelumnya
Jika tidak memungkinkan untuk menghindari refleksi, pastikan aturan keep konsumen Anda hanya menentukan apa yang direfleksikan oleh library Anda. Saat library Anda mengakses class atau metode secara dinamis, Anda hanya perlu menentukan titik entri, dan R8 akan menangani sisanya. R8 menggunakan titik entri untuk membuat grafik kode yang direferensikan dan menghapus class, metode, dan kolom yang tidak direferensikan.
Hal ini juga berlaku jika Anda telah mengoptimalkan atau meng-obfuscate build library, yang merupakan praktik terbaik untuk memastikan SDK berperforma tinggi dan ringan. Karena aturan Anda berlaku selama langkah kompilasi aplikasi, R8 masih dapat mengoptimalkan library Anda lebih lanjut berdasarkan class dan metode sebenarnya yang digunakan oleh aplikasi downstream. Perintah analisis Android CLI secara proaktif menampilkan aturan keep di seluruh paket yang digunakan dan tidak digunakan yang berkontribusi pada pengoptimalan yang diblokir.
Membatasi cakupan aturan keep untuk dependensi pihak ketiga
Berikut adalah pola umum yang kami lihat:
-keep public class com.google.android.gms.** { *; }Jika aplikasi yang mengintegrasikan SDK Anda juga menggunakan library GMS lain, dan menyertakan aturan keep untuk membatasi jumlah kode yang disimpan, aturan yang luas ini akan menggantikannya, sehingga menyebabkan bloatware aplikasi yang tidak perlu.
Saat memanggil library eksternal, Anda harus mendesain aturan keep yang hanya mempertahankan elemen tertentu yang diakses library Anda melalui refleksi. Selain itu, kenyataannya, banyak library (termasuk GMS) sudah mengirimkan aturan keep konsumennya sendiri–memperkenalkan aturan keep di seluruh paket juga dapat mencakup aturan konsumen yang ditulis dengan cermat dan cakupannya sempit dari library downstream.
Pertimbangkan aturan keep bersyarat untuk adaptor mediasi iklan
Jika library iklan Anda dimuat menggunakan adaptor mediasi, aturan keep yang sempit masih dapat digunakan. Dalam skenario ini, sebaiknya gunakan aturan keep bersyarat untuk hanya mempertahankan fitur atau format tertentu jika aplikasi menyertakan adaptor yang sesuai. Hal ini memastikan bahwa R8 masih dapat menyingkat fitur yang tidak digunakan aplikasi. Sebagai opsi lain, daripada menulis aturan yang kompleks secara manual, Anda juga dapat menggunakan anotasi Jetpack Keep untuk menganotasi panggilan reflektif secara langsung dalam kode sumber dan otomatis membuat aturan keep konsumen bersyarat, termasuk untuk modul add-on opsional.
Kirim aturan dalam aturan konsumen, bukan dokumentasi
Dengan mengirimkan aturan konsumen bersama library, Anda memastikan bahwa aplikasi dengan build yang mendukung R8 dapat langsung menggunakan library Anda dan mendapatkan pengoptimalan maksimal.
Menentukan aturan dalam dokumentasi akan menambah hambatan penyiapan manual (terutama karena aturan keep konsumen yang dipaketkan telah didukung di AAR dan JAR selama bertahun-tahun) dan menimbulkan overhead pemeliharaan yang berkelanjutan. Saat mengupdate library (termasuk melakukan refaktorisasi, mengganti nama class, dan mengubah cara penggunaan refleksi), Anda harus ingat untuk mengupdate dokumentasi, dan aplikasi harus ingat untuk memeriksa aturan baru. Seiring waktu, saat aplikasi diupgrade melalui beberapa versi library Anda, aplikasi tersebut dapat mengakumulasi aturan keep lama yang tidak lagi diperlukan, sehingga menyebabkan bloatware aplikasi yang tidak perlu.
3. Membaca stack trace rilis
Anda mungkin mengalami stack trace yang tidak dapat dibaca karena kode yang di-obfuscate. Untuk membuka pemblokiran analisis penting, Anda mungkin tergoda untuk menggunakan keepnames, yang memungkinkan penyingkatan, tetapi mencegah pengoptimalan tambahan seperti penggantian nama di aplikasi yang menggunakan–nilai tepat yang Anda butuhkan saat men-debug pelacakan tumpukan.
Anda tidak perlu mencegah pengoptimalan tambahan untuk mendapatkan stack trace yang dapat dibaca.
Firebase Crashlytics, Konsol Play, dan Logcat di Android Studio men-deobfuscate stack trace untuk developer aplikasi. Artinya, jika developer aplikasi membagikan stack trace kepada Anda, Anda tidak perlu mencegah obfuscation untuk dapat membacanya.
Jika Anda mengupload file pemetaan ke SDK Console, Anda akan dapat melihat stack trace yang di-deobfuscate di SDK Console.
Menghilangkan spekulasi terkait pengoptimalan
Mengoptimalkan koleksi Anda seharusnya tidak terasa seperti permainan coba-coba.
Dengan mempertahankan aturan keep konsumen, penyedia library dapat memastikan bahwa aplikasi di seluruh ekosistem tidak diblokir dari pengoptimalan.
Jika library mengirimkan aturan yang lebih baik, aplikasi akan menjadi lebih kecil dan lebih cepat. Mulai audit aturan keep konsumen Anda sekarang untuk membantu aplikasi yang bergantung pada library Anda berperforma optimal.
-
PetunjukKami membahas Pengoptimalan yang Dipandu Profil, peningkatan performa Jetpack Compose, dan pertimbangan dalam bekerja di balik layar.
Ben Weiss, Breana Tate, Jossi Wolf • Waktu baca: 8 menit -
PetunjukSelamat datang kembali di rangkaian postingan blog "Membangun aplikasi Android yang cerdas". Di sini, Anda akan mengubah aplikasi Android dasar menjadi pengalaman yang dipersonalisasi, cerdas, dan agentic. Dalam postingan sebelumnya, Anda telah mempelajari cara terhubung ke sistem kecerdasan menggunakan AppFunctions.
Jolanda Verhoef • Waktu baca: 9 menit -
PetunjukMedia3 1.11 telah dirilis. Sebagai pendukung sebagian besar aplikasi media Android teratas, rilis ini menghadirkan fitur baru, perbaikan bug, dan peningkatan di seluruh komponen pemutaran, pengeditan, dan UI.
Toni Heidenreich • Waktu baca: 3 menit
Dapatkan insight pengembangan Android terbaru yang dikirim ke kotak masuk Anda setiap minggu.