Cómo almacenar claves api en Android usando Gradle

A menudo se usa claves de peticiones de API, si se quiere mantener a salvo las credenciales de consumo de APIS etc.., la mejor forma es usar propiedades de Gradle

Ocultar clave con BuildConfig

Primero, crear un archivo apikey.properties en eldirectorio raíz con formato clave valor

API_KEY=XXXXXXXXXXX
BANNER_ID=NNNNNNNNNN

A continuación, agregar en gradle dentro de app / build.gradle

def apikeyPropertiesFile = rootProject.file("apikey.properties")
def apikeyProperties = new Properties()
apikeyProperties.load(new FileInputStream(apikeyPropertiesFile))
 
android {

  defaultConfig {
     
    buildConfigField("String", "API_KEY", apikeyProperties['API_KEY'])
    buildConfigField("String", "BANNER_ID", apikeyProperties['BANNER_ID'])
  }
}

Su uso

Para obtener el valor asignado a los campos, se usa BuildConfig

BuildConfig.API_KEY //Para obtener el valor de API_KEY
BuildConfig.BANNER_ID//Para obtener el valor de BANNER_ID

Extra para Github

Para evitar que las claves aparezcan en su repositorio, asegúrese de excluir el archivo para que no se registre agregando a su archivo .gitignore: