通过Xcodeproj深入探究Xcode工程文件一

前言

你是否好奇Cocoapods是如何修改掉Xcode工程的结构?你也是否曾被Xcode工程的配置文件里面杂乱的内容搞得摸不清头脑?你又是否知道Xcodeproj这个神奇的Ruby库?下面我将通过这个系列来解除你的困惑。

Cocoapods是如何修改Xcode工程结构的?

我们知道Cocoapods是用ruby创作的一套第三方库,它很方便的可以删除、添加、更新第三方库?当你执行修改完PodFile执行pod update的时候,你会惊讶的发现Xcode工程被神奇的修改掉了。那么它是如何做到的呢?细心的你会发现,每个Xcode工程都有一个project.pbxproj文件,这个文件记录着该工程的文件结构。Cocoapods正是通过它的组件Xcodeproj来对工程结构进行修改。

project.pbxproj这个文件里面的内容到底是什么含义?

如果你使用过SVN或者Git进行团队协作开发肯定会不可避免的遇到在合并代码的时候往往由于有过添加和删除文件的操作导致Xcode工程报错打不开,这时候一般的解决思路是打开project.pbxproj文件,Command+F键入======或者<<<<<来找到冲突的地方,将冲突的内容删除。然而有些人并不知道为何要这样解决甚至不知道里面的内容是何意思?下面的内容或许对你有些许帮助。

project.pbxproj介绍

project.pbxproj采用的是老式风格的plist文件(old ASCII plist),这最早是Next公司采用的一种文件格式,它跟XML格式很多地方类似,但是又有些许的不同。为了更方便理解,我建议你新建一个工程或者在以后的工程上打开project.pbxproj,在实例的基础上便于直观感受,更有助于
加深理解。

首先我要介绍它里面的众多元素,例如

根节点
PBXBuildFile
PBXBuildPhase
PBXAppleScriptBuildPhase
PBXCopyFilesBuildPhase
PBXFrameworksBuildPhase
PBXHeadersBuildPhase
PBXResourcesBuildPhase
PBXShellScriptBuildPhase
PBXSourcesBuildPhase
PBXContainerItemProxy
PBXFileElement
PBXFileReference
PBXGroup
PBXVariantGroup
PBXTarget
PBXAggregateTarget
PBXLegacyTarget
PBXNativeTarget
PBXProject
PBXTargetDependency
XCBuildConfiguration
XCConfigurationList

在万物皆对象的概念下,你尚可将他们理解为一个个类,它们里面的各个子元素就是一个个对象。最外层的每个元素如PBXBuildFile被称为一个个
Section,为方便理解,文章后面的内容我都将这些元素称为类,将元素的实例成为对象。

project.pbxproj的整体结构(根节点)

// !$*UTF8*$!
{    archiveVersion = 1;
    classes = { };
    objectVersion = 45;
    objects = {...};
    rootObject = 0867D690FE84028FC02AAC07 /* Project object */;
}

如果你已经打开了一个project.pbxproj,你就会很容易看到这种结构,只不过objects里面的各种类属于第二层结构,rootObject位于文件的最后一行。

唯一标识码

细心的你会看到,上面的根节点里面的rootObject后面是一串24位的16进制数,它就是每个对象的唯一标识码,它可以唯一标识文件的每个对象,也就是说
每个元素的标识码都是不同的。Xcode生成唯一标识码的算法可能引入了日期、序列和其它一些预定义的值，但是并没有确切的文档说明具体的生成过程。值得注意的是,该唯一标识码不仅在所在的工程中唯一,而且还是跨工程唯一。

PBXBuildFile

PBXBuildFile是文件类，被PBXBuildPhase等作为文件包含或被引用的资源。此时我已经新建了一个名为Xcode工程Demo的工程,此时的工程结构是这样,如图1所示。而此时的project.pbxproj中PBXBuildFile的结构如图2所示。

图1

图2

