iOS开发进阶六:lipo指令和XCFramework
背景:XCFramework
之前的多架构合并
我们生成一个库文件,可能有模拟器的架构,也可能有真机的架构。但我们通常给别人提供SDK的时候都是将各种平台架构的库合在一起。引入一个库文件,就可以支持调试和在真机上运行。这种格式的库我们通常叫他Fat Binary(胖二进制)
。
xcodebuild指令
xcodebuild -- build Xcode projects and workspaces
,Xcode中自带的打包工具,平时我们用xcode打包就是用的这个玩意。
xcodebuild archive #打包操作
-archivePath <archivePath> #打包后的输出路径
-project <projectName> #项目名称
-workspace <workspaceName> #项目空间名称
-scheme <schemeName> #指定是项目中哪个scheme,可以从-list命令中获取
-configuration <Debug|Release> #哪种环境,Debug还是Release
-destination <DESTINATIONSPECIFIER> #分发的平台
编译一个模拟器架构的库
xcodebuild archive -project 'SYTimer.xcodeproj' \
-scheme 'SYTimer' \
-configuration Release \
-destination 'generic/platform=iOS Simulator' \
-archivePath '../archives/SYTimer.framework-iphonesimulator.xcarchive' \
SKIP_INSTALL=NO
执行完后会在项目同级目录生成一个archives
文件夹,里面包含iphonesimulator.xcarchive
文件,右键显示包内容,会看到Products
->Library
->Frameworks
,Frameworks
存在一个叫SYTimer.framework
的库,这个库就是我们编译好的framework
。
从图中可以看到多了一个参数:
SKIP_INSTALL=NO
设置这个参数的意义在于:是否将编译好的库拷贝到Products
目录下,如果SKIP_INSTALL=YES
,则Products
目录下为空。我们做库合并时,需要用到Framework,所以必须加上这个参数。
编译一个真机架构的库
修改xcodebuild指令中的分发平台
和输出路径
参数:
-destination 'generic/platform=iOS' \
-archivePath '../archives/SYTimer.framework-iphoneos.xcarchive' \
lipo
指令将模拟器和真机架构合并
使用file SYTimer
命令可以查看库文件包含的架构。
打包命令中,并没有指定架构。但打包后SYTimer
可执行文件中,包含了arm_v7
和arm64
两种架构。这个和SYTimer
项目中的Build Settings
设置有关,在打包时也执行了Build Settings
中的设置。
架构合并需要使用lipo
命令。将不同的架构合并到一起,生成一个胖二进制。但lipo命令却不能将包含相同架构的库进行合并。在上面生成的两个库文件中均包含了arm64
,无法进行合并。
lipo -output SYTimer -create ../archives/SYTimer.framework-iphoneos.xcarchive/Products/Library/Frameworks/SYTimer.framework/SYTimer ../archives/SYTimer.framework-iphonesimulator.xcarchive/Products/Library/Frameworks/SYTimer.framework/SYTimer
lipo指令合并相同架构发生错误.png
lipo指令无法合并的解决办法
使用lipo
命令,最大的问题就是包含相同架构,无法合并Fat Binary
。这种情况只能将所需的架构提取出来,再进行合并。
lipo -output SYTimer-x86_64 -extract x86_64 ../archives/SYTimer.framework-iphonesimulator.xcarchive/Products/Library/Frameworks/SYTimer.framework/SYTimer
从模拟器中提取x86_64架构,输出到当前目录生成SYTimer-x86_64
文件。再与真机库进行合并,因为arm64
只有真机存在,所以可以执行合并成功了。
lipo -output SYTimer -create ../archives/SYTimer.framework-iphoneos.xcarchive/Products/Library/Frameworks/SYTimer.framework/SYTimer SYTimer-x86_64
lipo指令合并成功.png
生成XCFramework
-
XCFramework
:是苹果官方推荐的、支持的,可以更方便的表示一个多个平台和架构的分发进制库的格式。 - 需要Xcode11以上支持。
- 是为更好的支持
Mac Catalyst
和ARM芯片的macOS。 - 专门在2019年提出的Framework的另一种先进格式。
和传统的Framework
相⽐:
- 可以⽤单个
.xcframework
⽂件提供多个平台的分发⼆进制⽂件 - 与
Fat Header
相⽐,可以按照平台划分,可以包含相同架构的不同平台的⽂件 - 在使⽤时,不需要再通过脚本去剥离不需要的架构体系
将两个架构的Framework合并成XCFramework
使用xcodebuild
命令,将模拟器和真机两个平台的Framework
合并成XCFramework
xcodebuild -create-xcframework \
-framework '../archives/SYTimer.framework-iphoneos.xcarchive/Products/Library/Frameworks/SYTimer.framework' \
-framework '../archives/SYTimer.framework-iphonesimulator.xcarchive/Products/Library/Frameworks/SYTimer.framework' \
-output 'SYTimer.xcframework'
xcodebuild将两个架构Framework编译成XCFramework.png
一般XCFramework需要包含BitCode和dSYMs方便崩溃时恢复调用栈,那么修改创建XCFramework的命令如下:
xcodebuild -create-xcframework \
-framework '../archives/SYTimer.framework-iphoneos.xcarchive/Products/Library/Frameworks/SYTimer.framework' \
-debug-symbols '/Users/chenshuangchao/Desktop/archives/SYTimer.framework-iphoneos.xcarchive/BCSymbolMaps/618E16C1-20B9-39A5-98A1-42E947A26ADB.bcsymbolmap' \
-debug-symbols '/Users/chenshuangchao/Desktop/archives/SYTimer.framework-iphoneos.xcarchive/BCSymbolMaps/6E502109-851C-3FA9-A5B9-8A1373F73FE5.bcsymbolmap' \
-debug-symbols '/Users/chenshuangchao/Desktop/archives/SYTimer.framework-iphoneos.xcarchive/dSYMs/SYTimer.framework.dSYM' \
-framework '../archives/SYTimer.framework-iphonesimulator.xcarchive/Products/Library/Frameworks/SYTimer.framework' \
-debug-symbols '/Users/chenshuangchao/Desktop/archives/SYTimer.framework-iphonesimulator.xcarchive/dSYMs/SYTimer.framework.dSYM' \
-output 'SYTimer.xcframework'
- 只有真机才有BitCode。
- BitCode和dSYMs的文件路径必须传绝对路径,否则会出现错误the path does not point to a valid debug symbols file。
上面指令也可以用脚本实现
ARCHIVES=/Users/chenshuangchao/Desktop/archives
# -debug-symbols:必须使用绝对路径
# Shell变量必须放在""中
xcodebuild -create-xcframework \
-framework '../archives/SYTimer.framework-iphoneos.xcarchive/Products/Library/Frameworks/SYTimer.framework' \
-debug-symbols "${ARCHIVES}/SYTimer.framework-iphoneos.xcarchive/BCSymbolMaps/9D87CD30-46F3-302A-ADCF-BF46F07578D4.bcsymbolmap" \
-debug-symbols "${ARCHIVES}/SYTimer.framework-iphoneos.xcarchive/BCSymbolMaps/ACA28AC6-6E0E-3F6F-8105-BC1175739A0B.bcsymbolmap" \
-debug-symbols "${ARCHIVES}/SYTimer.framework-iphoneos.xcarchive/dSYMs/SYTimer.framework.dSYM" \
-framework '../archives/SYTimer.framework-iphonesimulator.xcarchive/Products/Library/Frameworks/SYTimer.framework' \
-debug-symbols "${ARCHIVES}/SYTimer.framework-iphonesimulator.xcarchive/dSYMs/SYTimer.framework.dSYM" \
-output 'SYTimer.xcframework'
给XCFramework添加debug-symbols成功.png
xcframework
文件和普通Framework
文件的使用别无二致。xcframework
中打包了多个平台的Framework
,比普通Framework
文件更大。但在实际使用中,xcframework
会根据当前链接的平台架构,仅链接相应的库文件,不会将整个xcframework
全部链接。
xcframework的优势:
- 不用手动处理头文件、资源文件等内容(
lipo
合并后需要链接) - 重复架构可自行处理,(免去
lipo
指令重复时需要提取指定架构的步骤) - 更方便的导入调式符号,直接在指令中完成
- 自动链接相应平台架构的库文件,将不需要的架构去掉(上线时自动去掉模拟器架构)