Wiadomości o usłudze

Konfigurowanie i rozwiązywanie problemów z regułami zachowywania R8

Czas czytania: 7 min
Wyświetl profil użytkownika Ajesh Pai Wyświetl profil Bena Weissa
Ajesh Pai i Ben Weiss

W przypadku nowoczesnych aplikacji na Androida użytkownicy oczekują, że będą one małe, szybkie i bezpieczne. Głównym narzędziem systemu kompilacji Androida, które to umożliwia, jest optymalizator R8 – kompilator, który obsługuje usuwanie nieużywanego kodu i zasobów w celu zmniejszenia rozmiaru, zmiany nazwy kodu lub minifikacji oraz optymalizacji aplikacji.

Włączenie R8 to kluczowy krok w przygotowaniu aplikacji do wydania, ale wymaga od deweloperów podania wskazówek w postaci „reguł zachowywania”.

Po przeczytaniu tego artykułu obejrzyj film z Tygodnia wyróżnienia skuteczności na temat włączania, debugowania i rozwiązywania problemów z optymalizatorem R8 na YouTube.

 

 

Dlaczego reguły przechowywania są potrzebne

Konieczność pisania reguł zachowania wynika z podstawowego konfliktu: R8 to narzędzie do analizy statycznej, ale aplikacje na Androida często opierają się na dynamicznych wzorcach wykonywania, takich jak refleksja lub wywołania kodu natywnego za pomocą JNI (Java Native Interface).

R8 tworzy wykres używanego kodu, analizując bezpośrednie wywołania. Gdy dostęp do kodu jest uzyskiwany w sposób dynamiczny, analiza statyczna R8 nie może tego przewidzieć i identyfikuje ten kod jako nieużywany, a następnie go usuwa, co prowadzi do awarii w czasie działania.

Reguła zachowania to wyraźna instrukcja dla kompilatora R8, która brzmi: „Ta konkretna klasa, metoda lub pole to punkt wejścia, do którego dostęp będzie uzyskiwany dynamicznie w czasie działania. Musisz go zachować, nawet jeśli nie możesz znaleźć bezpośredniego odniesienia do niego”.

Więcej informacji o regułach przechowywania znajdziesz w oficjalnym przewodniku.

Gdzie pisać reguły Keep

Niestandardowe reguły przechowywania dla aplikacji są zapisywane w pliku tekstowym. Zgodnie z konwencją ten plik ma nazwę proguard-rules.pro i znajduje się w katalogu głównym modułu aplikacji lub biblioteki. Ten plik jest następnie określany w typie kompilacji release pliku build.gradle.kts modułu.

release {

    isShrinkResources = true

    isMinifyEnabled = true

    proguardFiles(

        getDefaultProguardFile("proguard-android-optimize.txt"),

        "proguard-rules.pro",

    )

}

Używanie prawidłowego pliku domyślnego

Metoda getDefaultProguardFile importuje domyślny zestaw reguł dostarczany przez pakiet Android SDK. Jeśli użyjesz nieprawidłowego pliku, aplikacja może nie być zoptymalizowana. Używaj proguard-android-optimize.txt. Ten plik zawiera domyślne reguły zachowywania dla standardowych komponentów Androida oraz umożliwia optymalizację kodu R8. Nieaktualny plik proguard-android.txt zawiera tylko reguły zachowywania, ale nie umożliwia optymalizacji R8.

progaurd.png

Ponieważ jest to poważny problem z wydajnością, zaczynamy ostrzegać deweloperów o używaniu niewłaściwego pliku, począwszy od wersji Android Studio Narwhal 3 z pakietem nowych funkcji. Od wersji 9.0 wtyczki Androida do obsługi Gradle nie będziemy już obsługiwać przestarzałego pliku proguard-android.txt. Dlatego pamiętaj, aby przejść na zoptymalizowaną wersję.

Jak pisać reguły zachowania

Reguła przechowywania składa się z 3 głównych części:

  1. Opcja taka jak -keep lub -keepclassmembers.
  2. Opcjonalne modyfikatory, takie jak allowshrinking
  3. specyfikację klasy, która definiuje kod do dopasowania;

Pełną składnię i przykłady znajdziesz we wskazówkach dotyczących dodawania reguł przechowywania.

Wzorce antywzorców reguł Keep

