AAPT2

AAPT2 (Android Asset Packaging Tool) to narzędzie do kompilacji, którego Android Studio i wtyczka Androida do Gradle używają do kompilowania i pakowania zasobów aplikacji. AAPT2 analizuje, indeksuje i kompiluje zasoby do formatu binarnego zoptymalizowanego pod kątem platformy Android.

Wtyczka Androida do obsługi Gradle w wersji 3.0.0 i nowszej domyślnie włącza AAPT2. Zwykle nie musisz samodzielnie wywoływać funkcji aapt2. Jeśli jednak wolisz używać terminala i własnego systemu kompilacji zamiast Androida Studio, możesz użyć narzędzia AAPT2 z poziomu wiersza poleceń. Błędy kompilacji związane z narzędziem AAPT2 możesz też debugować z poziomu wiersza poleceń. Aby to zrobić, znajdź AAPT2 jako samodzielne narzędzie w Android SDK Build Tools w wersji 26.0.2 lub nowszej.

Aby pobrać narzędzia do kompilacji pakietu Android SDK z wiersza poleceń, użyj sdkmanager i uruchom to polecenie:

sdkmanager "build-tools;build-tools-version"

Po pobraniu narzędzi do kompilacji pakietu SDK znajdź AAPT2 w folderze android_sdk/build-tools/version/.

Wersje narzędzi Android SDK Build Tools nie są publikowane często, więc wersja AAPT2 dołączona do tych narzędzi może nie być najnowsza. Aby pobrać najnowszą wersję AAPT2, pobierz AAPT2 z Google Maven.

Aby używać AAPT2 z wiersza poleceń w systemie Linux lub Mac, uruchom polecenie aapt2. W systemie Windows uruchom polecenie aapt2.exe.

AAPT2 obsługuje szybszą kompilację zasobów, umożliwiając kompilację przyrostową. Aby przeprowadzić kompilację przyrostową, przetwarzanie zasobów jest dzielone na 2 etapy:

• Kompilacja: kompiluje pliki zasobów do formatów binarnych.
• Link: łączy wszystkie skompilowane pliki i pakuje je w jeden pakiet.

Ten podział pomaga zwiększyć skuteczność przyrostowych kompilacji. Jeśli na przykład zmiany zostaną wprowadzone w jednym pliku, musisz ponownie skompilować tylko ten plik.

Pobieranie AAPT2 z Google Maven

Aby pobrać najnowszą wersję AAPT2, która nie jest dołączona do narzędzi do kompilacji, pobierz AAPT2 z repozytorium Maven Google w ten sposób:

1. W indeksie repozytorium przejdź do com.android.tools.build > aapt2.
2. Skopiuj nazwę najnowszej wersji AAPT2.

3. Wklej skopiowaną nazwę wersji do tego adresu URL i określ docelowy system operacyjny: https://dl.google.com/dl/android/maven2/com/android/tools/build/aapt2/ aapt2-version/aapt2-aapt2-version- [windows | linux | osx].jar

   Aby na przykład pobrać wersję 3.2.0-alpha18-4804415 na Windowsa, użyj tego linku: https://dl.google.com/dl/android/maven2/com/android/tools/build/aapt2/ 3.2.0-alpha18-4804415/aapt2-3.2.0-alpha18-4804415-windows.jar

4. Otwórz adres URL w przeglądarce. Pobieranie AAPT2 wkrótce się rozpocznie.

5. Rozpakuj pobrany przed chwilą plik JAR.

   Plik JAR powinien zawierać plik wykonywalny aapt2 i biblioteki, od których zależy ten plik.

Kompilacja

AAPT2 obsługuje kompilację wszystkich typów zasobów Androida, takich jak pliki rysunków i XML. Gdy wywołujesz AAPT2 do kompilacji, w każdym wywołaniu przekaż jako dane wejściowe pojedynczy plik zasobu. Następnie AAPT2 analizuje plik i generuje pośredni plik binarny z rozszerzeniem .flat.

Podczas przekazywania całych katalogów AAPT2 ponownie kompiluje wszystkie pliki w katalogu, nawet jeśli zmienił się tylko jeden zasób. Chociaż możesz przekazywać do AAPT2 katalogi zasobów zawierające więcej niż 1 plik zasobu za pomocą flagi --dir, nie uzyskasz w ten sposób korzyści z przyrostowej kompilacji zasobów.

