Xcode 工程分析

Xcode作為日常開發iOS程式的IDE，支持C、C++、Objective-C、Swift、Ruby等語言進行編寫。日常開發入口就是Xcode workspace或者Xcode project。

workspace是一個Xcode文檔，它將項目和其他文件、project分組。一個workspace可以包含任意數量的Xcode project，以及資源文件（JSON、腳本、圖片、視頻等）。workspace除了組織每個project中的文件外，還提供了所包含項目及其目標之間的隱式和顯式關係。

project就是一個 Xcode 工程，它是實際管理工程下 targets 、源碼、資源文件、framework 等。project 只是一個容器，本身是無法被編譯的，所以每個 project 至少應該有一個可編譯的 target, target下需要包含可編譯的源碼。

在日常開發中難免會去在非Xcode的環境下去操作workspace或者project中的依賴關係，所以搞懂workspace、project、源碼和資源文件之間的關係就顯得特別重要，因為知道怎麼來的才知道去如何做。

由上圖可以簡單看出workspace和project的關係：

• 一個workspace里可以包含多個project

• 一個project里包含多個target

• configuration 即Xcode中的Debug/Release 等工程配置

• scheme 配置target編譯參數

• 每個target即每次編譯生成對應產物：app或者framework

   

新創建一個空的workspace，直接看他的層級樹：

可以看到workspace主要包含三個層級：

• xcworkspacedata，workspace的配置文件，實際上就是一個XML文件。

• xcshareddata：可共用的配置，包含scheme、script等信息。

• xcuserdata：當前用的配置，包含本地scheme、script、斷點信息等。

以報價項目為例詳細查看 contents.xcworkspacedata的內容：

FileRef 顧名思義它是標記了每個文件在workspace中的路徑關係，這個關係決定的在Xcode中的project的展示層級。

location的關鍵字包含如下：

• self：當前文件夾下的同名project

• group：指定目錄下的xcodeproj文件

• container：workspace當前目錄下的不同名的xcodeproj文件

• absolute:絕對路徑下的文件

由對workspace的探尋我們可以看到，workspace確實只是把project等文件組織起來的一個工作空間，本身並不具備對源碼、資源的編譯、整合能力，進一步探尋到project文件，我們才能看到源碼、資源文件等是怎麼被整合起來的。

由上圖可看到，xcodeproj里包含了三個大的層級，xcuserdata里包含的常用的scheme和配置文件，還包含了一個xcodeworkspace，這是為了保證Xcode的相容性，維持Xcode管理文件邏輯的統一。

xcodeproj中包含了開發中所需要的全部文件，管理了當前工程所有的源碼、資源文件、配置文件等。重點是pbxproj文件，它與我們正常編譯代碼密切相關，管理target、文件之間的引用依賴關係、合併代碼時候產生的文件衝突就在這裡。

pbxproj全拼是Project Builder Xcode Project，它其實是我們熟悉的plist文件的一種，但是它不像我們常用的plist文件有著優越的可讀性，由於歷史原因它才被Xcode一直保存下來。

pbxproj中定義了target、script、文件、configuration等之間的引用關係，我們看到的Xcode項目佈局實際上是可視化了pbxproj。

直接看看pbxproj的內部佈局吧：

可以看到，最外層包含了這些屬性：

• archiveVersion 當前文件版本

• classes 占位符

• objectVersion 當前文件需要的 Xcode最低版本

• objects 以每個object的uuid為key的字典,存放了object屬性

• rootObject 當前文件的根object (isa = PBXProject)

objects里實際上存放的就是每個文件之間的依賴關係，我們稱每個文件是一個Xcode object，這個Xcode object不僅僅可以是源碼文件，也可以是group、framework、app、target、scheme等。

由上圖的rootObject = D9658FA7290BA51D00A72187，我們簡單看一下它作為Xcode object的內部結構：

可以看到比較重要的信息是isa、mainGroup、configration、target，其他信息也都包含了Xcode中我們見到的、可以配置的全部信息。

這隻是PBXProject中的信息，全部信息可在官網進行查詢。下麵列出了所有的類型配置：

• PBXProject：Project 配置，編譯工程所需信息

• PBXNativeTarget：Target 的配置

• PBXTargetDependency：Target 依賴關係配置

• PBXContainerItemProxy：部署的元素

• XCConfigurationList：Xcode中configuration配置

• XCBuildConfiguration：Xcode 的 Build Settings 配置

• PBXVariantGroup：storyboard 文件配置

• PBXBuildFile：各類文件配置

• PBXFileReference：各類文件引用配置

• PBXGroup：Xcode中的group

• PBXSourcesBuildPhase：需要編譯的編譯源文件

• PBXFrameworksBuildPhase：需要編譯的framework

• PBXResourcesBuildPhase：除源碼外的資源文件

他們之間的關係大致如下

瞭解了各個文件之間的關係，可以為我們以後通過腳本去動態添加、刪除、移動文件、修改build settings、scheme等操作打下基礎。

scheme不是編譯target的必要條件，沒有scheme不影響Xcode的編譯操作，但是，沒有scheme我們就沒辦法在編譯時傳入參數條件，插入編譯腳本，配置個性化編譯配置，所以scheme是Xcode編譯時的必須選項。

打開一個scheme源文件，我們可以看到如下佈局：

可以看到，最外層包含著build、test、launch、profile、analyze、archive。恰好對應了Xcode中的與之對應的命令，再次驗證了Xcode就是pbxproj的可視化呈現。

進入BuildAction可以看到我們在Xcode中添加的預編譯腳本和各種環境變數配置，這些配置有的是在編譯過程中必不可少的參數，有的是方便我們管理編譯產物的必須配置，靈活運用這些配置，可以讓Xcode更好的為我們服務。

target用於指定要構建的產物，即framework或者app。target只包含了當前project中的部分指定的代碼和資源文件，每一個target只能構建出一個特定的構建產物，為了豐富構建產物，一個project可以擁有多個target。

target使用Build Settings和Build Phases的形式來進行個性化配置，預設這些配置可以通過project繼承，也可以通過手動或者配置文件的方式覆蓋其他配置。

target之間可以互相依賴，如果是在同個workspace下，Xcode預設會觸發隱式依賴，當然，如果用手動配置依賴關係，則會變為顯式依賴。顯式依賴的優先順序高於隱式依賴。

根據上面的介紹，大家一定對Xcode的工程配置有了一定的瞭解，在瞭解了這些之後，我們能做些什麼呢？其實是有很多玩法的：

• 根據不同的編譯scheme編譯指令，提取出編譯產物，分發給不同的人員。

• 根據target的不同，在不改變源碼的前提下，每次編譯設置不同的環境測試包。

• 編譯過程中檢查出警告信息及時上報開發人員。

• 編譯時找出無效代碼及文件。

• 利用cocoapods的動態配置在安裝的時候直接引入二進位組件以增加編譯速度。

• 輸出指定framework的編譯日誌到文件方便對比查閱。

瞭解了這些基礎配置，以後在項目的工程化方面才有更多手段解決重覆度高或者棘手的問題，還有更多的新玩法可以在工作過程中發掘。

作者|王一飛