Warto znać nie tylko sprawdzone metody, ale też antywzorce. Te antywzorce często wynikają z nieporozumień lub skrótów w rozwiązywaniu problemów i mogą mieć katastrofalny wpływ na wydajność kompilacji produkcyjnej.

Opcje globalne

Te flagi to przełączniki globalne, których nigdy nie należy używać w kompilacji do publikacji. Służą one tylko do tymczasowego debugowania w celu wyizolowania problemu.

Użycie -dontotptimize skutecznie wyłącza optymalizacje wydajności R8, co prowadzi do wolniejszego działania aplikacji.

Gdy używasz -dontobfuscate, wyłączasz wszystkie zmiany nazw, a użycie -dontshrink wyłącza usuwanie nieużywanego kodu. Obie te reguły globalne zwiększają rozmiar aplikacji.

Aby zapewnić użytkownikom aplikacji większą wydajność, unikaj używania tych flag globalnych w środowisku produkcyjnym.

Zbyt ogólne reguły przechowywania

Najprostszym sposobem na zniwelowanie korzyści płynących z używania R8 jest pisanie zbyt ogólnych reguł zachowywania. Reguły zachowywania, takie jak ta poniżej, instruują optymalizator R8, aby nie zmniejszał, nie zaciemniał ani nie optymalizował żadnej klasy w tym pakiecie ani w żadnym z jego podpakietów. Spowoduje to całkowite usunięcie korzyści z R8 w przypadku całego pakietu. Zamiast tego spróbuj utworzyć wąskie i konkretne reguły przechowywania.
 

-keep class com.example.package.** { *;} // WIDE KEEP RULES CAUSE PROBLEMS

Operator odwrócenia (!)

Operator inwersji (!) wydaje się skutecznym sposobem na wykluczenie pakietu z reguły. To jednak nie takie proste. Oto przykład:

-keep class !com.example.my_package.** { *; } // USE WITH CAUTION

Możesz pomyśleć, że ta reguła oznacza „nie zachowuj klas w com.example.package”. W rzeczywistości oznacza ona „zachowaj każdą klasę, metodę i właściwość w całej aplikacji, która nie znajduje się w com.example.package”. Jeśli jest to dla Ciebie zaskoczeniem, sprawdź, czy w konfiguracji R8 nie ma żadnych negacji.

Zbędne reguły dotyczące komponentów Androida

Innym częstym błędem jest ręczne dodawanie reguł zachowywania dla Activities, Services lub BroadcastReceivers aplikacji. Jest to niepotrzebne. Domyślny plik proguard-android-optimize.txt zawiera już odpowiednie reguły, dzięki którym te standardowe komponenty Androida działają od razu po zainstalowaniu.

Wiele bibliotek ma też własne reguły zachowywania. Nie musisz więc pisać własnych reguł dla tych typów. Jeśli wystąpi problem z regułami Keep z używanej biblioteki, najlepiej skontaktuj się z autorem biblioteki, aby dowiedzieć się, na czym polega problem.

Sprawdzone metody dotyczące reguł Keep

Skoro już wiesz, czego nie robić, porozmawiajmy o sprawdzonych metodach.

Tworzenie wąskich reguł przechowywania

Dobre reguły przechowywania powinny być jak najbardziej precyzyjne i szczegółowe. Powinny zachowywać tylko to, co jest niezbędne, i umożliwiać R8 optymalizację pozostałych elementów.
 

Rule (Reguła)Jakość

 

-keep class com.example.** { ; }

 

Niski: zachowuje cały pakiet i jego pakiety podrzędne.

 

-keep class com.example.MyClass { ; }

 

Niska: zachowuje całą klasę, która prawdopodobnie jest nadal zbyt szeroka.
-keepclassmembers class com.example.MyClass {

    private java.lang.String secretMessage;

    public void onNativeEvent(java.lang.String);

}
Wysoki: zachowywane są tylko odpowiednie metody i właściwości z określonej klasy.

Używanie wspólnych elementów nadrzędnych

Zamiast pisać osobne reguły Keep dla wielu różnych modeli danych, napisz jedną regułę, która jest kierowana na wspólną klasę bazową lub interfejs. Poniższa reguła nakazuje R8 zachowanie wszystkich elementów klas, które implementują ten interfejs, i jest wysoce skalowalna.

# Keep all fields of any class that implements SerializableModel

-keepclassmembers class * implements com.example.models.SerializableModel {

    <fields>;

}

Używanie adnotacji do kierowania na wiele klas

