pbxproj分析笔记

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

project.bpxproj

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


project.pbxproj.png

project.pbxproj主要包含两个子节点:objectsrootObject.
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节点, containerPortalremoteGlobalIDString都相同, 那么可以认为这俩节点是重复的。

工具

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

功能:

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

开发中:

  • project.pbxproj版本冲突自动解决功能。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,905评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,140评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,791评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,483评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,476评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,516评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,905评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,560评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,778评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,557评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,635评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,338评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,925评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,898评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,142评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,818评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,347评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,579评论 18 139
  • feisky云计算、虚拟化与Linux技术笔记posts - 1014, comments - 298, trac...
    不排版阅读 3,813评论 0 5
  • 物欲横流随世去 寻得苦恼在心间 不如仿效陶公令 醉赏桃林步入巅 (中华新韵)
    小启明星阅读 217评论 4 13
  • 近日,《欢乐颂2》火得不要不要的,《欢乐颂》里戏分不多的杨烁荣升男一号撩翻安迪,令万千女粉丝狂舔屏,但是也被某些网...
    电娱时代阅读 283评论 0 0
  • 1.感恩上帝的关爱,给我一个温暖幸福的家,有体贴的先生和三个积极向上,善良幽默的孩子,让我天天都很开心。 2.感恩...
    金刚家人阅读 153评论 0 2