Xcode Concepts

前言

Hi Coder，我是 CoderStar！

距离上次发文已经一个多月了，有许多小伙伴都在问我是不是不更了，其实不是哈，只是调整了节奏，改成了一月一篇，大家看一下这段时间的发文频率应该就能看出来。这篇文章原来准备四月底发出的，但忙着给公司项目写一个简单、轻量的网络抽象层（后面会开源出来，大家轻喷）框架有点耽误了，遂等到了五一后，这个算是四月份的更文，五月份的更文尽量不延期了哈。

这篇文章算是《Xcode系列》的第三篇文章了，前两篇地址如下：

• Xcode 常见 CLI 工具
• Xcode Tips

下面，我们言归正传。

不知道大家会不会思考这样的问题？

• xcodebuild命令的几个参数怎么填，到底是填scheme，还是填target，亦或是其他的？
• CocoaPods是如何将库与工程组合到一起的？
• 多环境配置出包的是选择多target方案还是多configuration方案？
• ...

带着这些问题我们走进今天的文章，了解Xcode的各种Concepts。

Xcode 有比较多的概念，如下有：

• Workspace
• Project
• Target
• Scheme
• Build Setting（Xcconfig）
• Configurations
• Product

是不是有一种感觉：看着就很熟悉，但细细去解释又感觉有点吃力。接下来我们就一起来沿着我的思路回顾一下这些概念。

概念之间是相辅相成的，需要带着整体的思维去理解这些概念，不同章节之间记得联系起来看。

官方对这些概念的解释可以看这篇文档：Xcode Concepts[1]

Product

Product 顾名思义就是 产物，这也是我们使用 Xcode 最终想要生成的东西，这些产物按照 Mach-O Type来划分包括：

• Executable
• Dynamic Library
• Static Library
• Bundle
• ...

这个产物便是我们最终想通过Xcode得到的目标产物，那我们怎么得到这个产物呢，那就涉及到下方的概念了。

Target

一个Target来描述（或者叫做生产）一个Product，那它是怎么描述这个产物呢？

也可以把Target理解成一个最小的编译单元；

Target

如上图所示，Target的设置主要包含七个部分，就不一一列举了，挑几个我觉得需要注意的几个聊一聊吧。

Build Settings

我们对Build Settings应该是比较熟悉的，会经常在里面配置一些参数，其本质就是Target所依赖的参数或者告诉编译器的参数等。具体的参数列举以及说明可以参照 xcodebuildsettings[2]。

配置界面如下图所示，完整的 Build Settings 共有将近 40 项配置内容。从配置界面上看，每一项的配置都有五列（因为项目是CocoaPods管理的，所以会有Project Config文件配置列），可以看到，从左至右的顺序分别是：Resolved 列、Target 列、Project Config列、Project 列、iOS Default 列，每一列所代表的意义如下。

BuildSettingLevel

• Resolved 列：最终确定的编译方式，无法自己设定。其结果是根据其右边四栏的选择结果以及优先级顺序来确定最后编译时采用的编译方式。在图的第二行选项卡中选择 combined 选项，可以直接地看到只有该栏的最后结果；
• Target 列：Target 的 Build Settings 配置的编译选项。可自定义，其优先级最高；
• Project Config 列：Project对应配置的Config文件配置的编译选项，如果没有配置，则没有该列。（相关细节请看下文）
• Project 列：Project 的 Build Settings 配置的编译选项；
• iOS Default 列：在创建项目时系统自带的默认编译选项，无法修改，优先级最低。

整个配置是有优先级的，从左到右优先级依次降低，其中绿色背景就是最终生效的配置，与Resolved列完全对应上。

选中某个配置，前面会出现一个指向右侧的箭头，点击可以展开不同环境（Configuations）的配置选中，这跟Project里面配置的 Configuations是对应上的，具体在Project章节详细介绍。

平时我们配置Build Settings会碰到一些环境变量，这里也稍微列举一下：

