iOS CocoaPods组件平滑二进制化方案及详细教程
在iOS开发中,事实标准是我们使用CocoaPods生成、管理和使用library。这里的library就是一个模块、组件或库。二进制化指的是通过编译把组件的源码转换成静态库或动态库,以提高该组件在App项目中的编译速度。
我们的方案是转换成静态库,也就是.a格式的文件加上暴露出来的头文件。
在我们App开发中,我们逐渐的抽象了很多模块、业务、UI等把他转换成私有CocoaPod库。其中有一个是用C++和Objective-C混写的,源码格式为.mm。在app项目编译时.mm部分代码编译非常慢。这作为一个契机让我们去考虑如何加快编译速度。
这个混写的CocoaPod库叫做YTXChart,之后会以此库为例反复提到。
另外随着业务的扩展,私有CocoaPod库和第三方CocoaPod库越来越多,App项目中的文件也越来越多。每次 pod install
安装新库或 pod update
更新库的时候,重新编译的过程需要等待很长时间。这也向我们提出了加快编译速度的需求。
另外如果想要做组件化的话,一定要做二进制化。
所以我们想到了二进制化的方案来解决这个问题,并且很多大公司也是这么做的。
对我们来说,这是一个尝试,不可能开始就决定把所有的私有CocoaPod库二进制化,也不可能决定把所有第三方CocoaPod库二进制化。当务之急的情况是加快YTXChart库编译速度。所以必须找到一个方案平滑过度。
我们的App中的podflie是这样的
target 'jryMobile' do pod 'AFNetworking', '~> 2.6.3' pod 'Mantle', '~> 1.5.7' pod 'DateTools', '~> 1.7.0' pod 'ReactiveCocoa', '~> 2.3.1' pod 'CocoaAsyncSocket', '~> 7.4.1' pod 'FMDB', '~> 2.5' pod 'MWPhotoBrowser', '~> 1.4.1' pod 'MZFormSheetController', '~> 2.3.6' pod 'HMSegmentedControl', '~> 1.5.1' pod 'UMengAnalytics', '~> 3.5.8' pod 'UMengFeedback', '~> 2.3.4' pod 'TSMessagesNW', '~> 0.9.15' pod 'TPKeyboardAvoiding', '~> 1.2.9' pod 'SDWebImage', '~> 3.7' pod 'JHChainableAnimations', '~> 1.3.0' pod 'BarrageRenderer', '~> 1.7.0' pod 'MJRefresh', '~> 3.1.7' pod 'YTXAnimations', '~> 1.2.4', :subspecs => ["AnimateCSS", "Transformer"] pod 'YTXMediaIJKPlayer', '~> 0.2.1' pod 'YTXTradeBusinessType', '~> 1.1.0' pod 'YTXServerId', '~> 0.1.4' pod 'YTXUtilCategory','~> 1.2.0' pod 'YTXScreenShotManager', '~> 0.1.7' pod 'YTXRequest', '~> 1.0.0' pod 'YTXCommonSocket', '~> 0.1.9' pod 'YTXChartSocket', '~> 0.5.1' # 希望是二进制化的 pod 'YTXChart', '~> 0.17.0' pod 'YTXRestfulModel', '~> 1.2.2', :subspecs => ["RACSupport", "YTXRequestRemoteSync", "FMDBSync", "UserDefaultStorageSync"] pod 'YTXWebViewJavaScriptBridge', '~> 0.1.2' pod 'YTXCheckForAppUpdates', '~> 1.0.0' # pod 'YTXVideoAVPlayer', '~> 0.5.0' pod 'YTXChatUI', '~> 0.3.2' pod 'PNChart', '~>0.8.9' #pod 'EaseMobSDKFull', :git => 'https://github.com/easemob/sdk-ios-cocoapods-integration.git', :tag => '2.2.0' # EaseMobSDKFull 更新地址'https://github.com/easemob/sdk-ios-cocoapods-integration.git' #pod 'AFgzipRequestSerializer', '~> 0.0.2' pod 'AdhocSDK', '~> 2.2.1' pod 'FLEX', '~> 2.0', :configurations => ['Debug'] pod 'React', :path => './ReactComponent/node_modules/react-native', :subspecs => [ 'Core', 'RCTImage', 'RCTNetwork', 'RCTText', 'RCTWebSocket', # 添加其他你想在工程中使用的依赖。 ] pod 'CodePush', :path => './ReactComponent/node_modules/react-native-code-push' end
'~> 2.2.1.binary'
这种情况。 注意,以下的例子基于Cocoapods@1.0.1,而且目前只能是1.0.1
如果你是通过命令 pod lipo create
创建的CocoaPod库并且 pod install
的话,它的目录结构应该像这样子(只列出重要的):
YTXChart |-Example |-YTXChart |-Pods |-YTXChart.xcodeproj |-YTXChart.xcworkspace |-Podfile /-Podfile.lock |-Pod |-Assets /-Classes /-YTXChart.podspec
在xcode中创建新Target YTXChartBinary File->New->Target->Framework & Library->Cocoa Touch Static Library
如果你们的项目最低支持到iOS8可以创建Dynamic Framework
注意在Podfile中加入以下这段
target 'YTXChartBinary' do end
然后 pod install
解释:Cocoapods@1.0.1会在Header Search Path自动加入内容。如果你用CocoaPods@0.39.0则需要自己加Header Search Path保证依赖库YTXServerId和AFNetwork能够被找到。如图:
然后把Pod/Classes中的源码拖入到YTXChartBinary中,这样选择(这样会link源码而不是复制): 然后变成这样子: Headers需要自己加,里面是你需要暴露的头文件
在YTXChartBinary Target中的Build Settings下找到iOS Deployment Target选择和YTXChart.podspec中的s.platform保持一致。这里是7.0 YTXChartBinary Target->Build Settings->iOS Deployment Target
在根目录创建shell脚本buildbinary.sh
你也可以创建一个Aggregate Target用来执行shell脚本
代码如下:
PROJECT_NAME="YTXChart" BINARY_NAME="${PROJECT_NAME}Binary" cd Example INSTALL_DIR=$PWD/../Pod/Products rm -fr "${INSTALL_DIR}" mkdir $INSTALL_DIR WRK_DIR=build BUILD_PATH=${WRK_DIR} DEVICE_INCLUDE_DIR=${BUILD_PATH}/Release-iphoneos/usr/local/include DEVICE_DIR=${BUILD_PATH}/Release-iphoneos/lib${BINARY_NAME}.a SIMULATOR_DIR=${BUILD_PATH}/Release-iphonesimulator/lib${BINARY_NAME}.a RE_OS="Release-iphoneos" RE_SIMULATOR="Release-iphonesimulator" xcodebuild -configuration "Release" -workspace "${PROJECT_NAME}.xcworkspace" -scheme "${BINARY_NAME}" -sdk iphoneos clean build CONFIGURATION_BUILD_DIR="${WRK_DIR}/${RE_OS}" LIBRARY_SEARCH_PATHS="./Pods/build/${RE_OS}" xcodebuild ARCHS=x86_64 ONLY_ACTIVE_ARCH=NO -configuration "Release" -workspace "${PROJECT_NAME}.xcworkspace" -scheme "${BINARY_NAME}" -sdk iphonesimulator clean build CONFIGURATION_BUILD_DIR="${WRK_DIR}/${RE_SIMULATOR}" LIBRARY_SEARCH_PATHS="./Pods/build/${RE_SIMULATOR}" if [ -d "${INSTALL_DIR}" ] then rm -rf "${INSTALL_DIR}" fi mkdir -p "${INSTALL_DIR}" cp -rp "${DEVICE_INCLUDE_DIR}" "${INSTALL_DIR}/" INSTALL_LIB_DIR=${INSTALL_DIR}/lib mkdir -p "${INSTALL_LIB_DIR}" lipo -create "${DEVICE_DIR}" "${SIMULATOR_DIR}" -output "${INSTALL_LIB_DIR}/lib${BINARY_NAME}.a" lipo -remove i386 "${INSTALL_LIB_DIR}/lib${BINARY_NAME}.a" -output "${INSTALL_LIB_DIR}/lib${PROJECT_NAME}.a" rm -r "${WRK_DIR}"
这个脚本写的并不是很好。说说主要做了什么。 Release不同的静态库,真机和模拟器的。只构建x86_64,不构建i386加快速度
xcodebuild -configuration "Release" -workspace "${PROJECT_NAME}.xcworkspace" -scheme "${BINARY_NAME}" -sdk iphoneos clean build CONFIGURATION_BUILD_DIR="${WRK_DIR}/${RE_OS}" LIBRARY_SEARCH_PATHS="./Pods/build/${RE_OS}" xcodebuild ARCHS=x86_64 ONLY_ACTIVE_ARCH=NO -configuration "Release" -workspace "${PROJECT_NAME}.xcworkspace" -scheme "${BINARY_NAME}" -sdk iphonesimulator clean build CONFIGURATION_BUILD_DIR="${WRK_DIR}/${RE_SIMULATOR}" LIBRARY_SEARCH_PATHS="./Pods/build/${RE_SIMULATOR}"
*通过lipo命令合并。新.a使用project name是因为要和App项目的OTHER_LDFLAGS兼容 -l"YTXChart"
lipo -create "${DEVICE_DIR}" "${SIMULATOR_DIR}" -output "${INSTALL_LIB_DIR}/lib${PROJECT_NAME}.a"
结果:
实际上,二进制化方案就是以空间换时间。我们这个YTXChart库生成的.a去除i386之后大小有166.3M。上传到git仓库后,git会压缩。增加了33M左右。而作为二进制文件,git是没法做增量的。所以每次上传.a都会大大增加git库大小,增加硬盘使用量。考虑到我们的服务器硬盘只有60个G能用,以后还会二进制化很多组件。
所以得出:尽量压缩二进制文件大小;尽量不上传.a,直到发布某个版本时才上传。
当然,如果你的服务器硬盘是1T的话,我觉得你也可以随便搞。
现在文件目录是这样子的:
YTXChart |-Example |-YTXChart |-Pods |-YTXChart.xcodeproj |-YTXChart.xcworkspace |-YTXChartBinary //空的 |-Podfile /-Podfile.lock |-Pod |-Assets |-Classes //里面是源码 /-Products |-include |-xxx.h |-... /-xxx.h /-lib /- libYTXChartBinary.a /-YTXChart.podspec
修改YTXChart.podspec如下:
Pod::Spec.new do |s| s.name = "YTXChart" s.version = "0.17.7" s.summary = "YTXChart for pod" # This description is used to generate tags and improve search results. # * Think: What does it do? Why did you write it? What is the focus? # * Try to keep it short, snappy and to the point. # * Write the description between the DESC delimiters below. # * Finally, don't worry about the indent, CocoaPods strips it! s.description = "银天下Chart, 依赖AFNetworking" s.homepage = "http://gitlab.baidao.com/ios/YTXChart.git" # s.screenshots = "www.example.com/screenshots_1", "www.example.com/screenshots_2" s.license = 'MIT' s.author = { "caojun-mac" => "78612846@qq.com" } s.source = { :git => "http://gitlab.baidao.com/ios/YTXChart.git", :tag => s.version } # s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>' s.platform = :ios, '7.0' s.requires_arc = true s.source_files = 'Pod/Products/include/**' s.public_header_files = 'Pod/Products/include/*.h' s.ios.vendored_libraries = 'Pod/Products/lib/libYTXChart.a' s.libraries = 'sqlite3', 'c++' s.dependency 'YTXServerId' s.dependency 'AFNetworking', '~> 2.0' end
注意s.source files和s.public header files和s.ios.vendored libraries的路径
Exampl/Podfile是长这样子的:
source 'http://gitlab.baidao.com/ios/ytx-pod-specs.git' source 'https://github.com/CocoaPods/Specs.git' target 'YTXChart_Example' do pod "YTXChart", :path => "../" pod 'ReactiveCocoa', '~> 2.5' pod 'YTXChartSocket' pod 'AFNetworking', '~> 2.0' end target 'YTXChartBinary' do end target 'YTXChart_Tests' do pod "YTXChart", :path => "../" pod 'Kiwi' end
执行 pod install
后应该是这样子的,然后跑起来没问题
执行 pod lib lint --sources='http://gitlab.baidao.com/ios/ytx-pod-specs.git,master'--verbose --use-libraries --fail-fast
也是好的
证明:把 s.dependency 'AFNetworking', '~> 2.0'
去除再执行 pod lib lint 'http://gitlab.baidao.com/ios/ytx-pod-specs.git,master' --verbose --use-libraries --fail-fast
会报出找不到AFNetwork相关文件。
题外话:因为CocoaPods1.0.1不支持C++项目的lint(这是一个 defect ),所以这个时候我会切回CocoaPods@0.39.0来lint和publish。而前面pod instal增加Search Path是依靠CocoaPods@1.0.1。如果你不是.mm混写的,是不会有这个问题的。尽管使用CocoaPods@1.0.1。强行当作没看到这个题外话。
下一步解决如何在源码和二进制中切换 修改YTXChart.podspec为以下内容:
# # Be sure to run `pod lib lint YTXChart.podspec' to ensure this is a # valid spec before submitting. # # Any lines starting with a # are optional, but their use is encouraged # To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html # Pod::Spec.new do |s| s.name = "YTXChart" s.version = "0.17.7" s.summary = "YTXChart for pod" # This description is used to generate tags and improve search results. # * Think: What does it do? Why did you write it? What is the focus? # * Try to keep it short, snappy and to the point. # * Write the description between the DESC delimiters below. # * Finally, don't worry about the indent, CocoaPods strips it! s.description = "银天下Chart, 依赖AFNetworking" s.homepage = "http://gitlab.baidao.com/ios/YTXChart.git" # s.screenshots = "www.example.com/screenshots_1", "www.example.com/screenshots_2" s.license = 'MIT' s.author = { "caojun-mac" => "78612846@qq.com" } s.source = { :git => "http://gitlab.baidao.com/ios/YTXChart.git", :tag => s.version } # s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>' s.platform = :ios, '7.0' s.requires_arc = true if ENV['IS_SOURCE'] puts '-------------------------------------------------------------------' puts 'Notice:YTXChart is source now' puts '-------------------------------------------------------------------' s.source_files = "Pod/Classes/painter/*.{h,m,mm}", "Pod/Classes/painterview/*.{h,m,mm}", "Pod/Classes/chart/*.{h,m,mm}", "Pod/Classes/core/*.{h,mm}", "Pod/Classes/core/**/*.{h,m,mm,inl}" else puts '-------------------------------------------------------------------' puts 'Notice:YTXChart is binary now' puts '-------------------------------------------------------------------' s.source_files = 'Pod/Products/include/**' s.public_header_files = 'Pod/Products/include/*.h' s.ios.vendored_libraries = 'Pod/Products/lib/libYTXChart.a' end s.libraries = 'sqlite3', 'c++' s.dependency 'YTXServerId' s.dependency 'AFNetworking', '~> 2.0' end
注意这段 if ENV['IS_SOURCE']
。我们的需求是优先使用二进制,偶尔才会切回源码。
删除Example/Pods目录。
执行 IS_SOURCE=1 pod install
。你会看到Example/Pods/YTXChart/里面都是源码
输出 Notice:YTXChart Now is source
进一步跑起模拟器,因为是源码编译用了很长时间,模拟器起来,一切也是好的
再试下 pod cache clean --all && IS_SOURCE=1 pod lib lint
也是好的
再试下 pod cache clean --all && pod lib lint
也是好的
现在我们通过 if else
简单地实现了本地Example App项目切换源码和二进制。
发布就和正常发布没有任何区别。
Podfile修改为 pod 'YTXChart', '~> 0.17.7'
以下两步很重要
pod cache clean --all
删除Example/Pods
然后 pod install
检查Example/Pods/YTXServerId/和Example/Pods/AFNetwork/发现都是.h .m源码。
检查Example/Pods/YTXChart/里的是二进制.a和头文件。跑起App并没有问题。
如果你直接 IS_SOURCE=1 pod install
你会发现Example/Pods/YTXChart/里的内容都变成了空
这是为什么呢,因为pod cache了一个podspec.json。可以通过 pod cache list
查看。他cache了一个描述如何从s.source中找到相关文件。现在的描述还是从Pod/Products/下去找,自然为空。
为了避免这个问题,所以必须执行上面两步。这个是唯一的问题,目前我还找不到更好的解决方案。切换的行为只是偶尔发生,这是可以接受的。
执行2步。再次 IS_SOURCE=1 pod install
你就发现Example/Pods/YTXChart/里的内容都变成了.h .mm源码。跑起App也是好的。
为什么lint之前要cache clean。原理是一样的。如果YTXChart依赖的YTXServerId也被做成了二进制化就需要cache clean。不过你也可以这样 pod cache clean YTXServerId
特别注意 IS_SOURCE 应当作为一个所有非二进制化Pod库的统一标识,并且通知你们的项目组里所有成员。 pod install
可能会有某几个已经二进制化的库使用二进制的内容。 IS_SOURCE=1 pod install
时,所有的库都将会是源码的内容。
请参考这篇我的文章 CocoaPod版本规范
当你发布完成之后,查看。我们发现在Spec Repo中对应版本的podspec就是我们的YTXChart/podspec。 CocoaPod从 s.source
git地址和tag下载对应的代码,Pod/Products和Pod/Classes里的内容都存在 当你使用 IS_SOURCE=1
时 ENV['IS_SOURCE']
会为true。 CocoaPods通过
s.source_files 从下载代码的路径找到源码构建Example/Pods和YTXChart.xcworkspace
明白了上面的过程,来再分析下为什么要在切换源码和二进制化时删除cache和Pods目录。放几张图就明白了 删除cache和Pods目录。 IS_SOURCE=1 pod install
观察json。
pod lib lint
和 IS_SOURCE=1 pod lib lint
检查通过。 '~> 2.2.1.binary'
。 IS_SOURCE
灵活地切换源码和二进制静态库。唯一一个问题每次切换要删除Pods目录和 pod cache clean --all
逐步平滑地把YTXXXX一个一个做成二进制
进一步的把第三方如AFNetwork在私有spec repo中做份镜像也提供二进制化
把Podfile中绝大部分组件都做成二进制(RN这种本地安装模式和有sub spec的库目前不打算二进制化)
另外,使用二进制化的CocoaPods库不会增加ipa的大小。所以我们应当优先用二进制化的东西,这可以加快Archive速度。
两个方案:
现在这个解决方案看起来简单,但在当初的探索过程中并不是那么顺利。以下是不成功的尝试!
pod 'YTXChartBinary', '~> 0.17.7'
问题
pod spec lint
报错:找不到相关文件。 <YTXChart/YTXChart.h>
需要改成 <YTXChartBinary/YTXChart.h>
。来回切换都需要改,极不方便。 "YTXChart.h"
。但这样也不好。 解决了要改App源码的问题。只需要在Podfile中加个source。
不同的source例子
source 'http://gitlab.baidao.com/ios/ytx-binary-pod-specs.git' source 'http://gitlab.baidao.com/ios/ytx-pod-specs.git'
问题