מידע על כללי שמירה

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

תרחישים נפוצים שבהם נדרשים כללי שמירה

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

• קוד שהגישה אליו מתבצעת באמצעות רפלקציה: ‏ R8 לא יכול לזהות מתי מתבצעת גישה למחלקות, לשדות או לשיטות באמצעות רפלקציה. לדוגמה, R8 לא יכול לזהות שיטה שמתבצעת בה בדיקה לפי השם שלה באמצעות Class.getDeclaredMethod() או הערה שאוחזרה באמצעות Class.getAnnotation(). במקרים כאלה, יכול להיות שהכלי R8 ישנה את השם של השיטות וההערות האלה או יסיר אותן לגמרי, מה שיוביל ל-ClassNotFoundException או ל-NoSuchMethodException בזמן הריצה.
• קוד שמופעל מ-Java Native Interface‏ (JNI): כשקוד מקורי (C או C++) מפעיל שיטה של Java או Kotlin, או כשקוד של Java או Kotlin מפעיל קוד של C++‎ באמצעות JNI, ההפעלה מבוססת על חיפוש דינמי של מחרוזת של שם השיטה. ‫R8 לא יכול לראות את הקריאה הדינמית לשיטה שמבוססת על מחרוזת, ולכן האופטימיזציות שלו עלולות לשבור את הקוד.

הרשימה הזו לא ממצה את כל התרחישים שבהם נדרשים כללי שמירה, אבל היא כוללת את רוב המקרים שבהם יכול להיות שתצטרכו כללי שמירה.

איך מוסיפים כללי שמירה לאפליקציה

צריך להוסיף את הכללים לקובץ proguard-rules.pro שנמצא בתיקיית השורש של מודול האפליקציה. יכול להיות שהקובץ כבר נמצא שם, אבל אם לא, צריך ליצור אותו. כדי להחיל את הכללים בקובץ, צריך להצהיר על הקובץ בקובץ build.gradle.kts (או build.gradle) ברמת המודול, כמו שמוצג בקוד הבא:

android {
    buildTypes {
        release {
            isMinifyEnabled = true
            isShrinkResources = true

            proguardFiles(
                // File with default rules provided by the Android Gradle Plugin
                getDefaultProguardFile("proguard-android-optimize.txt"),

                // File with your custom rules
                "proguard-rules.pro"
            )
           // ...
        }
    }
    // ...
}

android {
    buildTypes {
        release {
            minifyEnabled true
            shrinkResources true

            proguardFiles(
                // File with default rules provided by the Android Gradle Plugin
                getDefaultProguardFile('proguard-android-optimize.txt'),

                // File with your custom rules.
                'proguard-rules.pro'
            )
           // ...
        }
    }
    // ...
}

כברירת מחדל, קובץ ה-build כולל גם את הקובץ proguard-android-optimize.txt. הקובץ הזה כולל כללים שנדרשים לרוב פרויקטי Android, ולכן מומלץ להשאיר אותו בקובץ ה-build. הקובץ הזה מבוסס על הקובץ proguard-common.txt וכולל תוכן שמשותף עם הקובץ הזה.

באפליקציות גדולות יותר, הקוד נמצא בדרך כלל בכמה מודולים של ספריות. במקרים כאלה, עדיף בדרך כלל להציב את כללי השמירה לצד הקוד שהם חלים עליו במודול הספציפי של הספרייה. ההבדל המהותי בין שמירת כללי שמירה בספריות הוא באופן ההצהרה על הכללים האלה בקובץ build.gradle.kts (או build.gradle) של מודול הספרייה. מידע נוסף זמין במאמר אופטימיזציה למחברי ספריות.

הוספת כלל שמירה

כשמוסיפים כללי שמירה, אפשר לכלול גם אפשרויות גלובליות וגם להגדיר כללי שמירה משלכם.

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

שמירת כללים למחברים של ספרייה

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