सीक्रेट ग्रेडल प्लग इन

Google का सुझाव है कि एपीआई पासकोड को वर्शन कंट्रोल सिस्टम में शामिल न करें. इसके बजाय, इसे स्थानीय secrets.properties फ़ाइल में सेव करें. यह फ़ाइल, आपके प्रोजेक्ट की रूट डायरेक्ट्री में मौजूद होती है, लेकिन इसे वर्शन कंट्रोल से बाहर रखा जाता है. इसके बाद, एपीआई पासकोड को पढ़ने के लिए, Android के लिए सीक्रेट ग्रेडल प्लग इन का इस्तेमाल करें.

Android के लिए सीक्रेट ग्रेडल प्लग इन, एपीआई पासकोड के साथ-साथ अन्य सीक्रेट भी पढ़ता है. ये सीक्रेट, प्रॉपर्टी फ़ाइल में मौजूद होते हैं. इस फ़ाइल को वर्शन कंट्रोल सिस्टम में शामिल नहीं किया जाता. इसके बाद, प्लग इन इन प्रॉपर्टी को, Gradle से जनरेट की गई BuildConfig क्लास और Android मेनिफ़ेस्ट फ़ाइल में वैरिएबल के तौर पर दिखाता है.

एपीआई पासकोड ऐक्सेस करने के लिए, Android के लिए सीक्रेट ग्रेडल प्लग इन का इस्तेमाल करने का पूरा उदाहरण देखने के लिए, Android Studio प्रोजेक्ट सेट अप करना लेख पढ़ें.

इंस्टॉल करना और इस्तेमाल करना

Android के लिए सीक्रेट ग्रेडल प्लग इन इंस्टॉल करने और एपीआई पासकोड सेव करने के लिए:

  1. Android Studio में, अपनी टॉप-लेवल build.gradle.kts या build.gradle फ़ाइल खोलें और plugins ब्लॉक में यह कोड जोड़ें.

    Kotlin

    plugins {
    // ...
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") version "2.0.1" apply false
}

    Groovy

    plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' version '2.0.1' apply false
}
  2. अपने मॉड्यूल-लेवल build.gradle.kts या build.gradle फ़ाइल खोलें और plugins एलिमेंट में यह कोड जोड़ें.

    Kotlin

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

    Groovy

    plugins {
    id 'com.android.application'
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}
  3. अगर Android Studio का इस्तेमाल किया जाता है, तो अपने प्रोजेक्ट को Gradle के साथ सिंक करें.
  4. अपनी टॉप-लेवल डायरेक्ट्री में मौजूद secrets.properties फ़ाइल खोलें. इसके बाद, यह कोड जोड़ें. YOUR_API_KEY को अपने एपीआई पासकोड से बदलें. पक्का करें कि आपने secrets.properties को अपनी .gitignore फ़ाइल में जोड़ा हो. इसके अलावा, इसे वर्शन कंट्रोल सिस्टम से बाहर रखें, ताकि एपीआई पासकोड को वर्शन कंट्रोल में शामिल न किया जा सके. 
    MAPS_API_KEY=YOUR_API_KEY

  5. अपनी टॉप-लेवल डायरेक्ट्री में local.defaults.properties फ़ाइल बनाएं. यह फ़ाइल, secrets.properties फ़ाइल वाले फ़ोल्डर में होनी चाहिए. इसके बाद, यह कोड जोड़ें.

    MAPS_API_KEY=DEFAULT_API_KEY

    इस फ़ाइल का मकसद, एपीआई पासकोड के लिए बैकअप की जगह उपलब्ध कराना है. ऐसा इसलिए, ताकि अगर secrets.properties फ़ाइल न मिले, तो बिल्ड प्रोसेस में कोई गड़बड़ी न हो. ऐसा तब हो सकता है, जब आपने किसी वर्शन कंट्रोल सिस्टम से ऐप्लिकेशन को क्लोन किया हो. इस सिस्टम में secrets.properties फ़ाइल शामिल नहीं होती. साथ ही, आपने एपीआई पासकोड उपलब्ध कराने के लिए, स्थानीय तौर पर secrets.properties फ़ाइल न बनाई हो.

  6. अपनी AndroidManifest.xml फ़ाइल में, com.google.android.geo.API_KEY पर जाएं और android:value एट्रिब्यूट को इस तरह अपडेट करें: 
    <meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="${MAPS_API_KEY}" />

    ध्यान दें: एपीआई पासकोड के लिए, com.google.android.geo.API_KEY नाम के मेटाडेटा का इस्तेमाल करने का सुझाव दिया जाता है. इस नाम के पासकोड का इस्तेमाल, Android प्लैटफ़ॉर्म पर Google Maps पर आधारित कई एपीआई के लिए पुष्टि करने के लिए किया जा सकता है. इनमें Android के लिए Maps SDK भी शामिल है. पिछली सुविधाओं के साथ काम करने के लिए, एपीआई, com.google.android.maps.v2.API_KEY नाम का भी इस्तेमाल करता है. इस पुराने नाम से, सिर्फ़ Android Maps API v2 के लिए पुष्टि की जा सकती है. कोई ऐप्लिकेशन, एपीआई पासकोड के मेटाडेटा के नामों में से सिर्फ़ एक नाम तय कर सकता है. अगर दोनों नाम तय किए जाते हैं, तो एपीआई में गड़बड़ी की जानकारी मिलती है.

  7. Android Studio में, अपने मॉड्यूल-लेवल build.gradle.kts या build.gradle फ़ाइल खोलें और secrets प्रॉपर्टी में बदलाव करें. अगर secrets प्रॉपर्टी मौजूद नहीं है, तो इसे जोड़ें.

    प्लग्इन की प्रॉपर्टी में बदलाव करें, ताकि propertiesFileName को "secrets.properties", defaultPropertiesFileName को "local.defaults.properties", और अन्य प्रॉपर्टी को सेट किया जा सके.

    Kotlin

    secrets {
    // To add your Maps API key to this project:
    // 1. If the secrets.properties file does not exist, create it in the root directory (the same folder as the root local.properties file).
    // 2. Add this line, where YOUR_API_KEY is your API key:
    //        MAPS_API_KEY=YOUR_API_KEY
    propertiesFileName = "secrets.properties"

    // A properties file containing default secret values. This file can be
    // checked in version control.
    defaultPropertiesFileName = "local.defaults.properties"
}

    Groovy

    secrets {
    // To add your Maps API key to this project:
    // 1. If the secrets.properties file does not exist, create it in the root directory (the same folder as the root local.properties file).
    // 2. Add this line, where YOUR_API_KEY is your API key:
    //        MAPS_API_KEY=YOUR_API_KEY
    propertiesFileName = "secrets.properties"

    // A properties file containing default secret values. This file can be
    // checked in version control.
    defaultPropertiesFileName = "local.defaults.properties"
}

आगे क्या करना है