افزایه Secrets Gradle

‫Google اکیداً توصیه می‌کند که کلید API را در سیستم کنترل نسخه خود بررسی نکنید. به‌جای آن، آن را در فایل محلی secrets.properties ذخیره کنید که در دایرکتوری ریشه پروژه شما قرار دارد اما از کنترل نسخه مستثنا است، و سپس از Secrets Gradle Plugin for Android برای خواندن کلید API استفاده کنید.

«افزایه Secrets Gradle ویژه Android» رمزها، ازجمله کلید API، را از فایل دارایی که در سیستم کنترل نسخه بررسی نشده است می‌خواند. سپس افزایه آن مشخصه‌ها را به‌عنوان متغیر در کلاس BuildConfig تولیدشده با Gradle و در فایل مانیفست Android نمایان می‌کند.

برای مشاهده نمونه کامل استفاده از «افزایه Secrets Gradle ویژه Android» برای دسترسی به کلید میانای برنامه‌سازی کاربردی، راه‌اندازی پروژه «استودیو Android» را ببینید.

نصب و استفاده

برای نصب افزایه Secrets Gradle ویژه Android و ذخیره کلید میانای برنامه‌سازی کاربردی:

  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» استفاده می‌کنید، پروژه‌تان را با Gradle همگام‌سازی کنید.
  4. فایل local.properties را در فهرست سطح پروژه باز کنید، و سپس کد زیر را اضافه کنید. YOUR_API_KEY را با کلید میانای برنامه‌سازی کاربردی خود جایگزین کنید. 
    MAPS_API_KEY=YOUR_API_KEY
  5. در فایل 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 نام فراداده توصیه‌شده برای کلید API است. از کلیدی با این نام می‌توان برای اصالت‌سنجی در چندین میانای برنامه‌سازی کاربردی مبتنی بر Google Maps در پلاتفرم Android، ازجمله Maps SDK برای Android، استفاده کرد. برای سازگاری با نسخه قدیمی، این میانای برنامه‌سازی کاربردی از نام com.google.android.maps.v2.API_KEY نیز پشتیبانی می‌کند. این نام قدیمی فقط اصالت‌سنجی را برای Android Maps API v2 امکان‌پذیر می‌کند. برنامه می‌تواند فقط یکی از نام‌های فراداده کلید API را مشخص کند. اگر هر دو مشخص شده باشند، میانای برنامه‌سازی کاربردی استثنایی را ایجاد می‌کند.

قدم بعدی چیست