• $(PROJECT_DIR) 代表的是整个项目，一般是.xcodeproj文件所在目录；
• {SRCROOT} 包含定义 Target 的 Project 的路径，一般情况下和(PROJECT_DIR)是等价的；
• {PROJECT_FILE_PATH}表示 Project 的当前路径，相当于(PROJECT_DIR)/
• ${PODS_ROOT} 代表的是 Pods 目录，是 CocoaPods 通过 UserDefine 自定义的；
• (inherited) 继承上一级（Project）或依赖项的配置。通过 CocoaPods 集成的项目，(inherited) 将会包含 Pods_xxxx.xcconfig 中的配置；

在设置路径时还有下面两个选项，表示是否递归寻找子目录：

• non-recursive：非递归
• recursive：递归

Info

这里提一下查询Info.plist文件相关键值的文档：AboutInformationPropertyListFiles[3]。

Build Phases

我们可以看到该部分主要分为四项内容，当然也可以手动添加一些脚本在构建过程中运行，如使用Cocoapods管理的项目这里就会增加一些自定义的脚本。

Dependenices

设置Target依赖的其他Target，即该Target的构建必须等到其依赖的Target构建输出之后才可构建。注意这里Target的范围必须是同一Project里面的；

有一些对应的使用场景：

• 宿主程序依赖扩展程序；
• Pod Target依赖三方库Target；
• 单元测试 Target依赖App Target
• ...

Compile Sources

指将有哪些源代码被编译，可以通过对应的【+】【-】按钮进行添加或删除资源来控制编译的代码文件。并且可以通过修改此阶段的 Compiler Flags（编译器标识）来为每个单独文件设置其编译器标识，比如设置是否支持 ARC，是否显示Warning等；

Link Binary With Libraries

指编译过程中会引用哪些库文件，我们同样可以通过【+】【-】按钮进行添加或删除编译所引用的库文件。

这里就不受同一个Project的限制，默认搜索范围会包括整个WorkSpace。

Copy Bundle Resources

指生成的 Product 的 .app 内将包含哪些资源文件，同样可以通过红框中的【+】【-】按钮进行添加或删除资源来控制编译的资源文件。该阶段定义了对象中的资源文件，包括图片，xib文件等等。

从上面的的一些配置大家可以看到，Target本身具备的依赖特性，即 Xcode 会根据依赖顺序构建对应Product；

Project

那上面聊了Target这一概念，我们再聊聊他的上一级 --Project。

一个Project可以包含一个或多个Target，并且为它们提供所需的源文件、资源等等，即所有Target可以共享其所在Project的所有物料，包括源文件、资源文件以及Build Settings等等。

Project

根据上图，我们可以发现其涉及三个Tab：

• Info：基本信息；
• Build Settings：配置；
• Package Dependencies：Package依赖项，也就是我们常说的 SPM；

这里我们只关注一下 Info 所在 Tab 下的部分信息；

Configurations

用来配置Project的 xcconfig 文件，主要用于在几套不同的开发环境编译。

xcconfig 文件其实就是 Xcode 里的 config 文件，本质是一个用来保存 Build Settings 键值对的纯文本文件。形式如下：

ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES
CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = NO

利用xcconfig文件我们可以更方便以及工程化的配置Build Settings。

默认的Configurations有Debug和Release两种，我们可以进行额外的添加，可以利用Configurations这一概念来做多环境配置。

.xcodeproj

这个文件大家应该是很熟悉的，其可以看做是Project的声明文件，我们这里顺便扩展一下这个文件的结构。

xcodeproj文件结构

上图我们可以看到.xcodeproj的文件结构：

• project.pbxproj：想必大家都知道，我们平时在合并分支时经常会解决这个文件的冲突，也是最复杂的一个文件，里面记录代码的结构等信息。
• project.xcworkspace：这个位置的.workspace就不多介绍了，下面统一介绍。
• xcshareddata：主要包括 shared 出去的 Scheme；
• xcuserdata：断点数据 (如果未打过断点，则不会有该文件，如果打过全取消了，该文件也不会被删除，只是内容发生变化)，未 shared 的 Scheme。该文件夹一般是需要被 git 进行忽略的；

Scheme

Scheme 定义一组操作，默认有：Build、Test、Launch、Profile、Analyze、Archive。每一种操作定义了一系列的指令，包括：target、build configuration、arguments、options 等等，这些参数、指令共同构成一个构建方案，从而用于构建一个或多个 Target。

我们可以拥有任意数量的 Scheme，但一次只能激活一个 Scheme，对应在 Xcode 的右上角我们每次只能选中一个 Scheme。

