Xcode多环境配置

Xcode多环境配置一共有3种形式:

  • Target
  • Scheme
  • xcconfig

Project:包含了项目所有的代码、资源文件、所有信息。(一个项目是多个project的集合)
Target:对指定代码和资源文件的具体构建方式。(指定某些代码如何生成ipa包,类似打工人的角色)
Scheme:对指定Target的环境配置。(配置编译环境变量)
这也就是我们修改一些配置的时候需要选中Target再去修改的原因。

多Target配置

在项目中选中Target复制就生成新的Target了。

image.png

在这里复制后并没有产生额外代码,只是复制了一个新的构建模式。
image.png

相当于可以直接分别配置Info.plist文件,在Target中修改bundleId后就相当于两个Target是两个App了。
同时可以在Preprocessor Macros中配置一些宏定义用于代码中区分Target
image.png

比如在OCSwift混编的时候,在OC中导入头文件就可以用这个宏来处理:

#if DEV
#import "TestMutableConfig_dev-Swift.h"
#else
#import "TestMutableConfig-Swift.h"
#endif

对应的Swift文件:

image.png

Swift中也可以用Swift宏来处理:
Other Swift Flags中配置变量- D DEV(空格有没有都行)
image.png

#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中控制要编译的文件和资源。

image.png

多scheme配置

scheme默认有DebugReleaseconfig我们可以按需添加。在Target中添加变量的时候已经用到过了。
配置在Project -> Info -> Configurations

image.png

比如我们有appStore包,有企业包。那么各复制一份对应的DebugRelease(最好是配置完成后再复制)
image.png

运行/打包的时候选择对应的Scheme就可以了。
image.png

这种情况下运行不同配置的时候需要来回切换。
可以通过创建Scheme对应不同config
image.png

image.png

这个时候只需要切换Scheme运行就可以了。
image.png

比如我们上传打包ipa的时候,有时候会错将debug模式下的包上传上去,尤其是在发灰度包的时候。这里有两个方案:
1.通过config配置。
2.打包的时候通过脚本修改info.plist文件增加一个变量。

release包赋值为0debug包赋值为1。这样在上传ipa包的时候后端读取Info.plist做判断,debug包直接报错不让传。
这里实现以下方式1:
Targets -> Build Settings -> + -> Add User-Defined Setting

image.png

添加一个IPAFLAGrelease模式下是1debug模式下是0:
image.png

Info.plist文件中增加配置:
image.png

到这里就完成了

  • 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中添加不同的资源文件

image.png

Scheme还可以控制传递参数等,一般不常用。

image.png

Scheme情况只需要在一个build setting中就能完成配置了,比多Target方便好维护。
缺点是还需要在build setting中设置。

xcconfig

这个我们平时都接触到了,可能好多人没有注意到,用的最广泛的就是cocoapods
比如Other Linker FlagsSearch Paths

image.png

image.png

那么Cocoapods是怎么配置的呢?
image.png

就是使用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

xcconfigkey-value的形式配置的。那么怎么对应到xcconfig文件的呢?

image.png

Configurations中对应配置的。

配置自己的xcconfig文件

新建 -> Configuration Settings File

image.png

命令规则为:以所在目录开头-工程名称.config名称/环境名称,比如Config-TestMutableConfig.Debug
image.png

接着可以在config中选择配置
image.png

  • 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"

image.png

编译后虽然报错但是已经配置进来了。那么Build Setting中的配置都可以用xcconfig文件来管理了。
OTHER_LDFLAGSbuild setting中的缩写,本质是key-value。具体的key可以在xcodebuildsettings中查找。
image.png

image.png

IPAFLAG = 1

//ld配置连接器
//OTHER_LDFLAGS为build中的缩写
OTHER_LDFLAGS = -framework "AFNetworking"

HEADER_SEARCH_PATHS = /usr/info

image.png

可以看到编译后就配置进去了。所以通过xcconfig文件就完成了多环境配置的场景。

所以xcconfig配合scheme以及config就完成了项目的多环境配置。并且xcconfig可以直接复制到其它项目复用。

冲突解决

前面说过cocoapods会创建xcconfig文件,在上面的例子中就和自己创建的冲突了。因为Configurations中只能指定一个。
当然Cocoapods安装的时候不会覆盖我们在Configurations配置的。

image.png

可以看到在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"

导入后依然报错:

image.png

找不到目录,查看文件位置发现少了Pods/加上后编译成功

#include "Pods/Target Support Files/Pods-TestMutableConfig/Pods-TestMutableConfig.debug.xcconfig"
IPAFLAG = 1

//ld配置连接器
//OTHER_LDFLAGS为build中的缩写
OTHER_LDFLAGS = -framework "AFNetworking"

再次pod install就没有警告了

image.png

那么还存在一个问题,自己配制的xcconfigcocoapods生成的xcconfig如果有相同变量会怎么样?比如上面的OTHER_LDFLAGS
可以看到生效的是自己配置的。
image.png

cocoapods的配置中有一个继承$(inherited),这里的继承实际上是两个字符串拼接起来。
image.png

所以自己配制的也加上$(inherited)

#include "Pods/Target Support Files/Pods-TestMutableConfig/Pods-TestMutableConfig.debug.xcconfig"
IPAFLAG = 1

//ld配置连接器
//OTHER_LDFLAGS为build中的缩写
OTHER_LDFLAGS = $(inherited) -framework "AFNetworking"

可以看到继承过来了


image.png

代码中调用下:


image.png

编译成功。

推荐使用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命名规则,仅由大写字母,数字和下划线_组成,原则上大写,也可以不。字符串可以是"也可以是'号。

  1. 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不起作用。

  1. 引用变量,$()${}两种写法都可以
VALUE=HotpotCat

KEY1=$(VALUE)
KEY2=${VALUE}
  1. 条件变量,根据SDKArchConfigration对设置进行条件化:
// 指定`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文件。

资料

xcodebuildsettings

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

推荐阅读更多精彩内容