Secrets Gradle eklentisi

Google, API anahtarını sürüm denetim sisteminize işlememenizi önemle tavsiye eder. Bunun yerine, anahtarı projenizin kök dizininde bulunan ancak sürüm denetiminden hariç tutulan yerel bir secrets.properties dosyasına kaydetmeniz ve ardından API anahtarını okumak için Android için Secrets Gradle eklentisini kullanmanız gerekir.

Android için Secrets Gradle Plugin, API anahtarı da dahil olmak üzere sırları, sürüm denetim sistemine işlenmemiş bir özellikler dosyasından okur. Eklenti daha sonra bu özellikleri Gradle tarafından oluşturulan BuildConfig sınıfında ve Android manifest dosyasında değişken olarak kullanıma sunar.

Bir API anahtarına erişmek için Android İçin Secrets Gradle Plugin'in kullanıldığı eksiksiz bir örnek için Android Studio projesi oluşturma başlıklı makaleyi inceleyin.

Yükleme ve kullanım

Android için Secrets Gradle Plugin'i yüklemek ve API anahtarınızı depolamak için:

  1. Android Studio'da, kök düzeyindeki build.gradle dosyanızı açın ve buildscript altındaki dependencies öğesine aşağıdaki kodu ekleyin.

    Modern

    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. Uygulama düzeyindeki build.gradle dosyanızı açın ve aşağıdaki kodu plugins öğesine ekleyin.

    Modern

    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 kullanıyorsanız projenizi Gradle ile senkronize edin.
  4. Proje düzeyindeki dizininizde local.properties dosyasını açın ve aşağıdaki kodu ekleyin. YOUR_API_KEY kısmını API anahtarınızla değiştirin.
    MAPS_API_KEY=YOUR_API_KEY
  5. AndroidManifest.xml dosyanızda com.google.android.geo.API_KEY bölümüne gidin ve android:value özelliğini aşağıdaki gibi güncelleyin:
    <meta-data
        android:name="com.google.android.geo.API_KEY"
        android:value="${MAPS_API_KEY}" />
        

    Not: API anahtarı için önerilen meta veri adı com.google.android.geo.API_KEY'dir. Bu ada sahip bir anahtar, Android platformundaki Android için Haritalar SDK'sı da dahil olmak üzere birden fazla Google Haritalar tabanlı API'de kimlik doğrulaması yapmak için kullanılabilir. API, geriye dönük uyumluluk için com.google.android.maps.v2.API_KEY adını da destekler. Bu eski ad yalnızca Android Maps API v2'de kimlik doğrulamasına izin verir. Bir uygulama yalnızca API anahtarı meta veri adlarından birini belirtebilir. Her ikisi de belirtilirse API bir istisna oluşturur.

Sırada ne var?