Xcode :: CocoaPods(코코아팟) 설치/삭제 및 사용법 (Podfile 만들기, Podfile 문법/버전관리, Podfile.lock)

 

💡 Before You Read

CocoaPods 공식문서

https://cocoapods.org/

현재 CocoaPods에서 사용할 수 있는 Pods들의 종류와 버전들을 모두 확인할 수 있고 Guides에서 설치 및 사용 방법을 영문으로 자세하게 확인할 수 있다.

 

CocoaPods(코코아팟) 이란?

CocoaPods is a dependency manager for Swift and Objective-C Cocoa projects. It has over 79 thousand libraries and is used in over 3 million apps. CocoaPods can help you scale your projects elegantly.

Swift와 Objectivc-C Cocoa 프로젝트를 위한 Dependency Manager(의존성 관리자, 패키지 관리자)이다. 2020년 12월 기준, 79,000개 이상의 라이브러리들이 3백만 개의 앱들에서 사용되고 있다. 공식 사이트 설명에 의하면, 코코아팟을 통해 프로젝트를 우아하게 확장할 수 있다고 한다.

 

---

 

iOS 프로젝트에서 빠질 수 없는 CocoaPods!
주말을 이용해 사용하고 있는 Pods 스펙들을 제대로 살펴볼 겸 기본적인 것들을 정리해본다.

INDEX

Xcode Project에 CocoaPods 코코아팟 설치하는 방법
Podfile.lock 알아보기
Pod 버전 관리하기
Pod Commands 종류 (Pod Install / Update / Outdated)

 

 Xcode Project에 CocoaPods 코코아팟 설치하는 방법 

Step1. Terminal을 열어 Xcode 파일이 있는 디렉토리로 이동한다.

 

 

Step2. Terminal에서 아래 명령어를 실행한다.

CocoaPods 코코아팟은 Ruby로 만들어졌는데, MacOS의 경우 the default Ruby가 이미 설치되어 있기 때문에 별도 설치 작업이 필요하지 않다.

$ sudo gem install cocoapods // 설치 끝!

 

Step3. Terminal에서 아래 명령어를 실행해 Podfile을 생성한다.

Install 자체는 해당 디렉토리에서 하지 않아도 되지만, pod init 실행은 꼭 Xcode 해당 디렉토리 위치에서 진행해야 한다.

$ pod init // Podfile 생성을 위한 명령어

 

Step4. 생성된 Podfile을 열어 필요한 Pods을 추가한다!

[참고] Podfile Syntax Reference (Podfile 문법)
https://guides.cocoapods.org/syntax/podfile.html#podfile

(1) Podfile 여는 방법은 다양하지만, 개인적으로 vim이 편해서 vim을 이용했다. (nano, vi 등 방법은 다양!)

$ vim podfile // Podfile에 Pods 추가하기

 

(2) vim으로 열면 아래처럼 기본 Podfile이 뜰텐데 'I'를 눌러 Insert 모드로 수정을 하면 된다.

'*Tests' Project를 생성하지 않았다면 기본 Podfile에도 stayHomeTests와 같은 Target이 없을 것이다.
생성 후에 크게 쓰지 않는다면 Pod을 굳이 추가하지 않아도 된다.

