Wybieranie bibliotek

Aby włączyć optymalizację aplikacji, musisz używać bibliotek zgodnych z optymalizacją na Androidzie. Jeśli biblioteka nie jest skonfigurowana pod kątem optymalizacji na Androidzie – na przykład jeśli używa refleksji bez powiązanych reguł zachowywania – może nie być odpowiednia dla aplikacji na Androida. Na tej stronie wyjaśniamy, dlaczego niektóre biblioteki lepiej nadają się do optymalizacji aplikacji, i podajemy ogólne wskazówki, które pomogą Ci dokonać wyboru.

Ogólne wskazówki dotyczące wyboru bibliotek

Skorzystaj z tych wskazówek, aby upewnić się, że Twoje biblioteki są zgodne z optymalizacją aplikacji.

Preferuj generowanie kodu zamiast refleksji

Wybierz biblioteki, które używają generowania kodu (codegen) zamiast refleksji. Dzięki generowaniu kodu optymalizator może określić, który kod jest faktycznie używany w czasie działania, a który można usunąć. Może być trudno określić, czy biblioteka używa generowania kodu czy refleksji, ale są pewne wskazówki – zapoznaj się z poradami.

Więcej informacji o generowaniu kodu i refleksji znajdziesz w artykule Optymalizacja dla autorów bibliotek.

Sprawdzanie użycia refleksji (zaawansowane)

Możesz sprawdzić, czy biblioteka używa refleksji, analizując jej kod. Jeśli biblioteka używa refleksji, sprawdź, czy zawiera powiązane reguły zachowywania. Biblioteka prawdopodobnie używa refleksji, jeśli:

  • używa klas lub metod z pakietów kotlin.reflect lub java.lang.reflect;
  • Używa funkcji Class.forName lub classLoader.getClass.
  • odczytuje adnotacje w czasie działania, np. jeśli przechowuje wartość adnotacji za pomocą val value = myClass.getAnnotation() lub val value = myMethod.getAnnotation(), a następnie wykonuje jakąś czynność za pomocą value.
  • Wywołuje metody, używając nazwy metody jako ciągu znaków, jak w tym przykładzie:

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

Sprawdzanie, czy występują problemy z optymalizacją

Zanim zdecydujesz się na nową bibliotekę, przejrzyj jej narzędzie Issue Tracker i dyskusje online, aby sprawdzić, czy nie występują problemy związane z minifikacją lub konfigurowaniem optymalizacji aplikacji. Jeśli tak, poszukaj alternatyw dla tej biblioteki. Pamiętaj o tych kwestiach:

  • Biblioteki AndroidX i biblioteki takie jak Hilt dobrze współpracują z optymalizacją aplikacji, ponieważ używają głównie generowania kodu zamiast refleksji. Jeśli używają refleksji, udostępniają minimalne reguły zachowywania, aby zachować tylko potrzebny kod.
  • Biblioteki serializacji często używają refleksji, aby uniknąć powtarzalnego kodu podczas tworzenia instancji lub serializacji obiektów. Zamiast podejść opartych na refleksji (takich jak Gson w przypadku JSON) poszukaj bibliotek, które używają generowania kodu, aby uniknąć tych problemów, np. Kotlin Serialization lub Moshi z generowaniem kodu.
  • Jeśli to możliwe, unikaj bibliotek, które zawierają reguły zachowywania dotyczące całego pakietu. Reguły zachowywania na poziomie pakietu mogą pomóc w rozwiązywaniu błędów, ale ogólne reguły zachowywania powinny być ostatecznie doprecyzowane, aby zachować tylko potrzebny kod. Więcej informacji znajdziesz w artykule Stopniowe wdrażanie optymalizacji.
  • Przed opublikowaniem aplikacji, która korzysta z biblioteki zewnętrznej, użyj analizatora konfiguracji R8, aby sprawdzić reguły zachowywania. Przeglądając raport, możesz sprawdzić, czy reguły zachowywania biblioteki nie są zbyt szerokie i nie uniemożliwiają R8 przeprowadzania krytycznych optymalizacji bazy kodu. Dzięki temu wybrane biblioteki będą zgodne z celami skuteczności aplikacji i nie będą powodować niepotrzebnego obciążenia konfiguracji.
  • Biblioteki nie powinny wymagać kopiowania i wklejania reguł zachowywania z dokumentacji do pliku w projekcie, zwłaszcza reguł zachowywania dotyczących całego pakietu. W dłuższej perspektywie te reguły stają się dla dewelopera aplikacji obciążeniem związanym z konserwacją, a z czasem trudno je optymalizować i zmieniać.

Włączanie optymalizacji po dodaniu nowej biblioteki

Po dodaniu nowej biblioteki włącz optymalizację i sprawdź, czy nie występują błędy. Jeśli wystąpią błędy, poszukaj alternatyw dla tej biblioteki lub napisz reguły zachowywania. Jeśli biblioteka nie jest zgodna z optymalizacją, zgłoś błąd w tej bibliotece.

Odfiltrowywanie nieprawidłowych reguł zachowywania (zaawansowane)

Reguły przechowywania się sumują. Oznacza to, że niektórych reguł, które zawiera zależność biblioteki, nie można usunąć i mogą one wpływać na kompilację innych części aplikacji. Jeśli na przykład biblioteka zawiera regułę wyłączającą optymalizację kodu, ta reguła wyłącza optymalizację w całym projekcie.

Unikaj bibliotek z regułami zachowywania, które zachowują kod, który powinien zostać usunięty. Jeśli jednak musisz ich użyć, możesz odfiltrować reguły, jak pokazano w tym kodzie:

// 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")
        }
    }
}

Zalecany przepływ pracy w przypadku reguł dotyczących całej biblioteki

Jeśli analizator konfiguracji R8 wykaże, że biblioteka zawiera zbyt ogólne reguły zachowywania, odfiltruj je tylko w kompilacjach lokalnych, a nie w kompilacjach produkcyjnych. Aby sprawdzić, jak bardzo reguły wpływają na aplikację, wykonaj te czynności:

  1. Zaktualizuj bibliotekę: upewnij się, że używasz najnowszej wersji biblioteki oznaczonej przez analizator konfiguracji R8, ponieważ nowsze wersje mogą zawierać bardziej rygorystyczne reguły zachowywania (keep rules) dla klientów. Aby znaleźć najnowszą wersję, sprawdź dokumentację biblioteki lub jej repozytorium Maven. Android Studio oznacza też nowsze wersje wielu zależności. Po aktualizacji ponownie uruchom analizator konfiguracji R8, aby sprawdzić, czy ogólne reguły zachowywania nadal obowiązują.
  2. Sprawdź potencjalną poprawę lokalnie: skopiuj reguły konsumenta dołączone do biblioteki do lokalnego pliku reguł zachowywania, odfiltruj dołączone reguły, jak pokazano w sekcji Odfiltrowywanie nieprawidłowych reguł zachowywania, i zawęź skopiowane reguły. Uruchom analizator konfiguracji R8 przed zawężeniem reguł i po nim, aby porównać wyniki zmniejszania, optymalizacji i zaciemniania kodu aplikacji.
  3. Zgłoś wyniki: prześlij zgłoszenie błędu do osoby zarządzającej biblioteką, zawierające dane empiryczne z raportu Analizatora konfiguracji R8 (np. pokazujące konkretną liczbę nieużywanych klas lub metod zachowanych przez regułę wieloznaczną).

Studium przypadku: dlaczego Gson nie działa z optymalizacjami

Gson to biblioteka serializacji, która często powoduje problemy z optymalizacją aplikacji, ponieważ intensywnie korzysta z refleksji. Poniższy fragment kodu pokazuje, jak zwykle używana jest biblioteka Gson, co może powodować awarie w czasie działania. Zauważ, że gdy używasz Gson do pobrania listy obiektów User, nie wywołujesz konstruktora ani nie przekazujesz fabryki do funkcji fromJson(). Tworzenie lub używanie klas zdefiniowanych przez aplikację bez żadnego z tych elementów wskazuje, że biblioteka może używać otwartej refleksji:

  • Klasa aplikacji implementująca bibliotekę, standardowy interfejs lub klasę
  • wtyczka do generowania kodu, np. 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()

Aby dowiedzieć się, jak R8 działa w Gson, zapoznaj się z regułami Gson dla konsumentów. Gdy R8 analizuje ten kod i nie widzi, aby klasa UserList lub User była gdziekolwiek tworzona, może zmienić nazwy pól lub usunąć konstruktory, które nie wydają się być używane, co spowoduje awarię aplikacji. Jeśli używasz innych bibliotek w podobny sposób, sprawdź, czy nie zakłócają one optymalizacji aplikacji. Jeśli tak jest, unikaj ich.

Używaj @SerializedName z nowszymi wersjami Gson

Aby zdefiniować modele danych w sposób zgodny z regułami konsumenta Gson, dodaj do pól adnotację @SerializedName, jak pokazano w tym fragmencie kodu:

import com.google.gson.annotations.SerializedName

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

Używając adnotacji @SerializedName, zezwalasz R8 na dopasowywanie klas modeli do reguł zachowywania dołączonych do Gson w wersji 2.11.0 lub nowszej. R8 automatycznie zachowuje pola z adnotacjami i niezbędne konstruktory, dzięki czemu możesz polegać na regułach dołączonych do biblioteki bez konieczności ręcznego konfigurowania ProGuard w projekcie.

Pamiętaj, że Room, Hilt i Moshi z codegen tworzą typy zdefiniowane przez aplikację, ale używają codegen, aby uniknąć konieczności stosowania refleksji.