Desktopowy Riffbeam jest napisany w Compose Multiplatform i działa na JVM, więc do paczki dołączamy środowisko Javy. Instalator MSI ważył 125 MB, co jak na śpiewnik jest sporo. Pod koniec października sprawdziliśmy, co zajmuje tyle miejsca i o ile da się zmniejszyć paczkę.

Co zajmuje miejsce

Katalog aplikacji z createDistributable miał 120,6 MB kodu i bibliotek oraz 65 MB środowiska Javy, już przyciętego przez jlink do potrzebnych modułów. Po spakowaniu do ZIP-a wychodziło 125,2 MB. Najwięcej ważyły:

  • material-icons-extended: 36 MB, a używamy ułamka tych ikon
  • Skiko: 13,5 MB
  • ICU: 10 MB
  • BouncyCastle: 9,8 MB

Sam pakiet ikon to prawie jedna trzecia kodu, więc najłatwiej zmniejszyć paczkę, usuwając z niego nieużywane klasy. Do tego służy ProGuard, wbudowany we wtyczkę Compose.

Cztery próby

Włączenie ProGuarda to jedna linijka w Gradle, ale przy domyślnych ustawieniach aplikacja nie uruchamiała się poprawnie.

  1. Z optymalizacją, czyli domyślnie: 73,4 MB, ale start kończył się VerifyError w okio.
  2. Z optimize = false: 76,8 MB, tym razem VerifyError w kotlinx.coroutines, bo ProGuard usunął interfejs, z którego korzysta JobSupport.
  3. Z zachowanymi w całości kotlin.** i kotlinx.**: 78,0 MB. Aplikacja rysowała pierwszy ekran, a potem padała na bibliotekach ładowanych przez ServiceLoader (cryptography-kotlin i dekoder WebP z TwelveMonkeys). ProGuard nie wie, że te klasy ktoś ładuje po nazwie z META-INF/services, więc je wycina.
  4. Z zachowanymi także bibliotekami ładowanymi przez ServiceLoader: 79,4 MB. Aplikacja uruchamia się i działa bez wyjątków.

Paczka zrobiła się mniejsza o 37%, a prawie cały zysk to wycięte ikony. Mierzyliśmy ZIP katalogu aplikacji, nie gotowy instalator.

Zaciemnianie w wydaniach

Na koniec włączyliśmy jeszcze zaciemnianie, ale tylko dla naszego kodu. Nazwy bibliotek zostają, bo wiele z nich szuka klas po nazwie (ServiceLoader, JNA, PDFBox, silniki Ktora), a ich zmiana i tak niczego nie ukrywa. Żeby stosy wywołań w zgłoszeniach błędów dało się przeczytać, ProGuard zostawia numery linii i zapisuje plik mapowania. Każde wydanie ma swój plik i z jego pomocą odtwarzamy prawdziwe nazwy klas i metod.

Od 29 października z ProGuardem budujemy wszystkie wydania Riffbeama na Windows (MSI i wersja przenośna) i macOS. Wersja na Androida od dawna przechodzi przez R8, który robi to samo dla APK.

Ustawienia

W build.gradle.kts modułu desktopowego:

compose.desktop {
    application {
        buildTypes.release.proguard {
            isEnabled.set(true)
            obfuscate.set(true)
            optimize.set(false)
            configurationFiles.from(project.file("proguard-rules.pro"))
        }
    }
}

Plik reguł w skróconej wersji. Zamiast com.example wstaw własny pakiet:

# numery linii do odczytu stosów wywołań przez retrace
-keepattributes SourceFile,LineNumberTable
-renamesourcefileattribute SourceFile
-keepattributes *Annotation*,Signature,InnerClasses,EnclosingMethod
-printmapping build/proguard/mapping.txt

-keep class com.example.MainKt { public static void main(java.lang.String[]); }
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}
-keepclassmembers @kotlinx.serialization.Serializable class ** {
    *** Companion;
    kotlinx.serialization.KSerializer serializer(...);
}
-keep,includedescriptorclasses class **$$serializer { *; }

# biblioteki zostają w całości, ProGuard tnie tylko Compose i nasz kod
-keep class !androidx.compose.**,!com.example.**,** { *; }

-dontwarn **
-ignorewarnings

Paczkę z ProGuardem budują tylko zadania z Release w nazwie, np. createReleaseDistributable albo packageReleaseMsi. Zwykłe packageMsi dalej robi pełną paczkę.

Na co uważać

  • Optymalizacja ProGuarda psuła bajtkod bibliotek, więc ją wyłączyliśmy. Zaciemnianie działa bez niej.
  • Plik mapowania trzeba zachować przy każdym wydaniu. Bez niego stos wywołań z raportu błędu to ciąg liter a.b.c.
  • -dontwarn ** i -ignorewarnings wyłączają ostrzeżenia, więc brak klasy ujawni się dopiero przy użyciu danej funkcji. Po takiej zmianie trzeba przeklikać całą aplikację, samo uruchomienie nie wystarczy.
  • Reguła, która zostawia wszystkie biblioteki, jest szeroka. Próbowaliśmy ją zawęzić, ale aplikacja nie uruchamiała się z powodu klas usuniętych z bibliotek. Zysk był niewielki, bo najwięcej miejsca oszczędzamy na usuwaniu nieużywanego kodu Compose.