如何將iOS項(xiàng)目的編譯速度提高5倍
前言
貝聊目前開發(fā)的兩款A(yù)pp分別是貝聊家長版和貝聊老師版，最近因?yàn)樵诳焖俚_發(fā)新功能，項(xiàng)目規(guī)模急速增長，單個(gè)端業(yè)務(wù)代碼約23萬行，私有庫約6萬行，第三方庫代碼約15萬行，單個(gè)客戶端的代碼行數(shù)約60萬。現(xiàn)在打包一次耗時(shí)需要11~12分鐘。雖然還遠(yuǎn)遠(yuǎn)比不上 Facebook 的40分鐘，但是我們在內(nèi)測的時(shí)候，經(jīng)常一天要發(fā)布內(nèi)測版兩到三次。打包時(shí)CPU占用基本上是百分百的，因?yàn)闆]有專門的 CI 機(jī)器，對負(fù)責(zé)打包的同事(其實(shí)就是我自己)的工作時(shí)間占用比較多，所以最近一直在尋找加快打包速度的方案。
目前的項(xiàng)目架構(gòu)
我們的項(xiàng)目使用 CocoaPods 來管理第三方庫和私有庫的依賴，對大部分項(xiàng)目來說應(yīng)該是標(biāo)配了。目前還是純 Objective-C 的項(xiàng)目，沒有引入 Swift。
調(diào)研過的方案
下面列出我研究過的一些主流方案以及我最后沒有采用的原因，這些方案有各自的局限性，但是也給了我不少啟發(fā)，思考過程跟最終方案一樣有價(jià)值。
cocoapods-packager
cocoapods-packager 可以將任意的 pod 打包成 Static Library，省去重復(fù)編譯的時(shí)間，一定程度上可以加快編譯時(shí)間，但是也有自身的缺點(diǎn)：
- 優(yōu)化不徹底，只能優(yōu)化第三方和私有 Pod 的編譯速度，對于其他改動(dòng)頻繁的業(yè)務(wù)代碼無能為力
- 私有庫和第三方庫的后續(xù)更新很麻煩，當(dāng)有源碼修改后，需要重新打包上傳到內(nèi)部的 Git 倉庫
- 過多的二進(jìn)制文件會(huì)拖慢 Git 的操作速度(目前還沒部署 Git 的 LFS)
- 難以調(diào)試源碼
Carthage
這個(gè)方案跟 cocoapods-packager 比較類似，優(yōu)缺點(diǎn)都差不多，但 Carthage 可以比較方便地調(diào)試源碼。因?yàn)槲覀兡壳耙呀?jīng)大規(guī)模使用 CocoaPods，轉(zhuǎn)用 Carthage 來做包管理需要做大量的轉(zhuǎn)換工作，所以不考慮這個(gè)方案了。
Buck
Buck 是一套通用的構(gòu)建系統(tǒng)，由 Facebook 開源。最大的特色是智能的增量編譯可以極大地提高構(gòu)建速度。最早聽說 Buck 的時(shí)候，它還只能用在安卓上，現(xiàn)在已經(jīng)適配了 iOS。
它能增快構(gòu)建速度的主要原因是緩存了編譯結(jié)果，通過持續(xù)監(jiān)視項(xiàng)目目錄的文件變化，每次編譯時(shí)只編譯有改動(dòng)的文件。另外一個(gè)讓我很受啟發(fā)的功能是 HTTP Cache Server，通過一臺緩存文件服務(wù)器來保存大家的編譯結(jié)果，這樣只要團(tuán)隊(duì)里其中一人編譯過的文件，其他人就不用再編譯了，直接下載就行。
Buck 是個(gè)相當(dāng)完備的解決方案，很多國外的大公司例如 Uber 都已經(jīng)用上。我也花了很多時(shí)間來研究，最終還是認(rèn)為對我們的項(xiàng)目和團(tuán)隊(duì)來說，目前并不是很適合，主要原因是：
- Buck 拋棄了 Xcode 的項(xiàng)目文件，需要手工編寫配置文件來指定編譯規(guī)則，這要對現(xiàn)有項(xiàng)目作出大幅度的調(diào)整。我們目前還在快速迭代新功能，沒有余暇和人手來實(shí)施。
- 開發(fā)和調(diào)試的流程都得做出很大的改變。因?yàn)?Buck 接管了項(xiàng)目編譯的過程，想調(diào)試項(xiàng)目不能簡單地在 Xcode 里面 ?+R 了，得先反過來讓 Buck 生成 Xcode 的項(xiàng)目文件。Uber 的工程師甚至推薦使用 Nuclide 來代替 Xcode 作為開發(fā)環(huán)境。雖然原理上是可行的，但是團(tuán)隊(duì)需要花不少時(shí)間來適應(yīng)，短期內(nèi)效率降低無可避免。
- 用 Xcode 調(diào)試代碼享受不到加快編譯速度的好處。雖然可以用 buck 命令啟動(dòng) App，然后在命令行里啟動(dòng) lldb 來調(diào)試，但那就無法使用 Xcode 的調(diào)試工具 例如 View Debugging 和 Memory Graph Debugger。
Bazel
Bazel 跟 Buck 很相似，是 Google 開源的，優(yōu)缺點(diǎn)跟 Buck 都差不多，不再詳細(xì)說了。
distcc 分布式編譯
原理是把一部分需要編譯的文件發(fā)送到服務(wù)器上，服務(wù)器編譯完成后把編譯產(chǎn)物傳回來。我嘗試了一下比較出名的 distcc，搭建過程比較簡單，最后也能成功地把編譯任務(wù)分派到內(nèi)網(wǎng)的多臺服務(wù)器上。但是其他編譯服務(wù)器的 CPU 占用總是很低，只有 20% 左右;也就是說分派任務(wù)的速度甚至還趕不上服務(wù)器編譯的速度，分派任務(wù)然后回傳編譯產(chǎn)物這個(gè)過程所耗費(fèi)的時(shí)間超過了本地直接編譯。不停調(diào)整參數(shù)反復(fù)試驗(yàn)了很多次，最后發(fā)現(xiàn)編譯時(shí)間完全沒有變快，甚至還有點(diǎn)變慢了。可能以我們目前項(xiàng)目的規(guī)模并不適合使用分布式編譯。
最終方案：CCache
先來看看我對于解決方案的訴求：
- 能大幅度地提升編譯速度，起碼要減少掉 50% 的編譯時(shí)間
- 不需要對項(xiàng)目作出重大調(diào)整
- 不需要改變開發(fā)工具鏈
CCache 是一個(gè)能夠把編譯的中間產(chǎn)物緩存起來的工具，在其他領(lǐng)域已經(jīng)有不少應(yīng)用，只是在 iOS 界的實(shí)踐比較少。經(jīng)過我的實(shí)踐，它能夠滿足我前面的三點(diǎn)要求。我最早認(rèn)識到它是搜到了這篇文章：Using ccache for Fun and Profit | Inside PSPDFKit
如果你不使用 CocoaPods，參照上面的文章即可。因?yàn)獒槍?CocoaPods 需要作出一些額外的調(diào)整，所以還是說明一下。下面就來說說要怎樣把 CCache 應(yīng)用在用 CocoaPods 作為包管理工具的 iOS 項(xiàng)目中。
安裝步驟：
注意：項(xiàng)目路徑不能有中文，否則會(huì)影響 CCache 的正常工作
安裝 CCache
首先你需要在電腦上安裝 Homebrew，對使用 macOS 的程序員來說應(yīng)該是標(biāo)配，略過。
通過 Homebrew 安裝 CCache， 在命令行中執(zhí)行
- $ brew install ccache
命令跑完后即安裝成功。
創(chuàng)建 CCache 編譯腳本
為了能讓 CCache 介入到整個(gè)編譯的過程，我們要把 CCache 作為項(xiàng)目的 C 編譯器，當(dāng) CCache 找不到編譯緩存時(shí)，它會(huì)再把編譯指令傳遞給真正的編譯器 clang。
新建一個(gè)文件命名為ccache-clang, 內(nèi)容為下面這段腳本，放到你的項(xiàng)目里
ccache-clang
- #!/bin/sh
- if type -p ccache >/dev/null 2>&1; then
- export CCACHE_MAXSIZE=10G
- export CCACHE_CPP2=true
- export CCACHE_HARDLINK=true
- export CCACHE_SLOPPINESS=file_macro,time_macros,include_file_mtime,include_file_ctime,file_stat_matches
- # 指定日志文件路徑到桌面，等下排查集成問題有用，集成成功后刪除，否則很占磁盤空間
- export CCACHE_LOGFILE='~/Desktop/CCache.log'
- exec ccache /usr/bin/clang "$@"
- else
- exec clang "$@"
- fi
在命令行中，cd 到 ccache-clang 文件的目錄，把它的權(quán)限改成可執(zhí)行文件
- $ chmod 777 ccache-clang
如果你的代碼或者是第三方庫的代碼用到了C++，則把ccache-clang這個(gè)文件復(fù)制一份，重命名成ccache-clang++。相應(yīng)的對clang的調(diào)用也要改成clang++，否則 CCache 不會(huì)應(yīng)用在 C++ 的代碼上。
- #!/bin/sh
- if type -p ccache >/dev/null 2>&1; then
- export CCACHE_MAXSIZE=10G
- export CCACHE_CPP2=true
- export CCACHE_HARDLINK=true
- export CCACHE_SLOPPINESS=file_macro,time_macros,include_file_mtime,include_file_ctime,file_stat_matches
- # 指定日志文件路徑到桌面，等下排查集成問題有用，集成成功后刪除，否則很占磁盤空間
- export CCACHE_LOGFILE='~/Desktop/CCache.log'
- exec ccache /usr/bin/clang++ "$@"
- else
- exec clang++ "$@"
- fi
完成后項(xiàng)目中應(yīng)該有這兩個(gè)文件
Xcode 項(xiàng)目的調(diào)整
定義CC常量
在你項(xiàng)目的構(gòu)建設(shè)置(Build Settings)中，添加一個(gè)常量CC，這個(gè)值會(huì)讓 Xcode 在編譯時(shí)把執(zhí)行路徑的可執(zhí)行文件當(dāng)做 C 編譯器。
CC常量的值為 $(SRCROOT)/ccache-clang，如果你的腳本不是放在項(xiàng)目根目錄，則自行調(diào)整路徑。如果一運(yùn)行項(xiàng)目就報(bào)錯(cuò)，檢查下路徑是不是填錯(cuò)了。
關(guān)閉 Clang Modules
因?yàn)?CCache 不支持 Clang Modules，所以需要把 Enable Modules 的選項(xiàng)關(guān)掉。這個(gè)問題在 CocoaPods 上如何處理，后面會(huì)講。
關(guān)閉了 Enable Modules 后需要作出的調(diào)整
因?yàn)殛P(guān)閉了 Enable Modules，所以必須刪除所有的 @import語句，替換為#import的語法
例如將 @import UIKit 替換為 #import。之后，如果你用到了其他的系統(tǒng)框架例如 AVFoundation、CoreLocation等，現(xiàn)在 Xcode 不會(huì)再幫你自動(dòng)引入了，你得要在項(xiàng)目 Target 的 Build Phrase -> Link Binary With Libraries 里面自己手動(dòng)引入。
測試效果
嘗試編譯一遍，然后在命令行里輸入 cache -s 就能看見類似下面的 ccache 運(yùn)行情況統(tǒng)計(jì)：
- cache directory /Users/mac/.ccache
- primary config /Users/mac/.ccache/ccache.conf
- secondary config (readonly) /usr/local/Cellar/ccache/3.3.4_1/etc/ccache.conf
- cache hit (direct) 14378
- cache hit (preprocessed) 1029
- cache miss 7875
- cache hit rate 66.18 %
- called for link 61
- called for preprocessing 48
- compile failed 2
- preprocessor error 4
- can’t use precompiled header 70
- unsupported compiler option 2332
- no input file 11
- cleanups performed 0
- files in cache 35495
- cache size 1.3 GB
- max cache size 5.0 GB
如果成功接入，就能看見 cache miss 不為0。因?yàn)榈谝淮尉幾g沒有緩存，肯定是全 miss 的。接著編譯第二遍，如果能看見 cache hit 的數(shù)字開始飆升，恭喜你，接入成功了。
CocoaPods 的處理
如果你的項(xiàng)目不用 CocoaPods 來做包管理，那你已經(jīng)完全接入成功了，不用執(zhí)行下面的操作。
因?yàn)?CocoaPods 會(huì)單獨(dú)把第三方庫打包成一個(gè) Static Library(或者是Dynamic Framework，如果用了 use_frameworks!選項(xiàng))，所以 CocoaPods 生成的 Static Library 也需要把 Enable Modules 選項(xiàng)給關(guān)掉。但是因?yàn)?CocoaPods 每次執(zhí)行 pod update 的時(shí)候都會(huì)把 Pods 項(xiàng)目重新生成一遍，如果直接在 Xcode 里面修改 Pods 項(xiàng)目里面的 Enable Modules 選項(xiàng)，下次執(zhí)行pod update的時(shí)候又會(huì)被改回來。我們需要在 Podfile 里面加入下面的代碼，讓生成的項(xiàng)目關(guān)閉 Enable Modules 選項(xiàng)，同時(shí)加入 CC 參數(shù)，否則 pod 在編譯的時(shí)候就無法使用 CCache 加速：
- post_install do |installer_representation|
- installer_representation.pods_project.targets.each do |target|
- target.build_configurations.each do |config|
- #關(guān)閉 Enable Modules
- config.build_settings['CLANG_ENABLE_MODULES'] = 'NO'
- # 在生成的 Pods 項(xiàng)目文件中加入 CC 參數(shù)，路徑的值根據(jù)你自己的項(xiàng)目來修改
- config.build_settings['CC'] = '$(PODS_ROOT)/../ccache-clang'
- end
- end
- end
需要注意的是，如果你使用的某個(gè) Pod 引用了系統(tǒng)框架，例如AFNetworking引用了System Configuration，你需要在你自己項(xiàng)目的Build Phrase -> Link Binary With Libraries里面代為引入，否則你編譯時(shí)可能會(huì)收到 Undefined symbols xxx for architecture yyy一類的錯(cuò)誤。有點(diǎn)回到了原始時(shí)代的感覺，但考慮到編譯速度的極大提升，這一點(diǎn)代價(jià)可以接受。
集成問題排查
重點(diǎn)關(guān)注日志文件的輸出和ccache -s 命令的統(tǒng)計(jì)，如果在日志中看到了 unsupported compiler option -fmodules 這樣的字眼，就是你的 Enable Modules 沒有關(guān)掉了，根據(jù)前面的步驟仔細(xì)檢查。其他問題，參考官方文檔的 Troubleshooting。
進(jìn)一步的優(yōu)化
移除 Precompiled Header File
PCH 的內(nèi)容會(huì)被附加在每個(gè)文件前面，而 CCache 是根據(jù)文件內(nèi)容的 MD4 摘要來查找緩存的，因此當(dāng)你修改了 PCH 或者 PCH 引用到的頭文件的內(nèi)容時(shí)，會(huì)造成全部緩存失效，只能全體重新編譯。CCache 在首次編譯的時(shí)候因?yàn)樾枰戮彺?，?huì)造成編譯時(shí)間變長，對貝聊的項(xiàng)目來說變長了差不多一倍。因此如果 PCH 或者 PCH 引入的文件被頻繁修改的話，緩存就會(huì)頻繁地 miss，這種情況下還不如不用 CCache。
為了避免以上這種情況，我建議在 PCH 里面盡量少引入頭文件，只保留比較少更改的系統(tǒng)框架和第三方類庫的頭文件。最好是把 PCH 徹底刪除，反正蘋果現(xiàn)在也不建議使用 PCH 了，Xcode 新建的項(xiàng)目默認(rèn)都是不帶 PCH 的。
在團(tuán)隊(duì)內(nèi)部共享緩存文件夾
這個(gè)優(yōu)化方式我嘗試過，最終效果不是很好，因此沒有采用。CCache 的官方文檔中有一段關(guān)于共享緩存文件夾的說明，描述了如何修改 CCache 的配置，讓編譯緩存能夠在多臺電腦之間公用，理論上只要其中一個(gè)人編譯過的文件其他人就能直接下載到了，節(jié)約了整個(gè)團(tuán)隊(duì)的時(shí)間。因?yàn)?Buck 也有類似的機(jī)制，我覺得值得嘗試一下，便在公司局域網(wǎng)內(nèi)搭建了一個(gè) OwnCloud 網(wǎng)盤，讓大家把自己電腦上的 CCache 緩存目錄放上去共享。雖然試驗(yàn)是成功了，但是實(shí)際效果并不好。因?yàn)橥皆诙嗯_電腦上大小達(dá)到幾個(gè)G的緩存目錄，需要在后臺進(jìn)行很多文件的對比和傳輸?shù)墓ぷ?，在編譯的同時(shí)進(jìn)行這些操作會(huì)耗費(fèi)不少計(jì)算資源，反而會(huì)拖慢編譯速度。加上移除掉 PCH 后，其實(shí)緩存的命中率已經(jīng)相當(dāng)可觀了，不太需要通過共享緩存來進(jìn)一步提高緩存命中率，所以我最后放棄了共享緩存這個(gè)想法。如果你對緩存命中率還是不滿意的話，可以考慮往這個(gè)方向嘗試一下。
總結(jié)
通過集成 CCache，我們的項(xiàng)目在 Xcode 里面的打包(在菜單里面選擇 Product -> Archive)時(shí)間從 11~12分鐘減少到了 130 秒，大概有五倍的提升，成果喜人。集成的過程其實(shí)很簡單，我從開始嘗試到集成成功總共就花了兩個(gè)小時(shí)。如果你也被過長的編譯時(shí)間困擾，建議嘗試一下。
