[Android] Api key를 노출시키지 않고 안전하게 사용하는 방법

 

gradle을 사용하여 Api key를 소스 코드에 그대로 노출시키지 않고 안정하게 사용하는 방법입니다. 

1. gradle.properties 에 사용하려는 key 값을 정의합니다.

secure_api_key = "apiKey"

2. build.gradle(Module:app)에 해당 key를 빌드 모드 별로 지정합니다.

- release, debug 모드에 따라 사용할 key를 각각 입력합니다.

- buildConfigField로 정의한 key는 java/kotlin 코드에서 사용할 수 있습니다.

- resValue로 정의한 key는 xml에서 사용할 수 있습니다.

android {
	buildTypes {
		release {
			buildConfigField 'String', "API_KEY_NAME", secure_api_key
			resValue 'string', 'API_KEY_NAME', secure_api_key
		}
		debug {
        	buildConfigField 'String', "API_KEY_NAME", secure_api_key
			resValue 'string', 'API_KEY_NAME', secure_api_key
		}
	}
}

3. 호출 방법

3-1. buildConfigField 호출 방법

val key = BuildConfig.API_KEY_NAME

3-2. resValue 호출 방법

<TextView
	android:text="@string/API_KEY_NAME"
    .. />