可以清楚的看到每个PBXBuildFile对象都是由以下的结构组成

4D05CA6B1193055000125045 /* xxx.c in Sources */ = {    isa = PBXBuildFile;
    fileRef = 4D05CA411193055000125045 /* xxx.c */;
};

图3

其中isa跟Objc中的对象的isa指针一样,指向的是它的类,而fileRef则指向的是一个PBXFileReference对象,这个类将在下面介绍。
细心的你又会发现,为什么图1和图2中的文件个数不一致,却和图3中编译时的文件和资源统一。前者的差异是由于PBXFileReference所致,通过后者我们可以大胆猜测,PBXBuildFile中的对象是编译时候需要确认的文件和资源的集合,如果不信的话可以拖几张图片资源扔进工程中
,经过验证结果和预测的情况一致。

PBXFileReference

PBXFileReference用于跟踪项目引用的每一个外部文件，比如源代码文件、资源文件、库文件、生成目标文件等。具体表现如图4。

图4

它的结构如下:

87293F901153D870007AFD45 /* objc.mm */ = {    isa = PBXFileReference;
    fileEncoding = 4;
    lastKnownFileType = sourcecode.cpp.objcpp;
    name = monobjc.mm;
    path = sources/monobjc.mm;
    sourceTree = "";
};

里面的每个key的含义,对照着实际工程,大家不妨自行揣测。
我们再将PBXBuildFile和PBXFileReference放一起进行对比,如图5。

图5

AppDelegate.swift对象通过fileRef指向标识符为F3E1481A1DA50A180059397C的PBXFileReference对象,通过这个引用,一个PBXBuildFile

对象就可以查到自己的具体信息,如fileType、name和path等信息。

PBXGroup

PBXGroup用于组文件，或者嵌套组。让我们来看下实例,如图6

图6

怡然是通过唯一标识符组装,每个PBXGroup对象都有一个children属性,里面可以是任何一种类的对象。但是这时候的PBXGroup指的是Xcode里面组织的分组结构,和实际文件系统中的结构并不相同。
指的注意的是,children中的每个文件对象都属于PBXFileReference类,而不是PBXBuildFile类

PBXNativeTarget

PBXNativeTarget就是工程中的target,如果工程中有多个target,都会在这个section中有所体现。
实例中如图7所示

图7

我们都知道每个target都有Compile Sources、Copy Bundle Resources、Link Binary With Libiaries这三个需要在编译时确定的内容。
而在PBXNativeTarget中通过buildPhases属性可以找到对应的内容。

PBXSourcesBuildPhase和PBXResourcesBuildPhase

PBXSourcesBuildPhase用于构建阶段中编译源文件,PBXResourcesBuildPhase用于构建阶段需要复制的资源文件,如图8

图8

需要注意的是,PBXSourcesBuildPhase这个section中放着所有的target的同类对象,PBXResourcesBuildPhase也是一样。

PBXProject

PBXProject标识着整个工程,由根元素的rootObject引入。如图9所示

图9

该对象记录着targets、mainGroup等重要信息,甚至每个target在创建时候的Xcode版本都会记录在其中。

其他元素

还有其他很多重要的元素,如记录工程配置信息的XCConfigurationList和XCBuildConfiguration等,大家可以自行研究研究。

总结

通过上面的内容,我画了一张图总结一下,如图10

图10

由此看来,以前看到就头疼的project.pbxproj配置文件的内容并没有想象中的复杂,也可以看出Xcode文件组织的严密和周整。

大家自己研究的时候,不妨可以动手改改项目中的内容,再去观察配置文件的变化,这样既可以有更深的理解,或许有新发现也说不定奥。

下篇文章,我将带大家用Xcodeproj这个库来,通过几行代码修改project.pbxproj中的内容以达到通过脚本去修改Xcode工程和分析工程的目的。

原文链接：http://www.tomorjm.com/year/10/05/通过Xcodeproj深入探究Xcode工程文件%20一/