[Swift] - .xcconfig 파일로 API KEY 숨기기

 

소셜 로그인 연동 구현하던 중 API KEY를 git에 노출시켜버려,,, git에 노출하지 않으면서 API KEY를 사용하는 방법에 대해 찾아보았다.

 

API KEY를 git에 노출시키지 않기 위한 방법을 알아보자.

 

 

1️⃣ .xcconfig 파일 만들기

 

 

Xcode에서 다음과 같이 새로운 파일을 만들어준다.

 

 

 

2️⃣ .xcconfig 파일 작성

 

 

Secrets.xcconfig 파일을 만들었고, 다음과 같이 KAKAO_APP_KEY 변수를 선언하여 key 값을 넣어준다.

 

 

 

3️⃣ .xcconfig 파일 변수 사용

 

 

Secrets.xcconfig 파일의 변수 KAKAO_API_KEY를 사용할 수 있도록 info.plist에 추가한다.

 

• Key 값: "KakaoAppKey"
• Value 값: $(KAKAO_APP_KEY)

 

 

만약 URL Types에서 작성한 변수를 사용하는 경우 $(변수)로 사용하면 된다.

 

 

 

4️⃣ .xcconfig 파일 프로젝트에 적용

 

 

Secrets.xcconfig 파일을 사용할 수 있도록 프로젝트 Info의 Configurations에 Secrets 파일을 적용해준다.

Configurations > debug(디버깅용), release(배포용)

 

 

 

코드에서 사용해보기

 

 

설정해놓은 api key를 가져와서 사용해보자.

다음과 같이 Info에서 설정한 key값으로 value값을 가져온다.

 

let kakaoAppKey = Bundle.main.infoDictionary?["KakaoAppKey"] as! String

 

 

5️⃣ .gitignore에 .xcconfig 파일 추가

 

 

다음 명령어로 .gitignore 파일을 만들어주고

 

vi .gitignore

 

 

.gitignore 파일 안에 .xcconfig 파일을 추가해준다.

 

# .gitignore 내부
*.xcconfig

 

❗️ 꼭 *를 붙여줘야 한다.

 

 

그 다음 .gitignore 파일을 먼저 추가해준다.

git add .gitignore 
git commit -m "gitignore 추가"
git push

 

 

.gitignore 파일 추가된 걸 확인 후 git status로 꼭 .xcconfig 파일이 추가되지 않은 걸 확인해야 한다.

 

git add .
git status // 확인 필수

 

 

✋ 만약 git status했는데 계속 .xcconfig 파일이 포함되어져 있다면?

 

다음 명령어로 git의 cache를 제거해주면 해결된다.

git rm -r --cached .