pbxproj分析笔记

每种IDE都有自己特定的工程结构，Xcode也不例外， 它的工程描述文件都在.codeproj中， 这是一个目录， 里边包含一个主要的文件：project.pbxproj。 大家对这个文件都不会陌生， 每次合并代码的时候， 最担心的噩梦就是这个文件的冲突。要避免或者解决这些冲突的第一步， 就是先了解这个文件的结构。

project.bpxproj

project.pbxproj其实就是一个JSON， 只不过带上了一些注释，便于理解而已。为了简单， 我们忽略掉一些无关紧要的字段， 我们发现， 这个JSON其实是一个树形结构：

project.pbxproj.png

project.pbxproj主要包含两个子节点：objects 和 rootObject.
objects是包含所有节点的字典， rootObject指向objects中的PBXProject节点。

PBXProject

从上图可以看到， 这个节点有四个主要节点(子树)：

• buildConfigurationList, 对应编译参数设置。
• mainGroup， 对应工程文件结构。
• projectReferences， 工程之间的引用关系。
• targets, 每一个target对应一个product输出， target用来管理这个product的编译参数以及需要编译的文件。

PBXGroup

这个就是我们在Xcode窗口左侧看到的树形结构。主要就是用来组织工程所包含的文件的结构。

PBXGroup可以有多种类型子节点：

• PBXGroup
• PBXFileReference, 普通文件， 比如图片资源， 代码文件， framework， 子工程等。
• PBXReferenceProxy, 指向子工程编译出来的文件(子工程product目录下的.a, .bundle等)
• PBXVariantGroup, 指向放在 .lproj 中的本地化文件， 比如.strings等。

XCConfigurationList

这个主要就是build settings界面内容。 分别可以设置 project 和 target的编译选项。

project references

这个配置工程所依赖的其他工程。
每个工程依赖包含两个部分：

• ProductGroup： 指向所依赖的工程的productRefGroup
• ProjectRef: 指向代表该依赖工程的PBXFileReference

targets

target也是一个重要的子树。
主要包含以下三部分(子树):

• buildConfigurationList: 该target的编译选项配置
• dependencies: 该target依赖的其他 target / 子工程 信息。
• buildPhases: 该target编译需要的文件信息， 比如源码， 资源， 库等。

一些主要/特殊Object

PBXFileReference

每个file reference节点代表一个文件， 因此如果有多个file reference节点指向同一个物理文件， 那么这些节点可以合并成一个。

有些特殊目录也可以是一个file reference, 比如.xib, .assets, .bundle, .framework等。

PBXVariantGroup

同file reference. 一个目录下，多个.lproj 子目录下的同名文件可以视为同一个文件的不同语言版本。 因此一个本地化文件应该只存在一个 variant group, 多余的应该合并。

PBXReferenceProxy

同file reference. 只不过代表的是本工程引用的另外一个工程。它通过remoteRef属性指向一个 PBXContainerItemProxy节点(proxyType=2)。

PBXBuildFile

设置file reference (包括PBXVariantGroup, PBXReferenceProxy等) 的编译设置， 比如-fno-arc等。

同一个file reference, 在不同的target里边， 分别对应多个build file, 可以设置不同的编译参数。 因此， 如果在同一个target里边，如果有多个build file指向一个file reference, 那么可以认为这些build file是重复的。

PBXContainerItemProxy

目前发现有两种proxyType:

• proxyType=1: 用于代理主工程target对子工程target的编译依赖。显示在Xcode窗口右侧build phase->Target Dependencies中。
• proxyType=2: 用于代理子工程(或者本工程其他target)编译结果文件(.a, .bundle等)的文件依赖， 也就是会显示在xcode窗口左侧的文件树中。

主要属性：

• containerPortal: 指向代表子工程的PBXFileReference节点。
• remoteGlobalIDString：
  • 当proxyType=1时， 指向子工程的target节点(被依赖的target)
  • 当proxyType=2时， 指向另一个target(子工程或者本工程)的编译输出文件。

因此， 如果有两个PBXContainerItemProxy节点， containerPortal和remoteGlobalIDString都相同， 那么可以认为这俩节点是重复的。

工具

Github 地址： https://github.com/alexlee002/XcodeScripts

功能：

• project.pbxproj 文件解析与修改接口。
• project.pbxproj 优化(节点校验， 无效节点清除，重复节点清楚等)

开发中：

• project.pbxproj版本冲突自动解决功能。