[Swift] .xcconfig 파일로 api key 저장하기

728x90

react에서는 .env 파일로 api key와 같은 중요한 정보를 저장하는데, swift에서는 어떻게 하는지 궁금했다.

열심히 서치하던 중, .xcconfig 파일을 알게 되었다. 

 

.xcconfig가 뭔데?

Xcode Configuration의 줄임말로, 프로젝트의 다양한 설정을 코드처럼 텍스트 형식으로 관리할 수 있게 해준다.

이를 통해 여러 빌드 설정을 환경에 맞게 분리하고, 프로젝트 내의 설정을 효율적으로 관리할 수 있다.

 

 

어떻게 사용하는지 정리해보았다.

 

 

1. 파일 생성하기

먼저 이렇게 Configuration Setting File을 통해 .xcconfig 파일을 생성한다.

나는 Config.xcconfig로 이름을 지정해줬다.

 

 

그 다음,프로젝트에 해당 파일을 연결해야 한다.

프로젝트 -> Info -> Debug에서 프로젝트에 아까 생성한 파일을 눌러 연결해준다.

 

 

2. 프로젝트 세팅에 등록하기

프로젝트 Target -> Info -> Custom iOS Target Properties에서 아래 이미지와 같이 키와 값을 등록한다.

 

 

 

3. Config.xcconfig

1번에서 생성한 파일에 이렇게 필요한 변수들을 만들어준다.

string의 경우 ""로 감싸면 ""까지 url로 인식하기 때문에 "" 없이 등록하면 된다.

 

 

 

4. AppConfig.swift 파일 만들기

이제 우리가 만든 api key를 앱에 등록하는 과정까지 마쳤다.

여기에서는 코드로 연결해주는 부분이라 생각하면 된다.

// AppConfig.swift

import Foundation

let API_KEY_ENCODING = Bundle.main.infoDictionary?["API_KEY_ENCODING"] as? String ?? ""
let API_KEY_DECODING = Bundle.main.infoDictionary?["API_KEY_DECODING"] as? String ?? ""
let BASE_URL = Bundle.main.infoDictionary?["BASE_URL"] as? String ?? "api.odcloud.kr/api"

이렇게 bundle에 접근해서 각 키에 해당하는 value를 가져오는 것이다.

 

 

 

5. .ignore에 추가하기

.xcconfig 파일의 경우, 깃허브에 올라가면 다른 사람들도 해당 키를 찾을 수 있기 때문에 .ignore에 올려줘야 한다.

.gitignore 파일을 생성하고 다음 파일 확장자를 추가해주자.

*.xcconfig

 

 

 

 

6. github에 올리기 전, status를 통해 확인하기

ignore파일까지 만들고, 커밋을 하면 .xcconfig 파일이 같이 올라가는 경우가 있다. 이미 추가한 파일의 경우 따로 추가해줘야 하기 때문.

이럴 때는, 다음 명령어로 캐시를 삭제한다.

// git rm --cached -f {.xcconfig 파일 경로}
git rm --cached -f Config.xcconfig

 

그 다음, gitstatus를 통해 안올라가는지 다시 확인하고, commit, push 해주면 된다!!

 

 

 

7. 팀원들에게 공유하기

이렇게 하고 나니 팀원들에게 어떻게 공유할지 고민이 되었다.

이런 경우, config.example이라는 파일을 또 만들어 이 파일을 복제하고, 해당 파일에 각자의 apikey를 넣도록 전달하면 된다.

그래서 나는 PR을 올릴 때 팀원들에게 어떻게 하는지 방법을 적어서 올렸다.

 

필요한 사람은 마크다운 이대로 복사해서 깃헙에 같이 올려주면 된다 !

## 📌 .xcconfig 설정 방법
### 1️⃣ Config.xcconfig.example 파일을 복사해서 .xcconfig 파일 만들기
```
cp Config.xcconfig.example Config.xcconfig
```


### 2️⃣ .xcconfig 파일을 열어서 본인의 API 키와 설정을 입력하기

```// Config.xcconfig
API_KEY_ENCODING = 실제_API_키_입력
API_KEY_DECODING = 실제_API_키_입력
BASE_URL = https://실제_API_URL_입력
```

### 3️⃣ Xcode에서 .xcconfig 파일을 빌드 설정에 추가하기
Xcode → Project → Info → Configurations에서 Config.xcconfig를 설정


### 4️⃣ git status를 확인해서 .xcconfig가 Git에 올라가지 않는지 확인하기

 

 

 

 

8. (번외) 클린 아키텍처에서 어느 폴더에 넣어야할까?

우리 팀의 경우 클린 아키텍처를 적용하고 있기에 어느 폴더에 넣어야 할지 고민을 많이 했다.

여러 자료를 찾고, 다시 개념을 확인한 결과, Data 부분에 xcconfig 파일을 만들기로 했다.

 

Data 폴더는 가장 안쪽에 있는 계층으로, 외부 레이어에 해당하는 설정 파일을 보관하는 장소로 적합하다고 한다. (GPT가.)

예를 들어, 앱의 빌드 설정이나, API key 같은 내용을 Data 폴더에 두면 핵심 비즈니스 로직은 외부 환경에 영향을 받지 않고 독립적으로 개발할 수 있기 때문이라고..!

(사실 아직 맞는지 확신은 없다)

 

그래서 이렇게 폴더를 만들어서 아래와 같은 폴더 구조에 추가해주었다.