Android - API Key 숨기기 (local.properties 활용)

Android - API Key 숨기기 (local.properties 활용)

API Key를 넣을 때 Manfest에서 meta-data 태그 안에 입력한다.

그럴 경우 Github에 소스를 Public하게 Push 하게 되면 API Key가 노출되어 악용될 수 있다.

그러므로  API Key를 Manfest에서 직접 입력하지 않고 local.properties를 활용하여 Key를 숨기는 방법에 대해 설명한다.

 

★ Google에서 가이드한 내용이므로 믿고 따라와주길 바란다.

 

Secrets Gradle Plugin 설치

  1. 프로젝트 최상단에 위치한 build.grade 파일에 dependencies를 추가해준다.

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

 

  2. APP 수준 build.gradle 파일에서 plugin을 추가해준다.

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

 

 

local.properties 값 입력

  1. 프로젝트 최상단에 위치한 local.properties에 값을 입력한다.

apiKey=YOUR_API_KEY

 

 

local.properties 값 엑세스 하는 방법

 1. AndroidManifest.xml에서의 방법

   - ${key값}을 사용하면 local.properties에서 정의한 key의 value 값을 가져온다.

<meta-data android:value="${apiKey}" />

 

 2. 소스 상에서 사용법

  - BuildConfig를 활용한다.

val apiKey = BuildConfig.apiKey

---

Reference

https://developers.google.com/maps/documentation/android-sdk/secrets-gradle-plugin?hl=ko 

Secrets Gradle 플러그인  |  Android용 Maps SDK  |  Google Developers