您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

CocoaPods 組件平滑二進制化:一套可落地的完整方案

編輯:iOS 開發基礎

什麼是組件二進制化

iOS 開發的事實標準是用 CocoaPods 來生成、管理與引用 library,這裡的 library 就是模塊、組件或庫。所謂二進制化,是把組件源碼預先編譯成靜態庫或動態庫,从而提升它在 App 工程中的編譯速度。我們的方案選的是靜態庫:一份 .a 文件加上對外暴露的頭文件。

為什麼要做這件事

隨着業務沉澱,我們把大量模塊、業務邏輯與 UI 抽象成了私有 CocoaPod 庫。其中有一個是 C++ 與 Objective-C 混寫(.mm)的,編譯極慢,這成了推動改造的直接契機。這個庫叫 YTXChart,後文會反覆以它為例。

此外,私有庫與第三方庫越堆越多,工程文件數量膨脹,每次 pod install 裝新庫或 pod update 更庫都要長時間等待。想推進組件化,二進制化幾乎是前置條件。這也是很多大型團隊的通行做法。

新問題:一步到位還是平滑過渡

顯然不可能第一天就把所有私有庫和第三方庫全部二進制化。當務之急只是加快 YTXChart 的編譯,所以必須找到一條平滑遷移的路徑。

App 的 Podfile 大致如下:

target 'jryMobile' do
    pod 'AFNetworking', '~> 2.6.3'
    pod 'Mantle', '~> 1.5.7'
    pod 'ReactiveCocoa', '~> 2.3.1'
    pod 'FMDB', '~> 2.5'
    pod 'SDWebImage', '~> 3.7'
    pod 'MJRefresh', '~> 3.1.7'
    pod 'YTXChartSocket', '~> 0.5.1'
    pod 'YTXChart', '~> 0.17.0'          # 希望做二進制化
    pod 'YTXServerId', '~> 0.1.4'
    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

平滑二進制化的需求清單

  • 其他 CocoaPod 庫維持源碼形態,僅 YTXChart 二進制化。
  • 後續能逐步迭代,把更多 YTX 開頭的私有庫二進制化,而不影響主 App。
  • 提供便捷手段把二進制庫切回源碼,方便調試。
  • 正確處理 YTXChart 的依賴關係:它依賴第三方 AFNetworking 與私有 YTXServerId,生成的靜態庫中不能包含這兩者內容,且要能編譯通過。
  • 沿用原來的 YTXChart.git,不新建項目、不新建 git 庫、不引入 submodule。源碼更新後要能快速重新產出二進制。
  • App 源碼與 YTXChart 源碼盡量少改或不改。
  • App 的 Podfile 盡量少改或不改。
  • 版本號風格保持統一,不出現 '~> 2.2.1.binary' 這類寫法。
  • 繼續使用原來那一個 CocoaPods Repo Spec。

以下教程基於 CocoaPods 1.0.1,且目前僅適用於該版本。

第一步:從源碼構建靜態庫

用 pod lib create 建庫並 pod install 之後,目錄結構大致如下(僅列重點):

YTXChart
  |- Example
  |    |- YTXChart
  |    |- Pods
  |    |- YTXChart.xcodeproj
  |    |- YTXChart.xcworkspace
  |    |- Podfile
  |    \- Podfile.lock
  |- Pod
  |    |- Assets
  |    \- Classes
  \- YTXChart.podspec

在 Xcode 中新建 Target:File → New → Target → Framework & Library → Cocoa Touch Static Library,命名為 YTXChartBinary。

若項目最低支持 iOS 8,也可以直接建 Dynamic Framework。

同時在 Podfile 中加入:

target 'YTXChartBinary' do
end

執行 pod install。CocoaPods 1.0.1 會自動補全 Header Search Path;若使用 0.39.0 則需手動添加,以保證 YTXServerId 與 AFNetworking 能被找到。

把 Pod/Classes 下的源碼拖進 YTXChartBinary,勾選「不複製、僅鏈接」的那個選項:

完成後如下:

Headers 需要自行添加,內容即需要對外暴露的頭文件。

在 YTXChartBinary Target 的 Build Settings 中,把 iOS Deployment Target 與 podspec 中的 s.platform 保持一致(此處為 7.0)。

在根目錄創建 shell 腳本 buildbinary.sh(也可以建一個 Aggregate Target 來觸發它):

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 以提速;再用 lipo 合併。新 .a 沿用工程名,是為了對齊 App 裡已有的 -l"YTXChart" 配置。

結果:

為什麼要移除 i386

二進制化本質是拿空間換時間。YTXChart 產出的 .a 去掉 i386 後仍有 166.3M,上傳到 git 倉庫經壓縮還會增加約 33M。而 git 對二進制文件無法做增量,每次上傳都會讓倉庫顯著變大。考慮到服務器可用硬盤僅 60G,後續還要二進制化更多組件,結論很明確:

盡量壓縮二進制體積;日常不提交 .a,直到發布某個版本時再上傳。

當然,如果你的硬盤是 1T,那就隨意了。

此時目錄變為:

YTXChart
  |- Example
  |    |- YTXChart
  |    |- Pods
  |    |- YTXChart.xcodeproj
  |    |- YTXChart.xcworkspace
  |    |- YTXChartBinary        // 空
  |    |- Podfile
  |    \- Podfile.lock
  |- Pod
  |    |- Assets
  |    |- Classes              // 源碼
  |    \- Products
  |         |- include
  |         |    |- xxx.h
  |         |    \- ...
  |         \- lib
  |              \- libYTXChartBinary.a
  \- YTXChart.podspec

