[iOS] static framework to xcframework, cocoapod 배포

A. 결론

1. 호스트 앱에서 static, dynamic 관계 없이 사용 가능
2. 호스트 앱에서 이미 a 라이브러리 사용하고 있는데 프레임워크에서도 a 사용해야 되면 충돌 없이 그냥 설치되어 있는 걸로 사용됨.
3. 프레임워크 자체는 xcframework이고 그 내부는 static library임.
4. 프레임워크 내부 소스코드 비공개, 그러나 내 PC에 해당 프레임워크 전체 소스 코드가 있다면 indexing이 되어있음. 만약 제3자가 프레임워크 내부 소스 코드 없이 pod으로 프레임워크만 받는다면 코드가 보이지 않음.
5. 체크해본 결과 가능한 것
   1. 종속성 사용 가능
   2. 키체인 가능
   3. UIKit 사용해서 vc, view … 등등 사용 가능
6. Bundle로 나가야 하는 xib, image 파일은 라이브러리로 배포 불가능.

 

테스트

종속성 사용 가능	UIKit 사용 가능
library에서 Alamofire(외부 라이브러리)를 사용하는 코드를 app project에서 사용한 모습.	ibrary에 있는 viewcontroller, uiview를 app project에서 불러와서 사용한 모습.

•  

 

B. 전체 과정

1. static library 만들기
2. 1에서 생성한 프로젝트에 pod을 통해 외부 종속성 설치
3. static library xcframework
4. 배포용 podspec 만들기
5. test 프로젝트에서 pod으로 설치 후 빌드 세팅 수정

 

C. 각 과정 상세 - 1, 2

File > New > Project > Static Library 선택

dynamic framework와 다르게 서명을 꼭 냅둘 필요 없음. static library에서는 서명 자체가 없음 왜냐하면 그 자체로 실행될 수 있는 코드가 아니고 특정 앱이나 모듈에 삽입되어서 실행되기 때문. (출처 : about static library code signing … | Apple Developer Forums ) 그러나 타겟 iOS 버전은 각 library → targets → Build Settings → iOS Deployment Target을 수정해주면 됨.

만든 프로젝트 창 닫고 해당 위치에서 터미널 open → pod init → vi PodSpec → 파일에 원하는 종속성 추가. Demo project에서는 pod 'Alamofire'를 추가해주었음. → pod install → 프로젝트명.xcworkspace 열기

그리고 여기서 코드 작성하면 되는데 pod으로 종속성 설치한 것을 import할 때 @_implementationOnly 키워드 붙여서 사용해주어야 함. (e.g. @_implementationOnly import Alamofire)

코드 작성이 완료 되었다면 xcframework로 만드는 3번 과정 수행하기 전에 빌드 클린해주고 ios, simulator로 각각 빌드해주어야 함.

 

D. 각 과정 상세 - 3

static library를 만든 위치에서 터미널 open 후 아래의 명령어 실행 (이전에 만든 xcframework가 있다면 build, derived_data 폴더 삭제 후 다시 실행)

// simulator 용 라이브러리 빌드 (생성 위치 : derived_data 폴더 하위)
xcodebuild build \\
  -scheme 프로젝트명 \\
  -derivedDataPath derived_data \\
  -arch x86_64 \\
  -sdk iphonesimulator \\
  -workspace 프로젝트명.xcworkspace \\
  BUILD_LIBRARY_FOR_DISTRIBUTION=YES

// 만들어진 걸 build 폴더 만들고 다시 복사-붙여넣기
mkdir -p build/simulators
cp -r derived_data/Build/Products/Debug-iphonesimulator/ build/simulators

// ios 용 라이브러리 빌드 (생성 위치 : derived_data 폴더 하위)
xcodebuild build \\
  -scheme 프로젝트명 \\
  -derivedDataPath derived_data \\
  -arch arm64 \\
  -sdk iphoneos \\
  -workspace 프로젝트명.xcworkspace \\
  BUILD_LIBRARY_FOR_DISTRIBUTION=YES