右图我们可以看到Project对应的Scheme，相关的Shared操作与上文提到的xcshareddata文件对应起来。

多环境打包

谈到Scheme就不得不聊聊多环境打包涉及的点了。

通过上述概念的讲解，可以很轻松的知道多环境打包可以在哪些地方做文章，一个是多Target方式，另一个便是多Configurations方式。

一般网上会提到三种方式，但是在我看来，Configurations 与 xcconfig本来就是一种方式，还有什么scheme方式，上面两种方式都是需要增加scheme的，不存在有额外scheme方式。

上面两种方式其实都有各自比较典型的适用场景：

• Configurations：比较适合区别一些环境特征的，比如根据网络环境划分为dev、test、pre、prod等环境的，还有根据环境去区别是否显示内部调试工具的。
• Target：比较适合一套代码出多包的场景，比如两个产品之间有很大比例代码是一致的，则可以使用这种方式去处理，常说的马甲包就是这种套路。

Workspace

在 Xcode 3 以及更早版本的时候，是没有Workspace的概念的，最大的范围便是Project，当时想处理相互关联的项目是很复杂的，而这个问题在 Xocde 4 以及更高版本时得到了解决。

Workspace扩展了整个工作流程的范围，不管是Target之间的依赖关系，还有索引的范围都得到了扩大（代码补全、定义跳转以及其他内容感知的相关功能都可以在 Workspace 下的所有 Project 中使用）。

一个Workspace可以有多个Project，其都是相互独立的，我们可以在不打开 Workspace 的情况下直接打开 Project，一个Project也可以分布在多个Workspace中。通过Workspace，我们可以灵活的组合Project，实现非常庞大、复杂的工程；

默认情况下，Workspace 中的所有 Project 都构建在同一目录中。

Workspace 类似.xcodeproj文件，其不是一个文件夹，而是一个有管理、索引作用的一个文件，结构如下所示：

xcworkspace文件结构

• contents.xcworkspacedata：拥有的 Project 等配置；
• xcshareddata：里面会包含对 IDE 的版本检查，以及 SPM 保存的数据。
• xcuserdata：断点数据 (如果未打过断点，则不会有该文件，如果打过全取消了，该文件也不会被删除，只是内容发生变化)，窗口设置数据；（UserInterfaceState.xcuserstate，为二进制类型），该文件夹一般是需要被 git 进行忽略的；

看到这里想必大家就能明白为什么 Xcode 重新打开项目时，断点以及窗口还会保持原样。

最后

看到这小伙伴们对于文章开头提出的一些问题都有了自己的答案了，建议大家结合CocoaPods对原有工程结构的变化去细细琢磨一下，应该就可以体会到文章提到的概念的一些用处了。

如果还有一些地方不是很清楚，可以私聊，相互交流一下。

要更加努力呀！

Let's be CoderStar!

• Xcode Concept 学习笔记[4]
• 理解 Xcode 中的各种概念[5]
• 理解 Xcode 中的各种文件[6]
• Xcode 工程文件解析[7]
• iOS 项目 Project 和 Target 配置详解[8]

参考资料

[1] Xcode Concepts: https://developer.apple.com/library/archive/featuredarticles/XcodeConcepts/Concept-Targets.html

[2] xcodebuildsettings: https://xcodebuildsettings.com/

[3] AboutInformationPropertyListFiles: https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html#//apple_ref/doc/uid/TP40009254-SW5

[4] Xcode Concept 学习笔记: https://sketchk.xyz/2020/05/14/Xcode-Concept/

[5] 理解 Xcode 中的各种概念: http://chuquan.me/2021/12/03/understand-concepts-in-xcode/#more

[6] 理解 Xcode 中的各种文件: http://chuquan.me/2021/12/14/understand-files-in-xcode/#more

[7] Xcode 工程文件解析: https://looseyi.github.io/post/sourcecode-cocoapods/08-cocoapods-xcodeproj/

[8] iOS 项目 Project 和 Target 配置详解: http://www.liugangqiang.com/2018/03/22/iOS%E9%A1%B9%E7%9B%AEProject%E5%92%8CTarget%E9%85%8D%E7%BD%AE%E8%AF%A6%E8%A7%A3/