用xcconfig文件配置iOS app环境变量

转自: https://www.jianshu.com/p/9b8bc8351223

app开发中通常都会涉及到多个环境,Debug、Release等。环境切换时可能就会涉及到服务器url的切换,或者一些第三方sdk的appid的切换。最初我是通过在代码中添加变量的方式来设置环境的:

static let isRelease = true
static let serverURL = isRelease ? "prod server url" : "dev server url"

然而这样做的缺陷是,每一次要切换环境的时候都需要去更改这个变量,多次修改后还是会比较烦。并且通常开发中可能会有不止两个环境。所以,配置app环境变量能够更好的解决环境切换的问题。

配置app环境变量的方式有多种,我选择了一种我感觉比较直观的方式来配置——使用xcconfig文件。

需求

Xcode默认会提供两种配置环境:Debug 和 Release,这两者的区别:

  • Debug 会多一些调试信息(网上很多人说release,环境下不能断点之类的,自己测试后发现断点什么的和debug、release没有关系,后面会详细说)
  • Release 运行速度快很多,流畅。打的包大小可能要比debug小一些

在我的开发中主要是会用到3种环境:

  • 测试服务器debug
  • 偶尔会切换到正式服务器debug
  • 上架(正式服务器,release)

默认提供的两种还不太够用。。。

根据以上需求,操作步骤大致如下:

1、添加Build Configuration

打开项目的workspace,进入xcode的主界面。

选中主要工程的project -> info , 找到Configurations, 点击下方的“+”

image

从图中可以看到两个已经添加好的Configuration: Debug 和 Release

选择“deplicate debug configuration”,添加一个新的configuration,命名为ReleaseTest:

image

从图上可以看到,三个configuration都已经有了默认的configuration set(也就是xxconfig文件)。这是因为我的工程中已经包含了cocoapods。默认的configuration set是pods添加的。

这个时候新增加的build configuration并没有对应的pods的xcconfig,所以项目会报错。把新建的configuration 对应的set 设置为none

image

命令行运行

pod install

完成之后如下图

image

2、新建并配置xcconfig文件

common + "n", 选择 iOS -> Other -> Configuration settings file

image

新建4个xxconfig文件,我采用一下命名:

image

其中:

CommonConfig.xcconfig 文件中放一些通用的配置,例如build version等

其他三个文件分别对应三个build configuration.

在CommonConfig中添加:

BUILD_VERSION = 1.0.0

DebugConfig:

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

APP_DISPLAY_NAME = 测试服
CONFIG_FLAG = DEBUG

ReleaseConfig:

#include "CommonConfig.xcconfig"
#include "Pods/Target Support Files/Pods/Pods.release.xcconfig"

APP_DISPLAY_NAME = 真名
CONFIG_FLAG = RELEASE

ReleaseTestConfig:

#include "CommonConfig.xcconfig"
#include "Pods/Target Support Files/Pods/Pods.releasetest.xcconfig"

APP_DISPLAY_NAME = 正式服
CONFIG_FLAG = RELEASE_TEST

其中:

#include "Pods/Target Support Files/Pods/Pods.releasetest.xcconfig"

可能会因为项目名称的不同导致路径不同,如果不太确定的可以再次pod install。pods会给出提示,其中包含了正确的路径。

[!] 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 configTest to Pods/Target Support Files/Pods/Pods.debug.xcconfig or include the Pods/Target Support Files/Pods/Pods.debug.xcconfig in your build configuration.

完成以上后,把build configuration切换成对应的新建的文件:

image

2、设置环境变量

完成上面的步骤就已经添加好了环境,剩下的就是设置环境变量

在Info.plist文件中,设置Bundle name 为

${APP_DISPLAY_NAME}

应用的名称就会根据配置改变了。

image

然而在代码中需要根据环境改变某些变量的值怎么办呢?

1、设置预编译头参数

OC

Project -> Build settings -> Apple LLVM 7.1 - Preprocessing

在 preprocessor 中添加

${CONFIG_FLAG}=1

image

Swift

Project -> Build settings -> Swift Compiler - Custom Flags

在 other swift flags 中添加

-D ${CONFIG_FLAG}

image

然后

代码中:

struct AppConfig {
    private enum AppConfigType {
        case Debug
        case Release
        case ReleaseTest
    }

    private static var currentConfig: AppConfigType {
        #if DEBUG = 1
            return .Debug
        #elseif RELEASE_TEST = 1
            return .ReleaseTest
        #else
            return .Release
        #endif
    }

    static var webServerURL: String {
        switch currentConfig {
        case .Debug:
            return "test url"
        default:
            return "release url"
        }
    }
}

其他变量也可以采用以上方式配置。

添加多个scheme,方便配置切换

image
image

在scheme中改变build configuration即可实现不同的环境切换,也可以添加多个scheme实现更方便的切换

image
image

添加的新scheme需要在manage scheme中勾选shared,git上的其他人才能看到新scheme

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