Typy plików wyjściowych mogą się różnić w zależności od danych wejściowych podanych do kompilacji, jak pokazano w tabeli poniżej:

Tabela 1. Typy plików wejściowych i wyjściowych do kompilacji

Pliki wyjściowe AAPT2 nie są plikami wykonywalnymi. Musisz je później uwzględnić jako dane wejściowe w fazie łączenia, aby wygenerować plik APK. Wygenerowany plik APK nie jest jednak plikiem wykonywalnym, który można od razu wdrożyć na urządzeniu z Androidem, ponieważ nie zawiera plików DEX i nie jest podpisany.

Składnia kompilacji

Ogólna składnia używania compile jest taka:

aapt2 compile path-to-input-files [options] -o output-directory/

W poniższym przykładzie AAPT2 kompiluje pliki zasobów o nazwach values.xml i myImage.png oddzielnie:

aapt2 compile project_root/module_root/src/main/res/values-en/strings.xml -o compiled/
aapt2 compile project_root/module_root/src/main/res/drawable/myImage.png -o compiled/

Jak pokazano w tabeli 1, nazwa pliku wyjściowego zależy od nazwy pliku wejściowego i nazwy jego katalogu nadrzędnego.

W przypadku powyższego przykładu, w którym plik wejściowy to strings.xml, aapt2 automatycznie nadaje plikowi wyjściowemu nazwę values-en_strings.arsc.flat. Skompilowany plik drawable przechowywany w katalogu drawable ma jednak nazwę drawable_img.png.flat.

Opcje kompilacji

Z poleceniem compile możesz używać kilku opcji, jak pokazano w tabeli 2:

Tabela 2. Opcje polecenia kompilacji

Link

W fazie łączenia AAPT2 scala wszystkie pliki pośrednie wygenerowane w fazie kompilacji, takie jak tabele zasobów, binarne pliki XML i przetworzone pliki PNG, a następnie pakuje je w jeden plik APK. Dodatkowo w tej fazie można wygenerować inne pliki pomocnicze, takie jak R.java i pliki reguł ProGuard. Wygenerowany plik APK nie zawiera jednak kodu bajtowego DEX i nie jest podpisany. Nie możesz wdrożyć tego pliku APK na urządzeniu.

Jeśli nie używasz wtyczki Androida do Gradle, aby kompilować aplikację z wiersza poleceń, możesz użyć innych narzędzi wiersza poleceń, np. d8 do kompilowania kodu bajtowego Java do kodu bajtowego DEX i apksigner do podpisywania pliku APK.

Składnia linku

Ogólna składnia używania link jest taka:

aapt2 link path-to-input-files [options] -o
outputdirectory/outputfilename.apk --manifest AndroidManifest.xml

W poniższym przykładzie AAPT2 scala 2 pliki pośrednie: drawable_Image.flat i values_values.arsc.flat oraz plik AndroidManifest.xml. AAPT2 łączy wynik z android.jar plikiem, który zawiera zasoby zdefiniowane w pakiecie android:

 aapt2 link -o output.apk
 -I android_sdk/platforms/android_version/android.jar
    compiled/res/values_values.arsc.flat
    compiled/res/drawable_Image.flat --manifest /path/to/AndroidManifest.xml -v

Opcje połączenia

Z poleceniem link możesz używać tych opcji:

Tabela 3. Opcje polecenia linku

Zrzuć

dump służy do drukowania informacji o pliku APK wygenerowanym za pomocą polecenia link.

Składnia zrzutu

Ogólna składnia używania dump jest taka:

aapt2 dump sub-command filename.apk [options]

Poniższy przykład wyświetla zawartość tabeli zasobów określonego pliku APK:

aapt2 dump resources output.apk

Polecenia podrzędne zrzutu

W poleceniu dump podaj jedno z tych poleceń:

Tabela 4. Polecenia podrzędne zrzutu

Opcje zrzutu

Użyj tych opcji w przypadku dump:

Tabela 5. Opcje zrzutu

Różnice

Użyj ikony diff, aby porównać 2 pliki APK i wykryć między nimi różnice.

