פלאגין של Secrets Gradle

מומלץ מאוד לא להכניס מפתח API למערכת בקרת הגרסאות. במקום זאת, כדאי לאחסן אותו בקובץ secrets.properties מקומי, שנמצא בספריית הבסיס של הפרויקט אבל לא נכלל בבקרת הגרסאות, ואז להשתמש ב-Secrets Gradle Plugin for Android כדי לקרוא את מפתח ה-API.

הפלאגין של Secrets Gradle ל-Android קורא סודות, כולל מפתח ה-API, מקובץ מאפיינים שלא נשמר במערכת לניהול גרסאות. הפלאגין חושף את המאפיינים האלה כמשתנים במחלקה BuildConfig שנוצרה על ידי Gradle ובקובץ המניפסט של Android.

דוגמה מלאה לשימוש בפלאגין Secrets Gradle ל-Android כדי לגשת למפתח API מופיעה במאמר הגדרת פרויקט ב-Android Studio.

התקנה ושימוש

כדי להתקין את הפלאגין Secrets Gradle ל-Android ולאחסן את מפתח ה-API:

  1. ב-Android Studio, פותחים את קובץ build.gradle ברמת הבסיס ומוסיפים את הקוד הבא לרכיב dependencies בקטע buildscript.

    Groovy

    buildscript {
    dependencies {
        // ...
        classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1"
    }
}

    Kotlin

    buildscript {
    dependencies {
        // ...
        classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
    }
}
  2. פותחים את הקובץ build.gradle ברמת האפליקציה ומוסיפים את הקוד הבא לרכיב plugins.

    Groovy

    plugins {
    id 'com.android.application'
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}

    Kotlin

    plugins {
    id("com.android.application")
    // ...
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}
  3. אם אתם משתמשים ב-Android Studio, מסנכרנים את הפרויקט עם Gradle.
  4. פותחים את local.properties בספרייה ברמת הפרויקט ומוסיפים את הקוד הבא. מחליפים את הערך YOUR_API_KEY במפתח ה-API שלכם. 
    PLACES_API_KEY=YOUR_API_KEY

המאמרים הבאים