你是否好奇 CocoaPods 究竟是如何改寫 Xcode 專案結構的?是否曾被 project.pbxproj 裡密密麻麻的內容搞得頭暈?本文作為系列首篇,試著把這個檔案的組織方式講清楚。
CocoaPods 是一套以 Ruby 撰寫的第三方庫,能便利地增刪與更新依賴。當你改完 Podfile 執行 pod update,Xcode 專案就被「神奇地」改寫了——祕訣在於每個 Xcode 專案都有一個 project.pbxproj 檔記錄著整個專案的檔案結構,而 CocoaPods 正是透過它的元件 Xcodeproj 來完成修改。
用過 SVN 或 Git 做團隊協作的人,大概都遇過這種情況:合併程式碼時因為有檔案增刪,導致 Xcode 專案打不開。常見的解法是打開 project.pbxproj,用 Command+F 搜尋 ====== 或 <<<<<<< 找到衝突處刪掉。但很多人並不清楚為什麼這樣做、裡面的內容究竟是什麼意思。
project.pbxproj 採用老式風格的 plist(old ASCII plist),這最早是 Next 公司的格式,與 XML 有相似之處但又不完全相同。建議邊讀邊開一個實際專案對照,理解會快很多。
檔案中出現的元素大致有:
PBXBuildFile、PBXBuildPhase、PBXAppleScriptBuildPhase、PBXCopyFilesBuildPhase、PBXFrameworksBuildPhase、PBXHeadersBuildPhase、PBXResourcesBuildPhase、PBXShellScriptBuildPhase、PBXSourcesBuildPhase、PBXContainerItemProxy、PBXFileElement、PBXFileReference、PBXGroup、PBXVariantGroup、PBXTarget、PBXAggregateTarget、PBXLegacyTarget、PBXNativeTarget、PBXProject、PBXTargetDependency、XCBuildConfiguration、XCConfigurationList
在「萬物皆物件」的視角下,可以把它們理解為一個個類,而它們的子項就是物件。最外層的每個元素(如 PBXBuildFile)稱為一個 Section。下文一律用「類」與「物件」來稱呼。
// !$*UTF8*$!
{
archiveVersion = 1;
classes = { };
objectVersion = 45;
objects = { ... };
rootObject = 0867D690FE84028FC02AAC07 /* Project object */;
}實際開檔時你會看到一樣的結構,只是 objects 裡的各種類屬於第二層,而 rootObject 位於檔案最後一行。
rootObject 後面那串 24 位十六進位數字,就是每個物件的唯一標識碼,它在整個專案中用來唯一標識該物件。Xcode 產生它的演算法可能引入了日期、序列與其他預定義值,官方並未公開確切規則。值得注意的是,這個標識碼不僅在當前專案內唯一,而且是跨專案唯一的。
PBXBuildFile 是「檔案類」,被 PBXBuildPhase 等作為要包含或被引用的資源。以下是一個新建專案 Xcode工程Demo 的結構:

此時 project.pbxproj 中 PBXBuildFile 的內容如下:

每個 PBXBuildFile 物件都由這樣的結構組成:
4D05CA6B1193055000125045 /* xxx.c in Sources */ = {
isa = PBXBuildFile;
fileRef = 4D05CA411193055000125045 /* xxx.c */;
};
其中 isa 如同 Objective-C 物件中的 isa 指標,指向它的類;fileRef 則指向一個 PBXFileReference 物件。
仔細對比會發現:圖 1 的檔案樹與圖 2 的數量不一致,卻與編譯時的檔案及資源清單吻合。前者差異來自 PBXFileReference;而由此可以推測,PBXBuildFile 中記錄的是編譯時需要確認的檔案與資源集合。拖幾張圖片進專案再驗證,結果與推測一致。
PBXFileReference 用於追蹤專案引用的每一個外部檔案:原始碼、資源、庫、產物等。

結構如下:
87293F901153D870007AFD45 /* objc.mm */ = {
isa = PBXFileReference;
fileEncoding = 4;
lastKnownFileType = sourcecode.cpp.objcpp;
name = monobjc.mm;
path = sources/monobjc.mm;
sourceTree = "";
};把 PBXBuildFile 與 PBXFileReference 放在一起對照:

AppDelegate.swift 這個 build file 透過 fileRef 指向標識符為 F3E1481A1DA50A180059397C 的 PBXFileReference 物件,藉由這層引用,就能查到它的 fileType、name、path 等具體資訊。
PBXGroup 用於組織群組,或者巢狀群組。

同樣透過唯一標識碼組裝,每個 PBXGroup 物件都有一個 children 屬性,裡面可以是任何一種類的物件。要留意的是,這裡的 PBXGroup 描述的是 Xcode 中的邏輯分組,與實際檔案系統的目錄結構並不相同;而 children 中的檔案物件屬於 PBXFileReference 類,而非 PBXBuildFile。
PBXNativeTarget 就是專案中的 target,多 target 專案都會在此處有所體現。

每個 target 都有 Compile Sources、Copy Bundle Resources、Link Binary With Libraries 三項需要編譯時確定的內容,透過 buildPhases 屬性可以找到對應資訊。
前者用於編譯原始碼,後者用於複製資源檔。

注意:這兩個 section 中放的是所有 target 的同類物件,而非僅當前 target。
PBXProject 標識整個工程,由根節點的 rootObject 引入。

它記錄著 targets、mainGroup 等重要資訊,甚至每個 target 建立時所用的 Xcode 版本也在其中。
還有許多值得研究的成員,例如記錄工程配置資訊的 XCConfigurationList 與 XCBuildConfiguration。
看起來令人生畏的 project.pbxproj,其實結構相當規整,也從側面反映了 Xcode 檔案組織的嚴密。建議動手改改專案內容,再觀察配置檔的變化,往往能有更深的體會。
下一篇將帶大家用 Xcodeproj 這個 Ruby 庫,以幾行程式碼修改 project.pbxproj,實現用腳本自動化修改與分析 Xcode 工程。