Składnia różnic

Ogólna składnia używania diff jest taka:

aapt2 diff first.apk second.apk

Polecenie diff nie ma żadnych opcji.

Optymalizuj

optimize służy do przeprowadzania optymalizacji scalonych zasobów i resources.arsc przed spakowaniem ich do pliku APK. Ta optymalizacja może zmniejszyć rozmiar pliku APK o około 1–3% w zależności od rozmiaru i liczby używanych zasobów.

Optymalizacja składni

Ogólna składnia używania optimize jest taka:

aapt2 optimize options file[,file[..]]

Poniższy przykład optymalizuje zasoby w input.apk i tworzy nowy, zoptymalizowany plik APK w output.apk. Zastępuje zwykłą reprezentację tabeli płaskiej bardziej kompaktową reprezentacją, co prowadzi do zmniejszenia rozmiaru pliku APK, zużycia pamięci i opóźnienia przy uruchamianiu oraz niewielkiego wzrostu czasu wyszukiwania poszczególnych zasobów po uruchomieniu.

aapt2 optimize -o output.apk --enable-sparse-encoding input.apk

Opcje optymalizacji

W przypadku urządzenia optimize możesz użyć tych opcji:

Tabela 6. Opcje optymalizacji

Konwertowanie

Domyślnie polecenie AAPT compile kompiluje zasoby do formatu binarnego, który jest odpowiedni dla plików APK. Możesz też określić format protobuf, który jest odpowiedni dla pakietów AAB, podając --proto-format. Polecenie convert konwertuje pakiety APK między tymi dwoma formatami.

Konwertowanie składni

Ogólna składnia convert jest taka:

aapt2 convert -o output-file options file[,file[..]]

W tym przykładzie zasoby w input.apk są konwertowane i tworzony jest nowy plik APK w output.apk zawierający zasoby w formacie protobuf. Zastępuje ona zwykłą reprezentację w postaci płaskiej tabeli bardziej kompaktową reprezentacją, co prowadzi do zmniejszenia rozmiaru pliku APK, zużycia pamięci i opóźnienia uruchamiania oraz niewielkiego wzrostu

aapt2 convert -o output.apk --output-format proto --enable-sparse-encoding input.apk

Opcje konwersji

Użyj tych opcji w przypadku convert:

Tabela 7. Opcje konwersji

Tryb demona

W wersji 2.19 narzędzia AAPT wprowadzono tryb demona do wydawania poleceń. Tryb demona umożliwia wpisywanie wielu poleceń w ramach jednej sesji AAPT.

Składnia demona

Uruchom tryb demona za pomocą tego polecenia:

aapt2 daemon

Gdy tryb demona jest uruchomiony, możesz wpisywać polecenia. Każdy argument polecenia musi znajdować się w osobnym wierszu, a na końcu polecenia musi być pusty wiersz. Aby wyjść z trybu demona, wpisz Control+D.

Rozważ te polecenia compile:

aapt2 compile project_root/module_root/src/main/res/values-en/strings.xml -o compiled/
aapt2 compile project_root/module_root/src/main/res/drawable/myImage.png -o compiled/

Polecenia te można wprowadzać w trybie demona w ten sposób:

aapt2 daemon
Ready
compile
project_root/module_root/src/main/res/values-en/strings.xml
-o
compiled/

Done
compile
project_root/module_root/src/main/res/drawable/myImage.png
-o
compiled/

Done
^D
Exiting daemon

Opcje trybu demona

Jedyną opcją trybu demona jest --trace-folder folder, która generuje fragment śledzenia systrace JSON do określonego folder.

Wersja

Sprawdź, której wersji AAPT2 używasz, za pomocą polecenia version:

aapt2 version
Android Asset Packaging Tool (aapt) 2.19-8678579

Zmiany w działaniu podczas korzystania z AAPT2

Przed AAPT2 domyślną wersją narzędzia do pakowania zasobów Androida (Android Asset Packaging Tool) było AAPT, które jest obecnie wycofywane. Chociaż AAPT2 powinien od razu działać w przypadku starszych projektów, w tej sekcji opisujemy niektóre zmiany w działaniu, o których warto wiedzieć.

Hierarchie elementów w pliku manifestu Androida

W poprzednich wersjach AAPT elementy zagnieżdżone w nieprawidłowych węzłach w plikuAndroidManifest.xml były ignorowane lub powodowały wyświetlenie ostrzeżenia. Rozważmy na przykład taką sytuację:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
   package="com.example.myname.myapplication">
   <application
       ...
       <activity android:name=".MainActivity">
           <intent-filter>
               <action android:name="android.intent.action.MAIN" />
               <category android:name="android.intent.category.LAUNCHER" />
           </intent-filter>
           <action android:name="android.intent.action.CUSTOM" />
       </activity>
   </application>
</manifest>

Poprzednie wersje AAPT po prostu ignorowały nieprawidłowo umieszczony tag <action>.

W przypadku AAPT2 wyświetla się ten błąd:

AndroidManifest.xml:15: error: unknown element <action> found.

Aby rozwiązać ten problem, upewnij się, że elementy pliku manifestu są prawidłowo zagnieżdżone. Więcej informacji znajdziesz w omówieniu pliku manifestu aplikacji.

Deklaracja zasobów

Nie możesz już wskazywać typu zasobu za pomocą atrybutu name. W tym przykładzie element zasobu attr jest zadeklarowany nieprawidłowo:

<style name="childStyle" parent="parentStyle">
    <item name="attr/my_attr">@color/pink</item>
</style>

Zadeklarowanie typu zasobu w ten sposób spowoduje wystąpienie tego błędu kompilacji:

Error: style attribute 'attr/attr/my_attr (aka my.package:attr/attr/my_attr)'
not found.

Aby rozwiązać ten błąd, jawnie zadeklaruj typ za pomocą type="attr":

<style name="childStyle" parent="parentStyle">
  <item type="attr" name="my_attr">@color/pink</item>
</style>

Dodatkowo podczas deklarowania elementu <style> jego element nadrzędny musi być też zasobem typu style. W przeciwnym razie pojawi się błąd podobny do tego:

Error: (...) invalid resource type 'attr' for parent of style

Nieprawidłowe użycie symboli odwołania do zasobu @

AAPT2 zgłasza błędy kompilacji, gdy pominiesz lub nieprawidłowo umieścisz symbole odwołań do zasobów (@). Na przykład jeśli pominiesz symbol podczas określania atrybutu stylu:

<style name="AppTheme" parent="Theme.AppCompat.Light.DarkActionBar">
  ...
  <!-- Note the missing '@' symbol when specifying the resource type. -->
  <item name="colorPrimary">color/colorPrimary</item>
</style>

Podczas kompilowania modułu AAPT2 zgłasza ten błąd kompilacji:

ERROR: expected color but got (raw string) color/colorPrimary

Jeśli podczas uzyskiwania dostępu do zasobu z przestrzeni nazw android nieprawidłowo uwzględnisz symbol:

...
<!-- When referencing resources from the 'android' namespace, omit the '@' symbol. -->
<item name="@android:windowEnterAnimation"/>

Podczas kompilowania modułu AAPT2 zgłasza ten błąd kompilacji:

Error: style attribute '@android:attr/windowEnterAnimation' not found

Nieprawidłowa konfiguracja bibliotek

Jeśli Twoja aplikacja jest zależna od biblioteki innej firmy, która została utworzona przy użyciu starszych wersji narzędzi do kompilacji pakietu SDK Androida, może ona ulec awarii w czasie działania bez wyświetlania błędów ani ostrzeżeń. Ten błąd może wystąpić, ponieważ podczas tworzenia biblioteki pola R.java są deklarowane jako final. W rezultacie wszystkie identyfikatory zasobów są wstawiane w klasach biblioteki.

AAPT2 musi mieć możliwość ponownego przypisywania identyfikatorów do zasobów biblioteki podczas tworzenia aplikacji. Jeśli biblioteka zakłada, że identyfikatory to final, i wstawia je w kodzie DEX biblioteki, występuje niezgodność w czasie działania.

Aby rozwiązać ten problem, skontaktuj się z autorem biblioteki i poproś go o przebudowanie jej za pomocą najnowszej wersji narzędzi do kompilacji pakietu Android SDK oraz ponowne opublikowanie biblioteki.