יצירת ספרייה ל-Android

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

עם זאת, במקום קומפילציה ל-APK שפועל במכשיר, ספריית Android עוברת קומפילציה לקובץ Android Archive‏ (AAR) שאפשר להשתמש בו כתלות במודול של אפליקציית Android. בניגוד לקובצי JAR, קובצי AAR מציעים את הפונקציונליות הבאה לאפליקציות ל-Android:

  • קובצי AAR יכולים להכיל משאבי Android וקובץ מניפסט, שמאפשרים לכם לארוז משאבים משותפים כמו פריסות ומשאבים מסוג drawable, בנוסף למחלקות ולשיטות של Kotlin או Java.
  • קובצי AAR יכולים להכיל ספריות C/C++‎ לשימוש בקוד C/C++‎ של מודול האפליקציה.

מודול ספרייה שימושי במצבים הבאים:

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

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

בדף הזה מוסבר איך ליצור מודול של ספריית Android ואיך להשתמש בו. הוראות לפרסום ספרייה מופיעות במאמר פרסום הספרייה.

יצירת מודול של ספרייה

כדי ליצור מודול ספרייה חדש בפרויקט:

  1. לוחצים על File > New > New Module (קובץ > חדש > מודול חדש).
  2. בתיבת הדו-שיח Create New Module שמופיעה, לוחצים על Android Library ואז על Next.

    יש גם אפשרות ליצור ספריית Kotlin או Java, שיוצרת קובץ JAR מסורתי. קובץ JAR שימושי להרבה פרויקטים – במיוחד כשרוצים לשתף קוד עם פלטפורמות אחרות – אבל אי אפשר לכלול בו משאבים של Android או קובצי מניפסט, וזה מאוד שימושי לשימוש חוזר בקוד בפרויקטים של Android. המדריך הזה מתמקד ביצירת ספריות Android.

  3. נותנים שם לספרייה, בוחרים גרסת SDK מינימלית לקוד בספרייה ולוחצים על סיום.

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

המרת מודול אפליקציה למודול ספרייה

אם יש לכם מודול אפליקציה קיים עם קוד שאתם רוצים לעשות בו שימוש חוזר, אתם יכולים להפוך אותו למודול ספרייה באופן הבא:

  1. פותחים את הקובץ build.gradle ברמת המודול אם משתמשים ב-Groovy, או את הקובץ build.gradle.kts אם משתמשים בסקריפט Kotlin.
  2. מחיקת השורה של applicationId. רק מודול של אפליקציית Android יכול להגדיר את זה.
  3. מחפשים את הבלוק plugins בחלק העליון של הקובץ, שנראה כך:

    Groovy

      plugins {
      id 'com.android.application'
  }

    Kotlin

      plugins {
      id("com.android.application")
  }

    משנים את הערך לערך הבא:

    Groovy

      plugins {
      id 'com.android.library'
  }

    Kotlin

      plugins {
      id("com.android.library")
  }
  4. שומרים את הקובץ ולוחצים על File > Sync Project with Gradle Files (קובץ > סנכרון הפרויקט עם קובצי Gradle).

המבנה של המודול נשאר זהה, אבל עכשיו הוא פועל כספריית Android. ה-build יוצר קובץ AAR במקום קובץ APK.

כשרוצים ליצור את קובץ ה-AAR, בוחרים את מודול הספרייה בחלון Project (פרויקט) ולוחצים על Build > Build APK (יצירת APK).

הוספת תלויות באמצעות תיבת הדו-שיח Project Structure (מבנה הפרויקט)

אפשר להשתמש בתיבת הדו-שיח Project Structure כדי להוסיף תלויות לפרויקט. בקטעים הבאים מוסבר איך להשתמש בתיבת הדו-שיח כדי להוסיף תלויות.

שימוש בספרייה מתוך אותו פרויקט