// 만들어진 걸 build 폴더 만들고 다시 복사-붙여넣기
mkdir -p build/devices
cp -r derived_data/Build/Products/Debug-iphoneos/ build/devices

// 복사된 library로 xcframework 빌드 (생성 위치 : build 폴더 하위)
xcodebuild -create-xcframework \\
    -library build/simulators/lib프로젝트명.a \\
    -library build/devices/lib프로젝트명.a \\
    -output build/프로젝트명.xcframework

 

E. 각 과정 상세 - 4

3에서 만들어진 프로젝트명.xcframework 폴더를 배포 관리를 위한 폴더로 이동. 이동한 폴더에서 cmd open → git init → git remote add origin 주소명 (배포를 위한 공개 repo git 주소) → touch 프로젝트명.podspec → 생성한 스펙 파일 오픈 후 아래 명령어 작성

Pod::Spec.new do |s|
    s.name         = "프로젝트명"
    s.version      = "버전" 
    # e.g. s.version = "0.1.0"
    s.summary      = "summary 작성"
    s.description  = <<-DESC
    Desc 작성
    DESC
    s.homepage     = "홈페이지 주소"
    s.license = { :type => 'Copyright', :text => <<-LICENSE
                   Copyright 2018
                   Permission is granted to...
                  LICENSE
                }
    s.author           = { 'name' => 'email' }
    # e.g. s.author = { '유저명' => '이메일' }
    s.source       = { :git => "repo git 주소", :tag => s.version.to_s }
    s.vendored_frameworks = "프로젝트명.xcframework"
    s.dependency '같이 깔려야 되는 라이브러리 이름'
    # e.g. s.dependency 'Alamofire'
    s.platform = :ios
    s.swift_version = "스위프트 버전"
    s.ios.deployment_target  = '13.0'
    s.static_framework = true
end

이후 아래 순서 따라서 깃 리포에 업로드해주면 됨. (현재 버전이 0.x.x라고 가정)

1. git add .
2. git commit "commit msg"
3. git tag 0.x.x
4. git push origin 현재_브랜치 tag 0.x.x

만약 새로운 xcframework를 만들고 업로드할 때는 해당 폴더에서 xcframework 이전 버전 것 지우고 새로운 폴더 넣어준 후 podspec에서 버전 업 시켜주고 위 1~4 명령어 다시 실행해서 업로드하면 됨.

 

F. 각 과정 상세 - 5

사용하려는 프로젝트에서 Podfile에 아래 문구 추가 (버전은 0.x.x라고 가정)

pod '프로젝트명', :git => "리포 주소", :tag => '0.x.x'

그리고 맨 아래 (end 뒤) 아래 코드 추가

post_install do |pi|
  pi.pods_project.targets.each do |t|
    t.build_configurations.each do |config|
      config.build_settings[‘BUILD_LIBRARY_FOR_DISTRIBUTION’] = ‘YES’
    end
  end
end

이 프로젝트의 Library Search Paths, Import Paths에 아래 항목 추가

$(SRCROOT)/Pods/프로젝트명/프로젝트명.xcframework/ios-x86_64-simulator
$(SRCROOT)/Pods/프로젝트명/프로젝트명.xcframework/ios-arm64

 

G. NAMSDK

→ NAMSDK의 GFPSDK도 static library를 사용 중

Specs/NAMSDK.podspec.json at master · CocoaPods/Specs

→ NAMSDK도 dependencies로 3rd party library인 KissXML을 사용하고 있음.

NAMSDK와 비교해서 지금 되지 않는 점 : 시뮬레이터로 빌드 시 찾지 못하는 점. Derived Data에 simulator 폴더 내 XCFrameworkIntermediates 폴더에 아카이빙이 되지 않음… 하지만 굳이 지금 찾지 않고 배포 때 찾아도 충분히 해결할 수 있을 것 같음.