למרות ש-"Jetpack פיתוח נייטיב" מטפל בכלים של זמן העיצוב של ממשק המשתמש ישירות ב-Kotlin, מרחב השמות tools: עדיין חיוני להגדרות ברמת הפרויקט. בקובצי XML רגילים של Android, כמו AndroidManifest.xml ו-res/raw/keep.xml, משתמשים במאפייני tools: כדי לנהל את האזהרות של Lint ולהגדיר את הכלי לצמצום משאבים.
כשאתם יוצרים את האפליקציה, כלי ה-build מסירים את המאפיינים האלה כדי שלא תהיה להם השפעה על גודל ה-APK או על ההתנהגות בזמן הריצה.
כדי להשתמש במאפיינים האלה, מוסיפים את מרחב השמות tools לרכיב הבסיס של כל קובץ XML שבו רוצים להשתמש בהם, כמו שמוצג כאן:
<RootTag xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" >
מאפיינים לטיפול בשגיאות
המאפיינים הבאים עוזרים להסתיר הודעות אזהרה של lint:
tools:ignore
מיועד ל: כל רכיב
בשימוש על ידי: Lint
המאפיין הזה מקבל רשימה מופרדת בפסיקים של מזהי בעיות ניתוח קוד סטטי שאתם רוצים שהכלים יתעלמו מהן ברכיב הזה או בכל אחד מהצאצאים שלו.
לדוגמה, אפשר להורות לכלים להתעלם מהשגיאה MissingTranslation:
<string name="show_all_apps" tools:ignore="MissingTranslation">All</string>
tools:targetApi
מיועד ל: כל רכיב
בשימוש על ידי: Lint
המאפיין הזה פועל כמו ההערה @TargetApi בקוד Java או ההערה @RequiresApi בקוד Kotlin. הוא מאפשר לציין את רמת ה-API (כמספר שלם או כשם קוד) שתומכת ברכיב הזה.
כך כלי ה-lint יודעים שאתם חושבים שהרכיב הזה וכל הצאצאים שלו משמשים רק ברמת ה-API שצוינה או ברמה גבוהה יותר. כך, כלי ה-lint לא יציג אזהרה אם הרכיב או המאפיינים שלו לא זמינים ברמת ה-API שציינתם בתור minSdkVersion.
לדוגמה, יכול להיות שתשתמשו במאפיין הזה כי אתם מצהירים על <service> ב-AndroidManifest.xml שמשתמש בסוג שירות בחזית שזמין רק ברמת API 34 ומעלה, אבל ה-minSdkVersion של הפרויקט נמוך יותר:
<service
android:name=".playback.MediaPlaybackService"
android:foregroundServiceType="mediaPlayback"
xmlns:tools="http://schemas.android.com/tools"
tools:targetApi="34" />
tools:locale
מיועד ל: <resources>
בשימוש על ידי: Lint, עורך Android Studio
כך הכלים יודעים מהי שפת ברירת המחדל או מהו הלוקאל של המשאבים ברכיב <resources> הנתון, כדי למנוע אזהרות מהבודק האיות.
אחרת, הכלי מניח שהשפה היא אנגלית.
הערך חייב להיות מזהה שינוי מקומי תקין.
לדוגמה, אפשר להוסיף את הקוד הבא לקובץ ברירת המחדל values/strings.xml כדי לציין שהשפה שבה משתמשים במחרוזות ברירת המחדל היא ספרדית ולא אנגלית:
<resources xmlns:tools="http://schemas.android.com/tools"
tools:locale="es">
מאפייני כיווץ מקורות המידע
המאפיינים הבאים מאפשרים להפעיל בדיקות קפדניות של קובצי עזר ולהצהיר אם לשמור או למחוק משאבים מסוימים כשמשתמשים בכיווץ מקורות המידע.
כדי להפעיל את כיווץ מקורות המידע, מגדירים את המאפיין shrinkResources כ-true בקובץ build.gradle, לצד minifyEnabled לכיווץ הקוד.
לדוגמה:
מגניב
android { ... buildTypes { release { shrinkResources true minifyEnabled true proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } } }
Kotlin
android { ... buildTypes { getByName("release") { isShrinkResources = true isMinifyEnabled = true proguardFiles( getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro" ) } } }
tools:shrinkMode
מיועד ל: <resources>
בשימוש על ידי: כלי פיתוח עם כיווץ מקורות מידע
המאפיין הזה מאפשר לציין אם כלי ה-build צריכים להשתמש באפשרויות הבאות:
- מצב בטוח: שמירה על כל המשאבים שצוינו במפורש ושעשויים להיות מקושרים באופן דינמי באמצעות קריאה ל-
Resources.getIdentifier. - מצב קפדני: שמירה רק על המשאבים שמצוינים במפורש בקוד או במשאבים אחרים.
כברירת מחדל, המערכת משתמשת במצב בטוח (shrinkMode="safe"). כדי להשתמש במצב קפדני, צריך להוסיף את shrinkMode="strict" לתג <resources>, כמו שמוצג כאן:
<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
tools:shrinkMode="strict" />
כשמפעילים את המצב הקפדני, יכול להיות שתצטרכו להשתמש ב-tools:keep כדי לשמור משאבים שהוסרו אבל אתם רוצים להשאיר, ולהשתמש ב-tools:discard כדי להסיר משאבים נוספים באופן מפורש.
מידע נוסף זמין במאמר כיווץ המשאבים.
tools:keep
מיועד ל: <resources>
בשימוש על ידי: כלי פיתוח עם כיווץ מקורות מידע
כשמשתמשים בכיווץ מקורות המידע כדי להסיר מקורות מידע שלא בשימוש, המאפיין הזה מאפשר לציין מקורות מידע שרוצים לשמור, בדרך כלל כי יש אליהם הפניה באופן עקיף בזמן הריצה, למשל על ידי העברת שם של מקור מידע שנוצר באופן דינמי אל Resources.getIdentifier.
כדי להשתמש באפשרות הזו, יוצרים קובץ XML בספריית המשאבים (לדוגמה, res/raw/keep.xml) עם תג <resources> ומציינים כל משאב שרוצים לשמור במאפיין tools:keep כרשימה מופרדת בפסיקים. אפשר להשתמש בתו הכוכבית כתו כללי לחיפוש.
לדוגמה:
<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
tools:keep="@layout/used_1,@layout/used_2,@layout/*_3" />
מידע נוסף זמין במאמר כיווץ המשאבים.
tools:discard
מיועד ל: <resources>
בשימוש על ידי: כלי פיתוח עם כיווץ מקורות מידע
כשמשתמשים בכיווץ מקורות המידע כדי להסיר מקורות מידע שלא בשימוש, המאפיין הזה מאפשר לציין מקורות מידע שרוצים להסיר באופן ידני. בדרך כלל, הסיבה לכך היא שיש הפניה למקור המידע, אבל באופן שלא משפיע על האפליקציה, או שהפלאגין של Gradle הסיק באופן שגוי שיש הפניה למקור המידע.
כדי להשתמש בכלי, יוצרים קובץ XML בספריית המשאבים (לדוגמה, res/raw/keep.xml) עם תג <resources> ומציינים כל משאב שרוצים למחוק במאפיין tools:discard כרשימה מופרדת בפסיקים. אפשר להשתמש בתו הכוכבית כתו כללי לחיפוש.
לדוגמה:
<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
tools:discard="@layout/unused_1" />
מידע נוסף זמין במאמר כיווץ המשאבים.