[iOS] Swift Static Framework 만들기(Universal) - 1. 삽질 구간

[iOS] Swift Static Library 만들기(Device, Simulator)

지난번에 Static Library를 만들면서 빌드할 Device가 바뀔 때마다(on device/simulator) library 파일 바꿔줘야하는 문제점을 발견했다.

몇주의 삽질 끝에 결국 framework를 사용하기로 했다!

 

당장 어떻게 만드는지가 궁금하다면 바로 다음글로 넘어가자!

 

제대로 시작하기 전에 삽질 구간에 대해 알아보자.

1. Static Library(.a file) 의 Target architecture를 합쳐보자

첫번째 시도는 두 Library file의 Merge 시키는 거였다. 그러다가 lipo command를 알게되었다.

lipo가 뭔지 man page를 보자

NAME
       lipo - create or operate on universal files

...

DESCRIPTION
       The lipo tool creates or operates on ``universal'' (multi-architecture)
       files. Generally, lipo reads a single input file and writes to a single
       output file, although some commands and options accept multiple input
       files.  lipo will only ever write to a single output file, and input
       files are never modified in place.

       lipo supports a number of commands for creating universal files from
       single-architecture files, extracting single-architecture files from
       universal files, and displaying architecture information.  lipo can only
       perform one such command at a time, although some command flags may
       appear more than once. Some commands support additional options that can
       be used with that command. In addition, there are global options that are
       supported by multiple commands.

...

universal file을 생성한다. -> 문제가 되었던 Intel architecture와 apple silicon architecture를 합칠 수 있다??

결론부터보면 가능하지만, 우리의 문제를 해결해줄 수는 없다!

 

실제로 해당 command로 두 architecture를 합칠 수는 있었으나 문제점은 다음과 같았다.

각 Library file이 가지는 architecture는 다음과 같다.

simulator architecture -> x86_64, arm64 architecture

device architecture -> arm64 architecture

 

이 상태로 바로 lipo를 통해 합쳐보자!

% lipo -create libStaticLibrary-iphoneos.a libStaticLibrary-iphonesimulator.a -output libStaticLibrary.a

결과는 다음과 같다.

fatal error: /Library/Developer/CommandLineTools/usr/bin/lipo: libStaticLibrary-iphoneos.a and libStaticLibrary-iphonesimulator.a have the same architectures (arm64) and can't be in the same fat output file

같은 architecture가 있다는 이유로 합쳐지지 않았다.

 

이러한 문제가 생긴 이유는 M1 CPU가 세상에 나오기 전까지만 해도

simulator architecture -> x86_64 architecture

device architecture -> arm64 architecture

이러한 단일 architecture 구조였기에 합쳐지는게 가능했지만 지금은 할 수 없다!

 

1번 방법은 실패했다.

 

2. simulator에서 arm64 architecture를 뺀다면?

뺄 수 있다. 1번처럼 library를 빌드해서 합치는 것이 아니라 조금 특수한 방법을 사용해야한다.

Aggregate

프로젝트 Target에 Aggregate를 추가하고, Build Phases에 Run Script를 추가해준다.

실제로 Universal Library에 대해 구글링을 해보면 몇가지 Script가 나오는데 여기서 신경쓸 부분은 Simulator에서 특정 architecture(x86_64)를 선택해서 build한다는 것이다.

# Build for simulator
xcodebuild -target $LIB_NAME -configuration ${CONFIGURATION} -sdk iphonesimulator -arch x86_64 BUILD_DIR="${BUILD_DIR}" BUILD_ROOT="${BUILD_ROOT}"

# Build for device
xcodebuild -target $LIB_NAME ONLY_ACTIVE_ARCH=NO -configuration ${CONFIGURATION} -sdk iphoneos  BUILD_DIR="${BUILD_DIR}" BUILD_ROOT="${BUILD_ROOT}"

예시 Script 출처: https://betterprogramming.pub/create-a-swift-5-static-library-part-2-8bea54bb0b9e

이렇게 하면 두 library 파일을 합칠 수 있게 되는데, 여기서의 문제는!

Simulator에서 build 시에 arm64 architecture를 찾게 된다.

이유는? Simulator 빌드하는 내 Mac이 M1 CPU니까~~ ㅎㅎ

물론 Intel CPU에서 빌드가 가능한지 확인은 못했지만, 확인과 별개로 결국 환경이 나뉜다면 의미가 없다고 생각했다.

 

그렇게 2번 방법도 실패.

 

3. 결국 합치는걸 포기

GitHub - moonjs0113/iOS-Static-Library-Example: iOS Static Library/Framework를 만들어보는 프로젝트입니다.

삽질 당시의 상황을 정리한 README다.

애플 아카데미 시니어 멘토이신 링고스타님께서 아이디어를 주셨다.

 

방법은 이렇다.

1) 두 가지 타켓으로 빌드를 한다.(Simulator, Device)

2) 프로젝트 폴더 경로에 폴더를 만들고 해당 폴더에서 경로를 달리하여 바이너리 파일을 넣는다.

3) 프로젝트에서 Simulator와 Device용 Scheme를 만들고, Build Configuration을 하나는 Debug, 다른 하나는 Release로 놓는다.

4) 이제 Build Settings에서 Library Search Paths와 Import Paths의 Debug와 Release 값을 각각에 맞게 설정한다.

(Debug-Simulator, Release-Device라면, Debug에는 Device용 Library의 경로를 Release에는 Simulator용 Library의 경로를)

5) Mach-O 설정을 Static Library로 바꿔준다.

 

그럼 파일을 매번 바꾸지 않아도, Simulator와 Device에 따라 Scheme만 선택해서 빌드하면 된다!

심지어는 프로젝트에 Library File을 직접 Import하지 않아도 된다!

 

해당 방법은 실패라기 보다는 단점이 컸다.

1) 프로젝트에 Import 되지 않으니 자동완성을 지원하지 못한다.

2) Mach-O의 설정을 바꿨을 때의 Side-Effect를 알지 못한다.

 

모든 걸 다 알고 사용하지는 않지만, 해당 방법은 느낌이 안 왔다고나 할까...

암튼 3번은 패스~

 

4. Framework는 조금 다르지 않을까?

끝에는 Static Library에서 Framework로 눈을 돌려봤다.

애초에 Static Binary 형태로 코드를 숨기면서 모든 빌드 타켓에 대해 만족하는게 목표였기 때문에 Library나 Framework나 상관이 없었다.

 

결과적으론 Framework도 library와 같은 결과다.

architecture를 못찾거나, 합치려고 할때 중복이 생긴다.

 

4번도 실패였다.

 

5. XCFramework??

가 궁금하다면 다음 글을 보자!