🔒 API KEY 숨기기

이건 몰라서 안되는 ! 필수적으로 알아야 하는 상식 !

---

왜 숨겨야 하는거야? 🤔

api를 불러오거나 할 때 우리는 API KEY는 개발자만 사용하고 다른이나 사용자가 알아서는 안되기 때문에 깃헙에 commit에 api key가 남아있으면 절대로 안된다.

API KEY는 우리의 개인정보가 담겨있는 중요한 것

만약 프로젝트 개발에 임하는 사람들 이외의 타인이 알게 된다면, api를 누구나 사용이 가능해지고 이로 인해 최악의 경우에는 앱의 서비스를 종료해야 하는 경우도 발생하게 된다.

---

Commit 기록에 안남기는 방법

local-properties

local properties에 먼저 api 키를 등록해준다.

sdk.dir=C\:\\Users\\ASUS\\AppData\\Local\\Android\\Sdk
weather_api_key = "받아온 api 키 입력"

---

gitignore

gitignore에 local properties를 넣어서 깃헙에서 이를 무시하도록 설정해준다.

---

build.gradle(app)

app gradle에서 새로 등록한 키값을 불러와주고, 프로젝트에서 등록한 api를 사용하기 위한 타입 - 키 - 사용 형식으로 저장해주고 buildConfigField에 저장된 api를 불러와주면 된다.

plugins {
    id 'com.android.application'
    id 'org.jetbrains.kotlin.android'
    id 'com.google.gms.google-services'
    id 'kotlin-kapt'
    id 'kotlin-parcelize'
}
// 선언 및 키 값 불러오기
Properties properties = new Properties()
properties.load(project.rootProject.file('local.properties').newDataInputStream())
	...		// 이하
defaultConfig {
        applicationId "com.example.sansaninfo"
        minSdk 24
        targetSdk 33
        versionCode 1
        versionName "1.0"
        // 프로젝트에서 사용하기 위한 ( 타입 - 키 - 사용 ) 저장
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
        buildConfigField("String", "WEATHER_API_KEY", properties['weather_api_key'])
    }

---

BuildConfig

BuildConfig에 타입 - 키 - 사용 대로 저장이 잘 되어있는지 확인만 해주면 된다. 이렇게 하면 api가 프로젝트에 제대로 등록이 된 것이다.