第二步:驗證靜態庫

調整 YTXChart.podspec,關鍵是下面幾行:

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'

Example/Podfile 形如:

source 'https://gitlab.example.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='...' --verbose --use-libraries --fail-fast 校驗通過即可。

此時我們得到一個只含 YTXChart 自身內容的靜態庫

不包含 AFNetworking 與 YTXServerId 的代碼。驗證方式很直接:把 s.dependency 'AFNetworking', '~> 2.0' 去掉再 lint,會報找不到 AFNetwork 相關文件。

題外話:CocoaPods 1.0.1 尚不支持 C++ 混編項目的 lint(屬於已知缺陷),因此涉及 .mm 時我會切回 0.39.0 做 lint 與 publish;而前面依賴 1.0.1 自動補 Search Path 的環節保持不變。若你的庫不是 .mm 混寫,完全沒有這個困擾,放心用 1.0.1。

第三步:源碼與二進制之間自由切換

在 podspec 中加入環境變量判斷:

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

我們的常態是使用二進制,偶爾才切回源碼調試,因此預設分支給了二進制。

刪除 Example/Pods 目錄後執行 IS_SOURCE=1 pod install,你會看到 Example/Pods/YTXChart/ 下全是源碼,並伴隨提示「YTXChart is source now」。此時跑模擬器會因源碼編譯而變慢,但結果正確;pod cache clean --all && IS_SOURCE=1 pod lib lint 與 pod cache clean --all && pod lib lint 也都能通過。至此,本地 Example 工程的源碼/二進制切換已完成。

發布與驗證

發布流程與常規別無二致。從 spec repo 安裝時,把 Podfile 改成 pod 'YTXChart', '~> 0.17.7',然後務必執行兩步:pod cache clean --all 與刪除 Example/Pods,最後 pod install。檢查會發現 YTXServerId 與 AFNetworking 都是 .h/.m 源碼,而 YTXChart 是 .a 加頭文件,App 運行正常。

若此時直接執行 IS_SOURCE=1 pod install,Example/Pods/YTXChart/ 會變成空——因為 CocoaPods 已緩存了一個 podspec.json,其中記錄的取文件路徑仍是 Pod/Products/。目前只能靠上面的清理兩步規避,切換本身並非常態操作,這個代價可以接受。

為什麼 lint 前也要 cache clean?原理相同:若 YTXChart 依賴的 YTXServerId 同樣被二進制化,就需要清理;也可以精準一點用 pod cache clean YTXServerId。

特別注意

IS_SOURCE 應當作為所有未二進制化 Pod 庫的統一開關,並在團隊內達成共識:平時 pod install 時部分庫走二進制;IS_SOURCE=1 pod install 時所有庫回歸源碼。

完整原理回顧

發布完成後,Spec Repo 中對應版本的 podspec 就是 YTXChart.podspec。CocoaPods 依 s.source 的 git 地址與 tag 下載代碼,Pod/Products 與 Pod/Classes 都在其中;帶上 IS_SOURCE=1 時 ENV['IS_SOURCE'] 為真,CocoaPods 便按 s.source_files 從下載路徑取源碼來構建 Example/Pods 與 workspace。理解了這條鏈路,也就明白了為何切換時必須刪 cache 與 Pods 目錄。

總結

  • 沒有引入 submodule 或新 git 倉庫,全程一份倉庫、一份源碼。
  • 源碼修改後只需跑一次 buildbinary.sh 即可重新產出靜態庫,無需拷貝代碼。
  • 共用一份 YTXChart.podspec,改動極小。
  • pod lib lint 與 IS_SOURCE=1 pod lib lint 均可通過。
  • 主 App 的 Podfile 一行都不用改,不會出現 '~> 2.2.1.binary' 這類寫法。
  • App 源碼無需為二進制化做任何修改,也不用手動配置 Search Path。
  • 唯一遺留問題:切換時需刪 Pods 目錄並執行 pod cache clean --all。
  • 不影響其他庫,可以一個一個平滑推進。

後續規劃

逐步把更多 YTX 系列庫二進制化;在私有 spec repo 中為 AFNetworking 等第三方庫做鏡像並提供二進制版本;最終讓 Podfile 中絕大部分組件都走二進制(React Native 這類本地安裝模式與帶 sub spec 的庫暫不處理)。

補充要點

資源文件在二進制化中的配置方式不變。使用二進制化的 CocoaPods 庫也不會增大 ipa 體積,因此優先採用二進制還能加快 Archive 速度。

帶 sub spec 的組件有兩種處理方式:一是提供一個全集;二是為每個 sub spec 各做一份二進制並維護它們之間的依賴關係。

走過的彎路

方案如今看似簡單,探索期卻不順利。曾嘗試另建 YTXChartBinary.podspec,把 Products 與 podspec 都放到 YTXChartBinary 目錄下,Podfile 裡寫 pod 'YTXChartBinary', '~> 0.17.7'。問題成堆:要維護兩份 podspec、版本號容易漂移;pod spec lint 報找不到文件;切換不方便;App 源碼的 import 也得跟著改,來回折騰。

另一種嘗試是專門建一個存放二進制版本的 Spec Repo,用不同 source 區分。這解決了改 App 源碼的問題,Podfile 加一行 source 即可,但代價是發布兩次、lint 兩次,還多養一個倉庫。

最終方案之所以成立,正是因為它避開了以上所有麻煩。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved