AAPT2

‫AAPT2 ‏ (Android Asset Packaging Tool) הוא כלי build ש-Android Studio ו-Android Gradle Plugin משתמשים בו כדי לקמפל ולארוז את המשאבים של האפליקציה. ‫AAPT2 מנתח, יוצר אינדקס ומקמפל את המשאבים לפורמט בינארי שעבר אופטימיזציה לפלטפורמת Android.

‫Android Gradle Plugin מגרסה 3.0.0 ואילך מפעיל את AAPT2 כברירת מחדל. בדרך כלל לא צריך להפעיל את aapt2 בעצמכם. עם זאת, אם אתם מעדיפים להשתמש בטרמינל ובמערכת ה-build שלכם במקום ב-Android Studio, אתם יכולים להשתמש ב-AAPT2 משורת הפקודה. אפשר גם לנפות באגים ב-AAPT2 שקשורים לשגיאות בנייה משורת הפקודה. כדי לעשות זאת, צריך למצוא את AAPT2 ככלי עצמאי ב-Android SDK Build Tools מגרסה 26.0.2 ואילך.

כדי להוריד את Android SDK Build Tools משורת הפקודה, משתמשים ב-sdkmanager ומריצים את הפקודה הבאה:

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

אחרי שמורידים את SDK Build Tools, מאתרים את AAPT2 ב-android_sdk/build-tools/version/.

כי גרסאות חדשות של כלי ה-Build של Android SDK לא יוצאות לעיתים קרובות, יכול להיות שהגרסה של AAPT2 שכלולה בכלי ה-Build של SDK לא תהיה הגרסה העדכנית ביותר. כדי לקבל את הגרסה האחרונה של AAPT2,‏ מורידים את AAPT2 מ-Google Maven.

כדי להשתמש ב-AAPT2 משורת הפקודה ב-Linux או ב-Mac, מריצים את הפקודה aapt2. ב-Windows, מריצים את הפקודה aapt2.exe.

‫AAPT2 תומך בהידור מהיר יותר של משאבים על ידי הפעלת הידור מצטבר. כדי לבצע קומפילציה מצטברת, עיבוד המשאבים מתבצע בשני שלבים:

• ‫Compile: קומפילציה של קובצי משאבים לפורמטים בינאריים.
• קישור: ממזג את כל הקבצים המהודרים ומאגד אותם לחבילה אחת.

ההפרדה הזו עוזרת לשפר את הביצועים של בנייה מצטברת. לדוגמה, אם יש שינויים בקובץ אחד, צריך לבצע קומפילציה מחדש רק של הקובץ הזה.

הורדת AAPT2 מ-Google Maven

כדי לקבל את הגרסה החדשה ביותר של AAPT2 שלא כלולה בחבילת כלי ה-build, צריך להוריד את AAPT2 ממאגר Maven של Google באופן הבא:

1. באינדקס המאגר, מנווטים אל com.android.tools.build > aapt2.
2. מעתיקים את השם של הגרסה האחרונה של AAPT2.

3. מזינים את שם הגרסה שהעתקתם לכתובת ה-URL הבאה ומציינים את מערכת ההפעלה שלכם: https://dl.google.com/dl/android/maven2/com/android/tools/build/aapt2/ aapt2-version/aapt2-aapt2-version- [windows | linux | osx].jar

   לדוגמה, כדי להוריד את גרסה 3.2.0-alpha18-4804415 ל-Windows, משתמשים בכתובת הבאה: 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. עוברים לכתובת ה-URL בדפדפן. ההורדה של AAPT2 תתחיל בקרוב.

5. מבטלים את האריזה של קובץ ה-JAR שהורדתם.

   קובץ ה-JAR צריך להכיל קובץ הפעלה aapt2 וכמה ספריות שהקובץ תלוי בהן.

הידור

‫AAPT2 תומך בהידור של כל סוגי משאבי Android, כמו קובצי XML ומשאבים מסוג drawable. כשמפעילים את AAPT2 לצורך קומפילציה, מעבירים קובץ משאבים יחיד כקלט לכל הפעלה. לאחר מכן, הכלי AAPT2 מנתח את הקובץ ויוצר קובץ בינארי ביניים עם סיומת .flat.

כשמעבירים ספריות שלמות, כלי AAPT2 מבצע קומפילציה מחדש של כל הקבצים בספרייה, גם אם רק משאב אחד השתנה. אפשר להעביר ל-AAPT2 ספריות משאבים שמכילות יותר מקובץ משאבים אחד באמצעות הדגל --dir, אבל לא תקבלו את היתרונות של קומפילציה מצטברת של משאבים בדרך הזו.

סוגי קובצי הפלט יכולים להיות שונים בהתאם לקלט שסיפקתם לקומפילציה, כמו שמוצג בטבלה הבאה:

טבלה 1. סוגי קובצי הקלט והפלט של ההידור

הקבצים שנוצרים על ידי AAPT2 הם לא קבצים הפעלה, ותצטרכו לכלול את הקבצים הבינאריים האלה כקלט בשלב הקישור כדי ליצור קובץ APK. עם זאת, קובץ ה-APK שנוצר הוא לא קובץ הפעלה שאפשר לפרוס במכשיר Android באופן מיידי, כי הוא לא מכיל קובצי DEX והוא לא חתום.

