XCConfig不完全指南

0.先写结论，

XCConfig file的目的是供XCode在编译期间，对xcproject文件做变量替换的文件。

如在dev.xcconfig里定义了MIF_APP_NAME = 装修宝测试，那么在project - > General (tab) - > Identity 里使用变量${MIF_APP_NAME}。

使用变量设置APP name

注意：这个选项的下面Bundle Identitier 里是无法使用相同的方式使用变量的（原因待查），如果需要设置APP ID的属性，去project - > Build settings (tab) - > Packaging里找到PRODUCT_BUNDLE_IDENTIFIER设置即可

1
2
3
4
5
6
7
8


//:configuration = Debug
PRODUCT_BUNDLE_IDENTIFIER = ${MIF_APP_IDENTIFIER}

//:configuration = Release
PRODUCT_BUNDLE_IDENTIFIER = ${MIF_APP_IDENTIFIER}

//:completeSettings = some
PRODUCT_BUNDLE_IDENTIFIER

1. 设置xcconfig文件的步骤

XCode原生就支持使用XCConfig file来对不同的编译对象做区分，所以分了两组：Debug和Release，当然你还可以创建额外的配置文件。见project -> info(tab) - > configurations,如图

两个默认的配置文件

稍微解释下，所有的xcconfig都支持继承关系，也就是说project的xcconfig文件会被下面的target所继承，如果是所有target都用一套xcconfig，那么只需要设置project的Configuration Set 就可以了。详细的继承关系，见文章，The Unofficial Guide to xcconfig files。

2.xcconfig的变量

一旦设置了xcconfig，需要注意xcconfig的格式。现在网络上已经有很多xcconfig的模板，你可以直接去上面下载，如**App-iOS.xcconfig**，下载这些文件，你可以简单的看下，哪些是可以定义的，定义数据的格式等。

xcconfig文件的格式是一行一个变量（这句话很重要）变量和值之间用=号连接，=号和左值右值之间可以有任意个空格。

实例，

1
2
3


MIF_APP_NAME = 装修宝测试

GCC_PREPROCESSOR_DEFINITIONS = $(inherited) MIF_DB_ENCRYPTION=1

配置完毕之后，你可以检测是否配置的正确，如图位置

检验xcconfig是否生效

3. 用xcconfig配置`Preprocessor Macros`

特别注意到

1

GCC_PREPROCESSOR_DEFINITIONS = $(inherited) MIF_DB_ENCRYPTION=1

他实际上是一行。GCC_PREPROCESSOR_DEFINITIONS =关键点，表示去设置Build Settings的Preprocessor Macros，在=号后面的是要设置的macro的定义。特别强调Preprocessor Macros的定义里=号前后必须没有空格，如MIF_DB_ENCRYPTION=1是正确的写法，而MIF_DB_ENCRYPTION =1会引起编译错误，在pch那里提示无法找到库文件之类的莫名其妙的错误提示。

4.坑

在写本文之前，我的需求就是在xcconfig里去设置macro定义，这样我就可以在dev阶段不加密数据库，线上数据加密数据库这样的逻辑。因为我以前工作的工程就是这样用的。但是按照网上的xcconfig模板写了始终显示未定义。通过搜索，假设了以下几种我可能的错误。

需要自定义Configurations，不能用默认的
将xcconfig里的配置写到Macro定义是Pod做的手脚，所以看了Pod自定义的xconfig文件，还包括Pad的Run Script
这个特性需要在启用了xcworkspace的情况下。但是我不想用啊，因为我是用Carthage构建的。
网上的资料基本都是在讲模块如何定义，怎么使用都没有提及。我是不是没有找到xcconfig的正确打开方式。
旧工程里在Preprocessor Macros的配置里有特殊的写法吗？经过仔细排查没发现特别

后来发现都不是上述的原因。直到我通过对比旧的Pod工程里，在User-defined那里也只显示出来每个独立一行的数据，其他在GCC_PREPROCESSOR_DEFINITIONS =后面的配置全没有显示出来，这时候才幡然醒悟，意识到一行一个变量的重要性。事实上**GCC_PREPROCESSOR_DEFINITIONS =将后面所有的字符串作为一个值重新赋值**，所以在代码里可以使用

1
2
3
4


#if MIF_DB_ENCRYPTION == 1
#elif
#else
#endif

的语法编写条件编译语句。详细的C语言条件编辑语法见，Simplest programming tutorials for beginners

#参考

EOF

Contents

0.先写结论，

1. 设置xcconfig文件的步骤

2.xcconfig的变量

3. 用xcconfig配置Preprocessor Macros

4.坑

3. 用xcconfig配置`Preprocessor Macros`