Android Kotlin API 키 관리

Android 프로젝트에서 API키를 안전하게 관리하기

왜 API키를 안전하게 관리해야 하는가?

API 키가 노출될 경우 , 악의적인 사용자가 해당 키를 사용하여 API 사용량을 급격히 증가시킬 수 있습니다. 이로 인해 추가 비용이 발생하거나 , 서비스의 제한적인 API 사용량을 초과하게 되면 정상적인 사용자도 서비스를 이용할 수 없게 될 수 있습니다.

• 안드로이드 프로젝트에서 API키와 같은 민감한 정보를 안전하게 관리하는 방법을 알아봅니다.

1. loval.properties에 키 저장

프로젝트의 local.properties파일에 API키를 추가 합니다. 이 파일은 VCS에 포함되지 않아야 하므로 .gitignore에 반드시 추가해야 합니다.

KAKAO_API_KEY=""
SK_OPEN_API_KEY=""
TOUR_API_KEY="YOUR_API_KEY_HERE"

2. build.gradle에서 키 사용

build.gradle에서 buildConfigField를 사용하여 local.properties에서 읽은 키를 BuildConfig에 추가합니다.

android {
    defaultConfig {
        buildConfigField "String", "TOUR_API_KEY", properties['TOUR_API_KEY']
    }
}

3. 코드에서 키 사용

앱 코드에서는 BuildConfig.Tour.API_KEY를 통해 API키에 접근할 수 있습니다.