כדי להשתמש בקוד של ספריית Android החדשה באפליקציה אחרת או במודול ספרייה אחר באותו פרויקט, מוסיפים תלות ברמת הפרויקט:

  1. עוברים אל קובץ > מבנה הפרויקט > תלויות.
  2. בוחרים את המודול שרוצים להוסיף לו את הספרייה.
  3. בכרטיסייה Declared Dependencies (תלויות מוצהרות), לוחצים על ובוחרים באפשרות Module Dependency (תלות במודול) מהתפריט.

  4. בתיבת הדו-שיח Add Module Dependency, בוחרים את מודול הספרייה.

    הוספת תלות במודול בתיבת הדו-שיח Project Structure (מבנה הפרויקט)

  5. בוחרים את ההגדרה שדורשת את התלות הזו או בוחרים באפשרות implementation (הטמעה) אם התלות חלה על כל ההגדרות, ואז לוחצים על OK (אישור).

‫Android Studio עורך את הקובץ build.gradle או build.gradle.kts של המודול כדי להוסיף את התלות, בפורמט הבא:

Groovy

  implementation project(path: ":example-library")

Kotlin

  implementation(project(":example-library"))

שימוש בספרייה בפרויקטים אחרים

הדרך המומלצת לשתף תלויות (JAR ו-AAR) היא באמצעות מאגר Maven, שמארח שירות כמו Maven Central, או באמצעות מבנה ספריות בדיסק המקומי. מידע נוסף על שימוש במאגרי Maven זמין במאמר מאגרים מרוחקים.

כשספריית Android מתפרסמת במאגר Maven, נכללים בה מטא-נתונים כדי שהתלויות של הספרייה ייכללו ב-build שמשתמש בספרייה. כך אפשר לבטל כפילויות בספרייה באופן אוטומטי אם משתמשים בה בכמה מקומות.

כדי להשתמש בקוד של ספריית Android במודול אחר של אפליקציה בפרויקט אחר, צריך לפעול באופן הבא:

  1. עוברים אל File > Project Structure > Dependencies.
  2. בכרטיסייה Declared Dependencies (תלויות מוצהרות), לוחצים על ובוחרים באפשרות Library Dependency (תלות בספרייה) בתפריט.

  3. בתיבת הדו-שיח Add Library Dependency (הוספת תלות בספרייה), משתמשים בתיבת החיפוש כדי למצוא את הספרייה שרוצים להוסיף. הטופס הזה מחפש במאגרי המידע שצוינו בבלוק dependencyResolutionManagement { repositories {...}} בקובץ settings.gradle או settings.gradle.kts.

    הוספת תלות בספרייה בתיבת הדו-שיח Project Structure (מבנה הפרויקט)

  4. בוחרים את ההגדרה שדורשת את התלות הזו או בוחרים באפשרות implementation (הטמעה) אם התלות חלה על כל ההגדרות, ואז לוחצים על OK (אישור).

בודקים את הקובץ build.gradle או build.gradle.kts של האפליקציה כדי לוודא שמופיעה הצהרה דומה להצהרה הבאה (בהתאם להגדרת ה-build שבחרתם):

Groovy

  implementation 'com.example:examplelibrary:1.0.0'

Kotlin

  implementation("com.example:examplelibrary:1.0.0")

הוספת קובץ AAR או JAR כתלות

כדי להשתמש בקוד של ספריית Android במודול אחר של אפליקציה, פועלים לפי השלבים הבאים:

  1. עוברים אל קובץ > מבנה הפרויקט > תלויות.
  2. בכרטיסייה Declared Dependencies (תלויות מוצהרות), לוחצים על ובוחרים באפשרות Jar Dependency (תלות ב-Jar) בתפריט.

  3. בתיבת הדו-שיח Add Jar/Aar Dependency (הוספת תלות ב-Jar/Aar), מזינים את הנתיב לקובץ ה-AAR או ה-JAR, ואז בוחרים את ההגדרה שאליה התלות חלה. אם רוצים שהספרייה תהיה זמינה לכל ההגדרות, בוחרים בהגדרת ההטמעה.

    הוספת תלות AAR בתיבת הדו-שיח Project Structure (מבנה הפרויקט)

    בודקים את הקובץ build.gradle או build.gradle.kts של האפליקציה כדי לוודא שמופיעה הצהרה דומה להצהרה הבאה (בהתאם להגדרת ה-build שבחרתם):

    Groovy

      implementation files('my_path/my_lib.aar')

    Kotlin

      implementation(files("my_path/my_lib.aar"))