Utwórz adnotację niestandardową (np. @Serialize) i użyj jej do „oznaczenia” klas, których pola mają zostać zachowane. To kolejny przejrzysty, deklaratywny i wysoce skalowalny wzorzec. Możesz też tworzyć reguły zachowywania dla istniejących adnotacji z używanych przez Ciebie platform.

# Keep all fields of any class annotated with @Serialize

-keepclassmembers class * {

    @com.example.annotations.Serialize <fields>;

}

Wybieranie odpowiedniej opcji zachowywania

Opcja zachowania jest najważniejszą częścią reguły. Wybranie niewłaściwego może niepotrzebnie wyłączyć optymalizację.

Opcja KeepJak to działa
-keepZapobiega usunięciu lub zmianie nazwy klasy i elementów wymienionych w deklaracji.
-keepclassmembersUniemożliwia usunięcie lub zmianę nazwy określonych elementów, ale pozwala na usunięcie samej klasy, ale tylko w przypadku klas, które nie zostały usunięte w inny sposób.
-keepclasseswithmembersKombinacja: zachowuje klasę i jej elementy, tylko jeśli wszystkie określone elementy są obecne.

Więcej informacji o opcji zachowania znajdziesz w dokumentacji dotyczącej opcji zachowania.

Zezwalaj na optymalizację za pomocą modyfikatorów

Modyfikatory takie jak allowshrinking i allowobfuscation rozluźniają szeroką regułę -keep, co pozwala R8 na optymalizację. Jeśli na przykład starsza biblioteka wymusza użycie reguły -keep w całej klasie, możesz odzyskać część optymalizacji, zezwalając na zmniejszanie i zaciemnianie kodu:

# Keep this class, but allow R8 to remove it if it's unused and allow R8 to rename it.

-keep,allowshrinking,allowobfuscation class com.example.LegacyClass

Dodawanie opcji globalnych na potrzeby dodatkowej optymalizacji

Oprócz reguł zachowywania możesz dodać do pliku konfiguracji R8 flagi globalne, aby jeszcze bardziej zoptymalizować działanie.

-repackageclasses to zaawansowana opcja, która instruuje R8, aby przenieść wszystkie zaciemnione klasy do jednego pakietu. Pozwala to zaoszczędzić znaczną ilość miejsca w pliku DEX dzięki usunięciu zbędnych ciągów znaków z nazwami pakietów.

-allowaccessmodification umożliwia R8 poszerzenie dostępu (np. private do public), aby umożliwić bardziej agresywne wstawianie. Ta opcja jest teraz domyślnie włączona, gdy używasz proguard-android-optimize.txt.

Ostrzeżenie: autorzy bibliotek nie mogą dodawać tych globalnych flag optymalizacji do reguł konsumentów, ponieważ zostałyby one wymuszone w całej aplikacji.

Aby jeszcze bardziej uprościć ten proces, we wtyczce Androida do obsługi Gradle w wersji 9.0 zaczniemy całkowicie ignorować globalne flagi optymalizacji z bibliotek. 

Sprawdzone metody dotyczące bibliotek

Każda aplikacja na Androida w ten czy inny sposób korzysta z bibliotek. Omówmy sprawdzone metody dotyczące bibliotek.

Dla deweloperów bibliotek

Jeśli Twoja biblioteka używa refleksji lub JNI, musisz udostępnić jej użytkownikom niezbędne reguły zachowania. Te reguły są umieszczane w pliku consumer-rules.pro, który jest następnie automatycznie dołączany do pliku AAR biblioteki.

android {

    defaultConfig {

        consumerProguardFiles("consumer-rules.pro")

    }

    ...

}

Użytkownicy biblioteki

Odfiltrowywanie problematycznych reguł przechowywania

Jeśli musisz użyć biblioteki, która zawiera problematyczne reguły Keep, możesz je odfiltrować w pliku build.gradle.kts, zaczynając od AGP 9.0. Dzięki temu R8 będzie ignorować reguły pochodzące z określonej zależności.

release {

    optimization.keepRules {

        // Ignore all consumer rules from this specific library

        it.ignoreFrom("com.somelibrary:somelibrary")

    }

}

Najlepsza reguła przechowywania to brak reguły przechowywania

Najlepszą strategią konfiguracji R8 jest wyeliminowanie konieczności pisania reguł zachowywania. W przypadku wielu aplikacji można to osiągnąć, wybierając nowoczesne biblioteki, które preferują generowanie kodu zamiast refleksji. Dzięki generowaniu kodu optymalizator może łatwiej określić, który kod jest faktycznie używany w czasie działania, a który można usunąć. Brak dynamicznej refleksji oznacza też brak „ukrytych” punktów wejścia, więc nie są potrzebne żadne reguły zachowywania. Wybierając nową bibliotekę, zawsze preferuj rozwiązanie, które wykorzystuje generowanie kodu, a nie refleksję.

Więcej informacji o wybieraniu bibliotek znajdziesz w artykule Wybieranie biblioteki.

Debugowanie i rozwiązywanie problemów z konfiguracją R8

Jeśli R8 usunie kod, który powinien zostać zachowany, lub plik APK jest większy niż oczekiwano, użyj tych narzędzi, aby zdiagnozować problem.

Znajdowanie zduplikowanych i globalnych reguł przechowywania

R8 scala reguły z dziesiątek źródeł, więc trudno jest określić, jaki jest „ostateczny” zestaw reguł. Dodanie tej flagi do pliku proguard-rules.pro powoduje wygenerowanie pełnego raportu:

# Outputs the final, merged set of rules to the specified file

-printconfiguration build/outputs/logs/configuration.txt

Możesz przeszukać ten plik, aby znaleźć zbędne reguły lub prześledzić problematyczną regułę (np. -dontoptimize) i znaleźć konkretną bibliotekę, która ją zawiera.

Zapytaj R8: Dlaczego to zachowujesz?

Jeśli klasa, która miała zostać usunięta, nadal znajduje się w aplikacji, R8 może podać przyczynę. Wystarczy dodać tę regułę:

# Asks R8 to explain why it's keeping a specific class

class com.example.MyUnusedClass

-whyareyoukeeping 

Podczas kompilacji R8 wyświetli dokładny łańcuch odwołań, który spowodował zachowanie tej klasy, co pozwoli Ci prześledzić odwołanie i dostosować reguły.

Pełny przewodnik znajdziesz w sekcji Rozwiązywanie problemów z R8.

Dalsze kroki

R8 to zaawansowane narzędzie do zwiększania wydajności aplikacji na Androida. Skuteczność tego narzędzia zależy od prawidłowego zrozumienia jego działania jako silnika analizy statycznej.

Pisząc konkretne reguły na poziomie użytkownika, wykorzystując elementy nadrzędne i adnotacje oraz starannie wybierając odpowiednie opcje przechowywania, możesz zachować dokładnie to, co jest konieczne. Najbardziej zaawansowaną metodą jest całkowite wyeliminowanie potrzeby stosowania reguł przez wybór nowoczesnych bibliotek opartych na generowaniu kodu zamiast ich poprzedników opartych na refleksji.

Podczas Tygodnia wyróżnień za skuteczność obejrzyj dzisiejszy film na YouTube i kontynuuj wyzwanie R8. Jeśli masz pytania dotyczące włączania lub rozwiązywania problemów z R8, użyj tagu #optimizationEnabled. Chętnie Ci pomożemy.

Czas przekonać się o korzyściach.

Zachęcamy do włączenia trybu pełnego R8 w aplikacji już dziś.

  1. Aby rozpocząć, skorzystaj z naszych przewodników dla programistów: Włączanie optymalizacji aplikacji.
  2. Sprawdź, czy nadal używasz proguard-android.txt, i zastąp go proguard-android-optimize.txt.
  3. Następnie zmierz wpływ. Nie tylko poczuj różnicę, ale też ją sprawdź. Aby zmierzyć wzrost wydajności, dostosuj kod z naszej przykładowej aplikacji Macrobenchmark na GitHubie i zmierz czas uruchamiania przed wprowadzeniem zmian i po ich wprowadzeniu.

Jesteśmy przekonani, że zauważysz znaczną poprawę skuteczności aplikacji.

Przy okazji użyj tagu #AskAndroid, aby zadać pytania. Przez cały tydzień nasi eksperci będą monitorować pytania i na nie odpowiadać.

Jutro omówimy optymalizację na podstawie profilu z profilami podstawowymi i profilami uruchamiania, opowiemy o poprawie wydajności renderowania w Compose w ostatnich wersjach i przedstawimy kwestie związane z wydajnością pracy w tle.

Autor:
Czytaj dalej