תחביר של הידור

התחביר הכללי לשימוש ב-compile הוא:

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

בדוגמה הבאה, כלי AAPT2 מהדר קובצי משאבים בשמות values.xml ו-myImage.png בנפרד:

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/

כפי שמוצג בטבלה 1, שם קובץ הפלט תלוי בשם קובץ הקלט ובשם של ספריית ההורה שלו.

בדוגמה הקודמת, עם קובץ strings.xml כקלט, aapt2 נותן באופן אוטומטי לקובץ הפלט את השם values-en_strings.arsc.flat. עם זאת, קובץ ה-drawable שעבר קומפילציה ומאוחסן בספריית ה-drawable נקרא drawable_img.png.flat.

אפשרויות הידור

יש כמה אפשרויות שאפשר להשתמש בהן עם הפקודה compile, כמו שמוצג בטבלה 2:

טבלה 2. אפשרויות של פקודת קומפילציה

קישור

בשלב הקישור, כלי AAPT2 ממזג את כל הקבצים הזמניים שנוצרים בשלב ההידור, כמו טבלאות משאבים, קובצי XML בינאריים וקובצי PNG שעברו עיבוד, ואז אורז את הקבצים בחבילת APK אחת. בנוסף, יכולים להיווצר בשלב הזה קבצים עזר אחרים, כמו R.java וקבצים של כללי ProGuard. עם זאת, קובץ ה-APK שנוצר לא מכיל קוד בייט של DEX והוא לא חתום. אי אפשר לפרוס את ה-APK הזה במכשיר.

אם אתם לא משתמשים בתוסף Android Gradle כדי לבנות את האפליקציה משורת הפקודה, אתם יכולים להשתמש בכלים אחרים משורת הפקודה, כמו d8 כדי לקמפל קוד בייטקוד של Java לקוד בייטקוד של DEX, ו-apksigner כדי לחתום על ה-APK.

תחביר הקישור

התחביר הכללי לשימוש ב-link הוא:

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

בדוגמה הבאה, הכלי AAPT2 ממזג שני קבצים זמניים, drawable_Image.flat ו-values_values.arsc.flat, ואת הקובץ AndroidManifest.xml. ‫AAPT2 מקשר את התוצאה לקובץ android.jar, שמכיל את המשאבים שהוגדרו בחבילה 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

אפשרויות קישור

אפשר להשתמש באפשרויות הבאות עם הפקודה link:

טבלה 3. אפשרויות של פקודת הקישור

Dump

הפקודה dump משמשת להדפסת מידע על קובץ ה-APK שנוצר באמצעות הפקודה link.

תחביר של dump

התחביר הכללי לשימוש ב-dump הוא:

aapt2 dump sub-command filename.apk [options]

בדוגמה הבאה מודפס תוכן מטבלת המשאבים של קובץ ה-APK שצוין:

aapt2 dump resources output.apk

פקודות משנה של dump

מציינים אחת מהפקודות המשניות הבאות עם הפקודה dump:

טבלה 4. פקודות משנה של dump

אפשרויות של dump

אפשר להשתמש באפשרויות הבאות עם dump:

טבלה 5. אפשרויות של dump

הבדלים

אפשר להשתמש ב-diff כדי להשוות בין שני קובצי APK ולזהות את ההבדלים ביניהם.

תחביר של השוואה

התחביר הכללי לשימוש ב-diff הוא:

aapt2 diff first.apk second.apk

אין אפשרויות לפקודה diff.

ביצוע אופטימיזציה

‫optimize משמש להפעלת אופטימיזציות על המשאבים הממוזגים ועל resources.arsc לפני שהם נארזים ב-APK. האופטימיזציה הזו יכולה להקטין את גודל ה-APK בכ-1-3%, בהתאם לגודל ולמספר המשאבים שנמצאים בשימוש.

אופטימיזציה של התחביר

התחביר הכללי לשימוש ב-optimize הוא:

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

בדוגמה הבאה, המשאבים ב-input.apk עוברים אופטימיזציה ונוצר APK חדש שעבר אופטימיזציה ב-output.apk. הוא מחליף את הייצוג הרגיל של טבלה שטוחה בייצוג קומפקטי יותר, וכך מוביל להפחתה בגודל ה-APK, בשימוש בזיכרון ובחביון ההפעלה, ולעלייה קלה בזמן החיפוש של כל משאב בנפרד אחרי ההפעלה.

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

אפשרויות אופטימיזציה

אפשר להשתמש באפשרויות הבאות עם optimize:

טבלה 6. אפשרויות אופטימיזציה

המרה

כברירת מחדל, הפקודה compile של AAPT מהדרת משאבים לפורמט בינארי שמתאים לקובצי APK. אפשר גם לציין פורמט protobuf שמתאים לקובצי AAB על ידי ציון --proto-format. הפקודה convert ממירה קובצי APK בין שני הפורמטים.

תחביר להמרה

התחביר הכללי של convert הוא:

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

