iOS多环境配置方案(xcconfig)

前言

在App开发过程中, 配置参数经常会随着环境的变化而不同.
例如基本的URL地址, 第三方秘钥和key等等.
以往为了切换环境, 都是手动的注释对应的参数. 还要配置很多宏定义, 以及很多的#ifdef #endif判断.
这种手动切换配置的方法, 即耽误时间, 又影响代码的可读性. 因此需要更简洁的动态修改方案.

开发环境

  • macOS Ventura 13.4
  • Xcode 14.3

环境配置方案

  • 多target形式
  • 多scheme方式
  • xcconfig配置文件的形式

以上3种环境配置方案都可以达到动态修改的效果, 经过各种尝试, 个人认为xcconfig是最优解决方案, 而且更符合个人的开发习惯, 但是需要进行很多地方的配置. 因此详细讲解一下如何配置.

具体操作步骤

1. 创建一个新项目(OC & Swift)

首先创建一个新的项目, 并用cocoapods管理

2. 创建xcconfig配置文件(OC & Swift)

创建xcconfig文件夹:


创建xcconfig文件夹.jpg

创建Configuration Setting Flie文件:


Configuration Setting Flie.jpg

根据项目的开发环境需求, 创建多个xcconfig文件, 这里演示的只有生产环境和开发环境(Sit):
创建xcconfig文件.jpg

注释: 此处一定要记得选择Targets. 如果忘记了, 不要紧, 点击创建的xcconfig文件, 在Target Membership中勾选

3.将xcconfig文件配置到对应的Configuartion中(OC & Swift)

切换到PROJECT -> info -> Configuartion下, 已经配置了Debug和Release模式. 这是项目里默认的

image.png

因为我们有多个环境的配置, 原有的Debug和Release已经无法满足需求, 所以, 根据之前创建的xcconfig文件,点击+号添加新的Debug和Release, 并且重新命名.
同时把红框内的选项, 选择创建的xcconfig文件, 要一一对应. 其他选项选择None.
替换.jpg

项目是cocoapods管理, 在终端pod install 命令, 生成相关文件.
会发现, 之前选择None的选项自动选择新生产的文件.

4. 创建新的Scheme(OC & Swift)

创建New Scheme 命名SchemeSit


创建Scheme.jpg

Build Configuartion选择对应的xcconfig文件


替换.jpg

5. 在xcconfig文件中定义相应的变量(OC & Swift)

Debug或Release中添加的变量
其中导入pod对应的xcconfig是根据之前pod install 时生成的文件路径

// 应用名字
APP_DISPLAY_NAME = 开发DEBUG
// 基础URL (  // 中间要加上$()  )
// OC写法
BASE_URL = @"https:/$()/www.baidu.com"
// Swift写法
BASE_URL = https:/$()/www.baidu.com
// 图标名
APP_ICON = AppIcon

// 导入pod对应的config
#include "Pods/Target Support Files/Pods-SchemeCode/Pods-SchemeCode.debug.xcconfig"
// 导入公共config
#include "CommonConfig.xcconfig"

常用配置文件中, 要把xcconfig中的变量Key值书写到这里.

GCC_PREPROCESSOR_DEFINITIONS = ${inherited} APP_DISPLAY_NAME='$(APP_DISPLAY_NAME)' 
BASE_URL='$(BASE_URL)' 
BUNDLE_ID='$(BUNDLE_ID)' 
APP_ICON='$(APP_ICON)'

此时我们能在TARGETS -> Build Settings -> User-Defined 中看见自定义的变量


13.jpg

6. 读取自定义变量(OC & Swift 不同)

切换Scheme即可在不同开发环境下, 自动切换对应的环境变量
OC读取自定义变量: 可以直接以宏定义的形式获取所需要的自定义变量.

NSLog(BASE_URL);

Swift读取自定义变量: 由于Swift没有了OC中的宏定义, 所以获取自定义变量如下

func readBaseUrl() -> String? {
        guard let path = Bundle.main.path(forResource: "Info", ofType: "plist") else {
            return nil
        }
        let infoDic = NSDictionary(contentsOfFile: path)
        let host = infoDic?["BASE_URL"] as? String
        return host
    }

print(readBaseUrl()!)

7. 设置特定的变量

  • 设置不同应用名TARGETS -> General -> Identity -> Display Name
    填写${APP_DISPLAY_NAME}


    设置应用名.jpg
  • 设置不同应用图标
    在Assets.xcassets中添加所需要的图标,命名Appicon / AppiconSit
    TARGETS -> Build Settings -> Primary App Icon Set Name
    对应的环境选择对应的应用图标


    应用图标.jpg
  • 设置不同应用Build Identifity
    设置Build Identifity 不生效
    手动设置Build Identifity后, 设置不同应用名发生错误.

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

推荐阅读更多精彩内容