[iOS] Swift Package Manager (SPM)

Swift Package Manager란?

Swift Package Manager는 소스 코드 배포를 관리하기 위한 도구로, 코드를 쉽게 공유하고 다른 사람의 코드를 재사용할 수 있도록 지원합니다. 이 도구는 Swift 패키지 컴파일 및 연결, 종속성 관리, 버전 관리, 유연한 배포 및 협업 모델 지원 등의 문제를 해결합니다.

Github와 같은 서비스에서 패키지를 쉽게 공유할 수 있도록 설계되었습니다. 뿐만 아니라 패키지는 개인 개발, 팀 내 코드 공유 또는 기타 세분화된 수준에서도 유용하게 사용할 수 있습니다.

About Packages

패키지는 Package.swift manifest 파일을 포함한 Swift 소스 파일로 구성되어있습니다. manifest file (혹은 package manifest)은 PackageDescription 모듈을 사용하여 패키지의 이름과 내용을 정의합니다. 패키지에는 1개 이상의 타겟이 있습니다. 각 타겟은 product를 지정하고, 하나 이상의 종속성을 선언할 수 있습니다.

About Modules

Swift는 코드를 모듈로 구성합니다. 각 모듈은 네임스페이스를 지정하고 해당 모듈 외부에서 해당 코드의 어떤 부분을 사용할 수 있는지에 대한 접근 제어를 적용합니다.

프로그램은 모든 코드를 단일 모듈에 포함할 수도 있고, 다른 모듈을 dependencies로 import 할 수도 있습니다. OS X의 Darwin이나 Linux의 GLibc와 같이 시스템에서 제공하는 소수의 모듈을 제외하고, 대부분의 dependencies는 코드를 다운로드하여 빌드해야 사용할 수 있습니다.

특정 문제를 해결하는 코드를 별도의 모듈로 추출하면 해당 코드를 재사용할 수 있습니다. 예를 들면, 네트워크 요청 기능을 제공하는 모듈을 여러 프로그램 간에 공유할 수 있습니다. 만약 더 나은 기능을 제공하는 모듈이 등장하면, 최소한의 변경만으로 쉽게 고체할 수 있습니다. 모듈화를 수용하면, 도중에 마주치는 문제 해결에 얽매이지 않고 당면한 문제의 흥미로운 측면에 집중할 수 있습니다.

Building Swift Modules

Swift Package Manager와 빌드 시스템은 소스 코드를 컴파일하는 방법을 이해해야 합니다. 이를 위해 파일 시스템에서 소스 코드의 organization을 사용하여 의미를 파악하는 규칙 기반 접근 방식을 사용하지만, 이러한 세부 사항을 완전히 재정의하고 커스터마이징할 수 있습니다. 간단한 예를 들면 다음과 같습니다.

foo/Package.swift
foo/Sources/main.swift

여기서 Package.swift는 패키지에 대한 metadata를 포함하는 매니페스트 파일입니다.

foo 디렉토리에서 swift build 명령어를 실행하면, Swift는 foo라고 불리는 실행 가능한 파일을 빌드할 것입니다.

패키지 관리자에게는 모든 것이 패키지이므로, Package.swift입니다. 하지만 그렇다고 해서 소프트웨어를 더 넓은 세상에 공개해야 한다는 의미는 아니며, 다른 사람이 보거나 사용할 수 있는 곳에 게시하지 않고도 앱을 개발할 수 있습니다. 반면, 더 많은 사람들이 프로젝트를 사용할 수 있어야 한다고 결정한다면, 소스는 이미 게시할 수 있는 형태로 준비되어있습니다. 패키지 매니저는 특정 배포 형태에 구애받지 않으므로, 개인 프로젝트, 워크 그룹, 팀 또는 회사 내에서 또는 전 세계의 코드를 공유하는 데 사용할 수 있습니다.

물론 패키지 매니저는 자체 빌드에 사용되므로 자체 소스 파일도 이러한 규칙에 따라 배치됩니다.

About Products

타겟은 라이브러리 또는 실행 파일을 product로 빌드할 수 있습니다. 라이브러리는 다른 Swift 코드에서 import할 수 있는 모듈이 포함되어있습니다. 실행 파일은 운영체제에서 실행할 수 있는 프로그램입니다.

About Dependencies

모던 개발은 (좋은 의미던 나쁜 의미던) 외부 종속성을 사용함으로써 가속화됩니다. 이는 짧은 시간에 더 많은 작업을 완료할 수 있다는 장점이 있지만, 프로젝트에 종속성을 추가하는 데는 관련 조정 비용이 발생합니다.