כדי לייבא תלות ב-build של Gradle שפועל מחוץ ל-Android Studio, מוסיפים נתיב לתלות בקובץ build.gradle או build.gradle.kts של האפליקציה. לדוגמה:

Groovy

dependencies {
    implementation fileTree(dir: "libs", include: ["*.jar", "*.aar"])
}

Kotlin

dependencies {
    implementation(fileTree(mapOf("dir" to "libs", "include" to listOf("*.jar", "*.aar"))))
}

מידע נוסף על הוספת יחסי תלות ב-Gradle זמין במאמר הוספת יחסי תלות ב-build.

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

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

כדי להצהיר על משאב ציבורי, מוסיפים הצהרת <public> לקובץ public.xml של הספרייה. אם לא הוספתם בעבר משאבים ציבוריים, אתם צריכים ליצור את הקובץ public.xml בספרייה res/values/ של הספרייה שלכם.

בדוגמת הקוד הבאה נוצרים שני משאבי מחרוזות ציבוריים עם השמות mylib_app_name ו-mylib_public_string:

<resources>
    <public name="mylib_app_name" type="string"/>
    <public name="mylib_public_string" type="string"/>
</resources>

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

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

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

כשיוצרים ספרייה, הפלאגין Android Gradle מקבל את ההגדרות של המשאבים הציבוריים ומחלץ אותן לקובץ public.txt, שנארז לאחר מכן בתוך קובץ ה-AAR.

שיקולים בפיתוח מודולים של ספריות

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

  • הספריות מוזגו לפי סדר העדיפות.

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

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

  • מניעת קונפליקטים במיזוג משאבים

    כלי ה-build ממזגים משאבים ממודול של ספרייה עם משאבים ממודול של אפליקציה שתלויה בספרייה. אם שם משאב מסוים מוגדר בשני המודולים, המערכת משתמשת במשאב מהאפליקציה.

    אם יש סתירות בין כמה ספריות AAR, המערכת משתמשת במשאב מהספרייה שמופיעה ראשונה ברשימת יחסי התלות (הכי קרוב לחלק העליון של הבלוק dependencies).

    כדי להימנע מקונפליקטים במשאבים, מומלץ להשתמש בקידומת או בסכמת שמות עקבית אחרת שייחודית למודול (או ייחודית בכל מודולי הפרויקט).

  • בגרסאות build של כמה מודולים, יחסי תלות ב-JAR נחשבים ליחסי תלות טרנזיטיביים.

    כשמוסיפים תלות JAR לפרויקט ספרייה שמפיק AAR, מודול הספרייה מעבד את ה-JAR ואורז אותו עם ה-AAR.

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

    צריך לפתור כל בעיה של התנגשות במשאבי Java שנגרמת בגלל תלות ב-JAR מקומי במודול האפליקציה שמשתמש בספרייה.

  • מודול ספרייה יכול להיות תלוי בספריית JAR חיצונית.

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

    שימו לב שגם מודול הספרייה וגם האפליקציה התלויה חייבים להצהיר על הספרייה החיצונית בקובצי המניפסט שלהם ברכיב <uses-library>.

  • הערך של minSdkVersion במודול האפליקציה צריך להיות שווה לגרסה שמוגדרת בספרייה או גדול ממנה.

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

  • כל מודול של ספרייה יוצר מחלקה משלו R.

    כשיוצרים את מודולי האפליקציה התלויים, מודולי הספרייה עוברים קומפילציה לקובץ AAR ואז מתווספים למודול האפליקציה. לכן, לכל ספרייה יש מחלקה משלה, שנקראת על שם שם החבילה של הספרייה.R

    המחלקות R שנוצרו מהמודול הראשי וממודול הספרייה נוצרות בכל החבילות הנדרשות, כולל החבילה של המודול הראשי והחבילות של הספריות.

  • מודול של ספרייה עשוי לכלול קובץ תצורה משלו של ProGuard.

    אם יש לכם פרויקט ספרייה שבו אתם משתמשים כדי ליצור ולפרסם AAR, אתם יכולים להוסיף קובץ הגדרות ProGuard להגדרות ה-build של הספרייה. אם כן, פלאגין Android Gradle יחיל את כללי ProGuard שציינתם. כלי ה-build מטמיעים את הקובץ הזה בקובץ ה-AAR שנוצר עבור מודול הספרייה. כשמוסיפים את הספרייה למודול של אפליקציה, קובץ ProGuard של הספרייה מצורף לקובץ ההגדרות של ProGuard ‏ (proguard.txt) של מודול האפליקציה.

    הטמעה של קובץ ProGuard במודול הספרייה עוזרת לוודא שמודולים של אפליקציות שתלויים בספרייה לא יצטרכו לעדכן ידנית את קובצי ProGuard כדי להשתמש בספרייה. כשמערכת ה-Build של Android Studio בונה את האפליקציה, היא משתמשת בהוראות ממודול האפליקציה ומהספרייה. לכן, אין צורך להפעיל כלי להקטנת קוד בספרייה בשלב נפרד.

    כדי להוסיף את כללי ProGuard לפרויקט הספרייה, מציינים את שם הקובץ באמצעות המאפיין consumerProguardFiles בתוך הבלוק defaultConfig של קובץ build.gradle או build.gradle.kts של הספרייה.

    לדוגמה, קטע הקוד הבא מגדיר את lib-proguard-rules.txt כקובץ התצורה של ProGuard בספרייה:

    Groovy

    android {
    defaultConfig {
        consumerProguardFiles 'lib-proguard-rules.txt'
    }
    ...
}

    Kotlin

    android {
    defaultConfig {
        consumerProguardFiles("lib-proguard-rules.txt")
    }
    ...
}

    עם זאת, אם מודול הספרייה הוא חלק מגרסת build מרובת מודולים שעוברת קומפילציה ל-APK ולא יוצרת AAR, צריך להפעיל את תהליך צמצום הקוד רק במודול האפליקציה שמשתמש בספרייה. מידע נוסף על כללי ProGuard ועל השימוש בהם זמין במאמר כיווץ, הסתרה ואופטימיזציה של האפליקציה.

  • בדיקה של מודול בספרייה דומה מאוד לבדיקה של אפליקציה.

    ההבדל העיקרי הוא שהספרייה והתלויות שלה נכללות באופן אוטומטי כתלויות של קובץ ה-APK של הבדיקה. כלומר, חבילת ה-APK של הבדיקה כוללת לא רק את הקוד שלה, אלא גם את קובץ ה-AAR של הספרייה ואת כל יחסי התלות שלה. מכיוון שאין אפליקציה נפרדת שנבדקת, המשימה androidTest מתקינה (ומסירה) רק את קובץ ה-APK של הבדיקה.

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

המבנה של קובץ AAR

סיומת הקובץ של קובץ AAR היא .aar, וסוג הפריט מידע שנוצר בתהליך פיתוח (Artifact) ב-Maven הוא aar. הקובץ עצמו הוא קובץ ZIP. הערך היחיד שחובה להזין הוא /AndroidManifest.xml.

קובץ AAR יכול לכלול גם אחת או יותר מהרשומות האופציונליות הבאות: