Xcode多环境配置一共有3种形式:
- Target
- Scheme
- xcconfig
Project:包含了项目所有的代码、资源文件、所有信息。(一个项目是多个project的集合)
Target:对指定代码和资源文件的具体构建方式。(指定某些代码如何生成ipa
包,类似打工人的角色)
Scheme:对指定Target的环境配置。(配置编译环境变量)
这也就是我们修改一些配置的时候需要选中Target
再去修改的原因。
多Target配置
在项目中选中Target
复制就生成新的Target
了。
在这里复制后并没有产生额外代码,只是复制了一个新的构建模式。
相当于可以直接分别配置
Info.plist
文件,在Target
中修改bundleId
后就相当于两个Target
是两个App
了。同时可以在
Preprocessor Macros
中配置一些宏定义用于代码中区分Target
。比如在
OC
和Swift
混编的时候,在OC
中导入头文件就可以用这个宏来处理:
#if DEV
#import "TestMutableConfig_dev-Swift.h"
#else
#import "TestMutableConfig-Swift.h"
#endif
对应的Swift
文件:
在
Swift
中也可以用Swift
宏来处理:在
Other Swift Flags
中配置变量- D DEV
(空格有没有都行)#if DEV
func log(message: String) {
print(message)
}
#endif
➜ ~ swiftc --help | grep -- '-D' -D <value> Marks a conditional compilation flag as true
Target
方式配置多环境
1.会生成多个Info.plist
文件;
2.配置比较繁琐,需要同步配置容易混乱
那么对于多Target
的场景是可以在Build Phases
中控制要编译的文件和资源。
多scheme配置
scheme
默认有Debug
和Release
的config
我们可以按需添加。在Target
中添加变量的时候已经用到过了。
配置在Project -> Info -> Configurations
中
比如我们有appStore包,有企业包。那么各复制一份对应的
Debug
和Release
(最好是配置完成后再复制)运行/打包的时候选择对应的
Scheme
就可以了。这种情况下运行不同配置的时候需要来回切换。
可以通过创建
Scheme
对应不同config
:这个时候只需要切换
Scheme
运行就可以了。比如我们上传打包
ipa
的时候,有时候会错将debug
模式下的包上传上去,尤其是在发灰度包的时候。这里有两个方案:1.通过
config
配置。2.打包的时候通过脚本修改
info.plist
文件增加一个变量。
release
包赋值为0
,debug
包赋值为1
。这样在上传ipa
包的时候后端读取Info.plist
做判断,debug
包直接报错不让传。
这里实现以下方式1:
Targets -> Build Settings -> + -> Add User-Defined Setting
:
添加一个
IPAFLAG
,release
模式下是1
,debug
模式下是0
:Info.plist
文件中增加配置:到这里就完成了
-
User-Defined
添加配置; -
Info.plist
暴露配置的目的。
在代码中测试下:
NSString *infoPath = [[NSBundle mainBundle] pathForResource:@"Info" ofType:@"plist"];
NSDictionary *infoDic = [[NSDictionary alloc] initWithContentsOfFile:infoPath];
NSLog(@"IPAFLAG = %@",infoDic[@"IPAFLAG"]);
Debug
下:
IPAFLAG = 1
当然也可以配置app图标:
在Assets.xcassets
中添加不同的资源文件
Scheme
还可以控制传递参数等,一般不常用。
多Scheme
情况只需要在一个build setting
中就能完成配置了,比多Target
方便好维护。
缺点是还需要在build setting
中设置。
xcconfig
这个我们平时都接触到了,可能好多人没有注意到,用的最广泛的就是cocoapods
。
比如Other Linker Flags
、Search Paths
。
那么
Cocoapods
是怎么配置的呢?就是使用
xcconfig
配置的:
FRAMEWORK_SEARCH_PATHS = $(inherited) "${PODS_CONFIGURATION_BUILD_DIR}/AFNetworking"
GCC_PREPROCESSOR_DEFINITIONS = $(inherited) COCOAPODS=1
HEADER_SEARCH_PATHS = $(inherited) "${PODS_CONFIGURATION_BUILD_DIR}/AFNetworking/AFNetworking.framework/Headers"
LD_RUNPATH_SEARCH_PATHS = $(inherited) '@executable_path/Frameworks' '@loader_path/Frameworks'
OTHER_LDFLAGS = $(inherited) -framework "AFNetworking"
PODS_BUILD_DIR = ${BUILD_DIR}
PODS_CONFIGURATION_BUILD_DIR = ${PODS_BUILD_DIR}/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)
PODS_PODFILE_DIR_PATH = ${SRCROOT}/.
PODS_ROOT = ${SRCROOT}/Pods
USE_RECURSIVE_SCRIPT_INPUTS_IN_SCRIPT_PHASES = YES
xcconfig
是key-value
的形式配置的。那么怎么对应到xcconfig
文件的呢?
在
Configurations
中对应配置的。
配置自己的xcconfig
文件
新建 -> Configuration Settings File
命令规则为:
以所在目录开头-工程名称.config名称/环境名称
,比如Config-TestMutableConfig.Debug
接着可以在
config
中选择配置-
1
中设置是对整个Project
生效。 -
2
中设置是对Target
生效。
还是以IPAFLAG
为例,以xcconfig
的方式配置。
plist
中的配置不变,User-Defined
配置删除
<key>IPAFLAG</key>
<string>${IPAFLAG}</string>
Config-TestMutableConfig.Debug.xcconfig
IPAFLAG = 1
Config-TestMutableConfig.Release.xcconfig
IPAFLAG = 0
代码中读取下:
NSString *infoPath = [[NSBundle mainBundle] pathForResource:@"Info" ofType:@"plist"];
NSDictionary *infoDic = [[NSDictionary alloc] initWithContentsOfFile:infoPath];
NSLog(@"IPAFLAG = %@",infoDic[@"IPAFLAG"]);
IPAFLAG = 1
这样配置更清晰,便于管理。
xcconfig其它用途
处了配置变量还可以配置Build Setting
中的配置:
IPAFLAG = 1
//ld
OTHER_LDFLAGS = -framework "AFNetworking"
编译后虽然报错但是已经配置进来了。那么
Build Setting
中的配置都可以用xcconfig
文件来管理了。OTHER_LDFLAGS
为build setting
中的缩写,本质是key-value
。具体的key
可以在xcodebuildsettings中查找。IPAFLAG = 1
//ld配置连接器
//OTHER_LDFLAGS为build中的缩写
OTHER_LDFLAGS = -framework "AFNetworking"
HEADER_SEARCH_PATHS = /usr/info
可以看到编译后就配置进去了。所以通过
xcconfig
文件就完成了多环境配置的场景。
所以xcconfig
配合scheme
以及config
就完成了项目的多环境配置。并且xcconfig
可以直接复制到其它项目复用。
冲突解决
前面说过cocoapods
会创建xcconfig
文件,在上面的例子中就和自己创建的冲突了。因为Configurations
中只能指定一个。
当然Cocoapods
安装的时候不会覆盖我们在Configurations
配置的。
可以看到在
pod install
的时候Cocoapods
给警告了:
[!] CocoaPods did not set the base configuration of your project
because your project already has a custom config set.
In order for CocoaPods integration to work at all, please either set the base configurations of the target `TestMutableConfig` to `Target Support Files/Pods-TestMutableConfig/Pods-TestMutableConfig.debug.xcconfig`
or include the `Target Support Files/Pods-TestMutableConfig/
Pods-TestMutableConfig.debug.xcconfig` in your build configuration
(`TestMutableConfig/Config/Config-TestMutableConfig.Debug.xcconfig`).
在这里已经给提示让我们导入了。
#include "Target Support Files/Pods-TestMutableConfig/Pods-TestMutableConfig.debug.xcconfig"
导入后依然报错:
找不到目录,查看文件位置发现少了
Pods/
加上后编译成功
#include "Pods/Target Support Files/Pods-TestMutableConfig/Pods-TestMutableConfig.debug.xcconfig"
IPAFLAG = 1
//ld配置连接器
//OTHER_LDFLAGS为build中的缩写
OTHER_LDFLAGS = -framework "AFNetworking"
再次pod install
就没有警告了
那么还存在一个问题,自己配制的
xcconfig
和cocoapods
生成的xcconfig
如果有相同变量会怎么样?比如上面的OTHER_LDFLAGS
。可以看到生效的是自己配置的。
cocoapods
的配置中有一个继承$(inherited)
,这里的继承实际上是两个字符串拼接起来。所以自己配制的也加上
$(inherited)
#include "Pods/Target Support Files/Pods-TestMutableConfig/Pods-TestMutableConfig.debug.xcconfig"
IPAFLAG = 1
//ld配置连接器
//OTHER_LDFLAGS为build中的缩写
OTHER_LDFLAGS = $(inherited) -framework "AFNetworking"
可以看到继承过来了
代码中调用下:
编译成功。
推荐使用scheme + xcconfig
配置管理项目环境。当然在build setting
中设置的并不会被覆盖(不同名,同名可以继承,如果是值key相同会覆盖后面有总结优先级)
xcconfig配置总结
key-value 组成
配置文件由一系列键值分配组成:
BUILD_SETTING_NAME = value
注释
xcconfig文件只有一种注释方式//
//
那么这里就有一个问题了,如果我们要配置一个域名该怎么办呢?比如:
HOST_URL = https://127.0.0.1
可以通过中间值解决:
TEMP=/
HOST_URL = https:${TEMP}/127.0.0.1
include导入其他设置
可以通过include
关键字导入其他的xcconfig
内的配置。通过include
关键字后接上双引号:
#include "Other.xcconfig"
在引入的文件时,如果是以/
开头,代表绝对路径:
#include "/Users/zaizai/Desktop/TestMutableConfig/Pods/Target Support Files/Pods-TestMutableConfig/Pods-TestMutableConfig.debug.xcconfig"
相对路径,以${SRCROOT}路径为开始:
#include "Pods/Target Support Files/Pods-TestMutableConfig/Pods-TestMutableConfig.debug.xcconfig"
变量
变量定义,按照OC命名规则,仅由大写字母,数字和下划线_
组成,原则上大写,也可以不。字符串可以是"
也可以是'
号。
- 在
xcconfig
中定义的变量与Build Settings
的一致,会发生覆盖。可以通过$(inherited)
让当前变量继承变量原有值。(当然对于系统的key
最好都加上$(inherited)`)
//A config
OTHER_LDFLAGS = -framework SDWebImage
//B config
OTHER_LDFLAGS = $(inherited) -framework AFNetworking
//build setting中
// OTHER_LDFLAGS = -framework SDWebImage -framework AFNetworking
⚠️:有部分变量不能通过xcconfig
配置到Build Settings
中。如:配置PRODUCT_BUNDLE_IDENTIFIER
不起作用。
- 引用变量,
$()
和${}
两种写法都可以
VALUE=HotpotCat
KEY1=$(VALUE)
KEY2=${VALUE}
- 条件变量,根据
SDK
、Arch
和Configration
对设置进行条件化:
// 指定`Configration`是`Debug`
// 指定`SDK`是模拟器,还有iphoneos*、macosx*等
// 指定生效架构为`x86_64`
OTHER_LDFLAGS[config=Debug][sdk=iphonesimulator*][arch=x86_64]= $(inherited) -framework "HotpotCat"
⚠️:在Xcode 11.4
及以后版本,可以使用default
来指定变量为空时的默认值。
$(BUILD_SETTING_NAME:default=value)
优先级(高->低)
- 手动配置
Target Build Settings
; -
Target
中配置的xcconfig
文件; - 手动配置
Project Build Settings
; -
Project
中配置的xcconfig
文件。