첫번째 줄엔 지원하는 플랫폼의 최소 버전을 적으면 된다.
기본 podfile에 이미 적혀있으니 주석(#)을 빼고 버전만 수정하면 된다.

platform :ios, '13.0' // SwiftUI와 Combine의 최소 버전은 iOS 13.0이다.

그 아래에는 해당 앱(target)에 사용할 pod 이름들을 열거하면 된다.

target 'stayHome' do
  pod '$PODNAME1'
  pod '$PODNAME2'
  pod '$PODNAME3'
end

 

(3) 수정이 완료되면 'esc'를 눌러 Insert 모드에서 나오고, ':wq' (=저장 후 종료)를 작성한 뒤 엔터를 쳐서 빠져나오면 된다.

필요없는 주석이나 기존 Podfile에 있던 comment들은 지우고 필요한 부분만 남겨두자.

 

Step5. 아래 명령어를 실행해 Xcode에 Podfile 속 Pods을 설치한다.

$ pod install

 

Pod installation complete! There are 2 dependencies from the Podfile and 2 total pods installed.
= 성공적으로 설치가 되어부렀다!

[!] Please close any current Xcode sessions and use `stayHome.xcworkspace` for this project from now on.
= 현재 Xcode가 켜져 있다면 끄고, 앞으로는 stayHome.xcworkspace 프로젝트를 사용혀라!

두둔! 디렉토리에 xcworkspace 확장자의 파일이 새롭게 생겨났다!
이 파일에 우리가 Podfile에 적어둔 Pods이 설치되어있으니 앞으로 이 파일로 작업을 하면 된다.
끝! 한 번 쭈욱- 따라 해보면 꽤 쉽다.

 

 [참고] 반대로 Pod을 삭제하고 싶다면? 

1. vim podfile 로 podfile 열고 insert 모드 켜기
2. 삭제하고 싶은 pod 삭제 후 :wq
3. pod install

- 삭제 끝 -

 

 

---

 

Podfile.lock 알아보기

 

Pod을 Xcode에 설치하면 (pod install) podfile.lock 파일도 함께 생성이 된 걸 볼 수 있다.
vim 으로 열어보면 아래처럼 작성되어 있는데 pod 이름 옆에 숫자가 써있는 게 보인다.
유추할 수 있듯이, 숫자는 각 Pod들의 버전이다.

Podfile.lock 파일은 설치된 모든 Pod 라이브러리들의 버전을 snapshot 처럼 기록해 관리하는 파일이다.
pod install을 하게 되면, Podfile에 적힌 Pod들은 Podfile.lock에 적힌 버전으로 install이 된다.
팀 단위로 Project를 진행할 때 서로의 Pods Version Sync를 맞춰주는 중요한 역할을 한다.

Q. Podfile을 작성할 땐 버전을 따로 적지 않았는데, Podfile.lock에는 어떻게 버전이 적혀있지?
A. 버전을 생략해서 Podfile을 작성하면, 최신 버전으로 설치된다.

Q. 오호, 그렇다면 특정 Pod의 버전을 고정하고 싶으면 Podfile.lock 문서를 수정하면 되겠네?
A. 에헤이! 큰일날 소리. Podfile을 수정해야지!
Podfile.lock은 현재 프로젝트에서 사용 중인 Pod Version들을 기록한 Snapshot일 뿐, 버전을 명시하고 싶다면 Podfile을 수정해야한다.

Q. 어떻게?
A. 이렇게!

 

Pod 버전 관리하기

Step1. Podfile을 열고, 각 Pod 옆에 버전을 써준다.

필요하다면 operator도 함께 써준다. 현재 릴리즈 된 latest 버전을 설치하고 싶다면 굳이 버전 명시를 하지 않아도 된다.

 

[참고] Pod Versions Operators
https://guides.cocoapods.org/using/the-podfile.html

 

#예시
'> 0.1' // 0.1 초과 version 중 lastest version
'>= 0.1' // 0.1 이상 version 중 lastest version
'< 0.1' // 0.1 미만 version 중 lastest version
'<= 0.1' // 0.1 이하 version 중 lastest version
'= 0.1' // 0.1 version (생략가능)
'~> 0.1.2' // 0.1.2 <= lastest version < 0.2.0
'~> 0.1' // 0.1 <= lastest version < 1.0
'~> 0' // 0 <= lastest version < 1.0

 

Step2. pod install을 실행해 Pod을 설치하고, Podfile.lock을 확인해본다.

---

 

Pod Commands 종류

1. $ pod install

- podfile에 적힌 pod을 podfile.lock의 version에 맞춰 설치한다. 새로운 버전이 나왔는지는 체크하지 않는다.
- 최초 설치 시에는 podfile.lock 파일이 없기 때문에 podfile에 명시되어 있는대로 설치한다.
- Podfile을 수정하면 반드시 pod update가 아닌 pod install을 실행해야 한다.

 

2. $ pod update ({PodName})

- podfile.lock에 적힌 버전을 고려하지 않고, podfile에 작성한 버전 조건에 맞춰 최신 버전으로 업데이트 한다.
- 업데이트되면 자동으로 podfile.lock도 수정된다.
- version을 업데이트 해야하는 상황 외에는 쓰지 않는다.

 

3. $ pod outdated

- pod update 실행 시, pod 변동사항들을 리스트업해서 사전에 알려준다.

---

 

'코코아'가 아직 낯선 분들에게 도움이 되는 글이었으면 한다.

왜 쓰는지, 어떻게 쓰는지에 대해 자세히 알게되면
유용한 라이브러리(Pod)들을 익히는데에 꽤 도움이 될 것이다.

끗!