[안드로이드 스튜디오]api키 숨기기

OPEN API를 사용하려면 우리는 API키를 발급받아야 한다. 

발급 받은 API키는 보안을 위해 꼭! 노출 시키지 않고 숨겨 주어야 한다.

 

1. gitignore

안드로이드 스튜디오 좌측 상단에 기본으로 android 로 선택되어 있다. 이것을 project로 변경해 준다.

그러면 gitignore파일을 발견할 수 있을 것이다. 

이 파일에 local.properties가 있어야 Git에 올라가지 않는다. 

나는 작업할때 직접 넣어주지 않아도 기본으로 입력되어 있으나 혹시 모르니 확인하자.

 

2. local.properties

이 파일에 API키를 작성해 준다.

my_api="발급받은 키"

 

3. Build.gradle(.app)

이곳에 아래 코드를 추가해줘야 한다.  

Properties properties = new Properties()
properties.load(project.rootProject.file('local.properties').newDataInputStream())

그리고 defaultConfig안에 아래 코드를 작성해 준다. 

buildConfigField "String", "키이름", properties['선언한 키 이름']

키이름을 가지고 키값이 필요할때 불러올 수 있다. 

plugins {
    .
    .
}

Properties properties = new Properties()
properties.load(project.rootProject.file('local.properties').newDataInputStream())

android {
    
    defaultConfig {
        .
        .
        
        buildConfigField "String", "MY_KEY", properties['my_api']
        .
        .

    }

이렇게 넣어주면 된다. 

 

세단계를 모두 마치면 키를 숨길 수 있다.

숨겨진 키 값을 변수 값에 넣어주고 싶을 때 

value =  BuildConfig.MY_KEY

이렇게 넣어주면 키를 가져올 수 있다.