디펜던시에 대한 소스 코드를 다운로드하고 빌드하는 것 외에도 전체 디펜던시 그래프가 만족될 때까지 해당 디펜던시 자체의 디펜던시도 다운로드하고 빌드해야 합니다. 문제를 더욱 복잡하게 만들기 위해 디펜던시가 버전 요구사항을 지정할 수 있으며, 이는 동일한 디펜던시를 갖는 모듈의 버전 요구사항과 일치해야 할 수 있습니다.

패키지 매니저의 역할은 프로젝트의 모든 디펜던시를 다운로드하고 구축하는 프로세스를 자동화하고 코드 재사용과 관련된 조정 비용을 최소화하는 것입니다.

Depedencies는 Package.swift 매니페스트 파일에 지정됩니다.

Dependency Hell

“Dependency Hell”은 프로젝트에 필요한 디펜던시 그래프를 충족할 수 없는 상황을 구어체로 표현한 것입니다. 사용자가 시나리오를 해결해야 하는데, 이는 보통 어려운 작업입니다.

1. 충돌은 사용자가 명시적으로 요청하지 않은 익숙하지 않은 디펜던시 (또는 디펜던시 내에서)에서 발생할 수 있습니다.
2. 개발 특성 상, 2개의 디펜던시 그래프가 동일한 경우는 드뭅니다. 따라서 다른 사용자 (종종 패키지 작성자)가 제공할 수 있는 도움은 한정적이기 때문에, 인터넷 검색이 무의미할 가능성이 높습니다.

좋은 패키지 매니저는 처음부터 dependency hell의 위험을 최소화하도록 설계되어야 하며, 이것이 불가능할 경우 이를 완화하고 사용자가 최소한의 문제만으로 시나리오를 해결할 수 있도록 도구를 제공해야 합니다. 패키지 매니저 커뮤니티 제안서에는 이러한 지옥을 염두에 두고 어떻게 반복 작업을 수행할 것인지에 대한 것이 담겨있습니다.

다음은 가장 일반적인 “dependency hell” 시나리오들입니다.

• 부적절한 버전 지정
  • 패키지가 배포에 부적절한 버전을 지정할 수 있습니다.
• 호환되지 않는 major 버전 요구사항
  • 패키지의 동일한 패키지에 대해 호환되지 않는 버전 요구사항을 가진 디펜던시가 있을 수 있습니다.
  • ex) Foo가 Baz 버전에 의존한다고 가정할 때, Foo는 ~> 1.0 버전의 Baz에, Baz는 ~> 2.0 Baz 버전에 의존할 경우, 두 요구 사항을 모두 만족시킬 수 있는 Baz 버전은 없습니다. 이런 상황은 여러 패키지가 공유하는 디펜던시가 새로운 major 버전으로 업데이트되고, 모든 패키지가 디펜던시를 업데이트하는 데 오랜 시간이 걸리는 경우에 자주 발생합니다.
• 호환되지 않는 minor 또는 update 버전 요구사항
  • 패키지에 엄격하게 지정된 디펜던시가 있어서 버전 요구사항이 다른 minor 또는 update 버전과 호환되지 않을 수 있습니다.
  • ex) Foo가 Baz 버전 2.0.1에 의존하고, Bar는 Baz 버전 2.0.2에 의존하는 경우, 두 요구사항을 모두 충족할 수 있는 Baz 버전은 없습니다. 이는 디펜던시의 patch release에서 회귀가 발생하여 패키지가 해당 디펜던시를 특정 버전에 잠그는 결과로 나타나는 경우가 많습니다.
• 네임스페이스 충돌
  • 패키지에 이름이 같은 디펜던시가 2개 이상 있을 수 있습니다. 예를 들어 Person 패키지는 사람에게 우편 주소를 할당하는 프로토콜을 정의하는 Addressable 패키지와 다른 사람에게 공식적으로 말하기 위한 프로토콜을 정의하는 Addressable 패키지에 의존합니다.
• 손상된 소프트웨어
  • 패키지에 사용성, 보안 또는 성능에 영향을 미치는 버그가 있는 디펜던시가 있을 수 있습니다. 이는 단순히 패키지 매니저의 적시성 문제일 수도 있고, 패키지에 대한 기대치에 대한 비동의일 수도 있습니다.
• 전역 상태 충돌
  • 패키지에 동일한 전역 상태에 대한 독점 접근 권한을 가진 것으로 추정되는 디펜던시가 2개 이상 있을 수 있습니다.
  • ex) 한 패키지가 특정 파일 경로에서 읽는 동안, 특정 파일 경로에 쓰는 다른 패키지를 수용하지 못할 수 있습니다.
• 패키지를 사용할 수 없게 됨
  • 사용할 수 없게 된 패키지에 대한 디펜던시가 있을 수 있습니다. 이는 소스 URL에 접근할 수 없거나 관리자가 게시된 버전을 삭제하여 발생할 수 있습니다.

Reference

https://github.com/apple/swift-package-manager/blob/main/Documentation/README.md