בדוגמה הבאה, המשאבים ב-input.apk מומרים ונוצר קובץ APK חדש ב-output.apk שמכיל משאבים בפורמט protobuf. הוא מחליף את הייצוג הרגיל של טבלה שטוחה בייצוג קומפקטי יותר, וכך מקטין את גודל ה-APK, את השימוש בזיכרון ואת זמן האחזור של ההפעלה, ומגדיל מעט את

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

אפשרויות המרה

אפשר להשתמש באפשרויות הבאות עם convert:

טבלה 7. אפשרויות המרה

מצב דימון

בגרסה 2.19 של AAPT נוסף מצב דימון (daemon) להנפקת פקודות. מצב Daemon מאפשר להזין כמה פקודות בסשן AAPT אחד.

תחביר של Daemon

מפעילים את מצב הדמון באמצעות הפקודה הבאה:

aapt2 daemon

אחרי שמצב הדמון פועל, אפשר להזין פקודות. כל ארגומנט של הפקודה צריך להיות בשורה נפרדת, ובסוף הפקודה צריכה להיות שורה ריקה. כדי לצאת ממצב הדמון, מקלידים Control+D.

כדאי לעיין בפקודות הבאות של 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/

אפשר להזין את הפקודות האלה במצב daemon באופן הבא:

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

אפשרויות במצב Daemon

האפשרות היחידה למצב דמון היא --trace-folder folder, שיוצרת קטע של מעקב בפורמט JSON‏ systrace למיקום שצוין folder.

גרסה

כדי לדעת באיזו גרסה של AAPT2 אתם משתמשים, מריצים את הפקודה version:

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

שינויים בהתנהגות כשמשתמשים ב-AAPT2

לפני AAPT2, ‏ AAPT הייתה גרסת ברירת המחדל של Android Asset Packaging Tool (כלי לאריזת נכסים ב-Android), שכבר הוצאה משימוש. למרות ש-AAPT2 אמור לפעול באופן מיידי עם פרויקטים ישנים יותר, בקטע הזה מתוארים כמה שינויים בהתנהגות שכדאי להכיר.

היררכיות של רכיבים במניפסט של Android

בגרסאות קודמות של AAPT, רכיבים שמוטמעים בצמתים שגויים בקובץ AndroidManifest.xml היו מתעלמים מהם או שהם היו גורמים להצגת אזהרה. לדוגמה:

<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>

בגרסאות קודמות של AAPT, התג <action> שהוצב במקום הלא נכון פשוט היה מושמט.

ב-AAPT2, מוצגת השגיאה הבאה:

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

כדי לפתור את הבעיה, צריך לוודא שרכיבי המניפסט מוטמעים בצורה נכונה. מידע נוסף זמין במאמר סקירה כללית על מניפסט האפליקציה.

הצהרה על משאבים

אי אפשר יותר לציין את סוג המשאב באמצעות המאפיין name. בדוגמה הבאה מוצהר בצורה שגויה על פריט משאב attr:

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

הצהרה על סוג משאב בדרך הזו מובילה לשגיאת ה-build הבאה:

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

כדי לפתור את השגיאה, צריך להצהיר באופן מפורש על הסוג באמצעות type="attr":

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

בנוסף, כשמצהירים על רכיב <style>, רכיב ההורה שלו חייב להיות גם מסוג משאב סגנון. אחרת, תקבלו שגיאה דומה לזו:

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

שימוש שגוי בסמלי הפניה למשאבים עם התו @

כלי AAPT2 מציג שגיאות בנייה כשמשמיטים סמלי הפניה למשאבים (@) או כשמציבים אותם במקום לא נכון. לדוגמה, אם משמיטים את הסמל כשמציינים מאפיין סגנון:

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

כשמבצעים build של המודול, AAPT2 מחזיר את שגיאת ה-build הבאה:

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

בנוסף, אם כוללים בטעות את הסמל כשניגשים למשאב ממרחב השמות android:

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

כשמבצעים build של המודול, AAPT2 מחזיר את שגיאת ה-build הבאה:

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

הגדרות שגויות של ספריות

אם האפליקציה שלכם תלויה בספרייה של צד שלישי שנבנתה באמצעות גרסאות ישנות יותר של Android SDK Build Tools, יכול להיות שהאפליקציה תקרוס בזמן הריצה בלי להציג שגיאות או אזהרות. יכול להיות שהקריסה הזו מתרחשת כי במהלך יצירת הספרייה, השדות R.java מוצהרים כ-final. כתוצאה מכך, כל מזהי המשאבים מוטמעים בכיתות של הספרייה.

כדי לבנות את האפליקציה, כלי AAPT2 צריך להיות מסוגל להקצות מחדש מזהים למשאבי הספרייה. אם הספרייה מניחה שהמזהים הם final ומטמיעה אותם ב-DEX של הספרייה, יש אי התאמה בזמן הריצה.

כדי לפתור את השגיאה הזו, צריך ליצור קשר עם מחבר הספרייה כדי לבנות מחדש את הספרייה באמצעות הגרסה העדכנית של Android SDK Build Tools, ולפרסם מחדש את הספרייה.