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后, 设置不同应用名发生错误.