KZBootstrap简明集成指南

KZBootstrap简介

最近在项目中集成了KZBootstrap,它的简介是"iOS project bootstrap aimed at high quality coding."。主要特色是:

  1. Icon Version


    三种configuration模式下的图标
  2. Code Quality and Warnings
    加入了一些编译设置

  3. 一些有用的宏


    KZB_REQUIRE_SUPER

    turn all todo/fixme into warnings
  4. 环境变量设置
    可以在系统设置中切换app的环境设置,方便app处理例如QA/生产等不同环境下的逻辑。

  5. 另外还有可选的log和debug增强支持。

集成说明

KZBootstrap有两种集成方式:
1.手动集成;
2.使用作者提供的另一个Xcode项目配置工具crafter

我试用了一下crafter,发现有一些配置在Xcode 7上似乎没有生效。同时手动的方式对结果更可控一些。本文只说明手动集成方法。

目标

  1. 集成KZBootstrap。
  2. 配置Xcode使用3种configuration: Debug, Adhoc, Release。
    其中Debug使用一个bundle id(com.xxx.xxx.dev),Adhoc和Release使用另一个bundle id(com.xxx.xxx)。这个是我的个人原因。因为在使用友盟消息推送,他家后台同一个APP只支持设置开发和生产两个推送证书,不同的bundle id对应的推送证书是不同的。
    另外,微信和QQ在注册应用支持时都是靠bundle id识别的,Adhoc和Release设置成同一个bundle id方便测试人员进行测试,能够尽可能的保证线上发布与Adhoc发布的一致性。
  3. APP可以有一个运行时的环境变量设置,Debug/Adhoc下可以在系统设置中进行改变。在Release时不会出现这个设置选项。
    这样在APP的代码逻辑里可以根据环境变量执行不同的分支。
  4. 支持icon version。

手动集成(参照项目官方指南)

  1. 先在apple的member center里生成一个新的证书及相应的provision file。对应的bundle id添加.dev结尾。
    例如,原来的应用bundle id为com.xxx.xxx,新bundle id为com.xxx.xxx.dev
  • 如果涉及推送请添加好对应的证书。如涉及第三方应用的回调也可以在之后的代码中做相应的识别和注册。
  1. 在Podfile中添加KZBootstrap,暂时先不执行pod update

pod 'KZBootstrap', '~> 0.6.0'

  1. 在Xcode中打开项目,在Project信息页Configuration栏选择Duplicate "Release" Configuration,并命名新Configuration为Adhoc


  2. 将三个configuration的base configuration都设为None


  3. 关闭项目,执行

pod update

  • 若在添加configuration后不做如上操作,则Cocoapods将不能正确设置项目,在pod update结束时会提示[!] CocoaPods did not set the base configuration of your project because your project already has a custom config set.
  1. 在项目中添加KZBEnvironments.plist
    用于读取环境配置,文件内容如下:
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
    <plist version="1.0">
    <dict>
        <key>KZBEnvironments</key>
        <array>
            <string>QA</string>
            <string>STAGING</string>
            <string>PRODUCTION</string>
        </array>
    </dict>
    </plist>
  1. 在Xcode中选择相应的target,在Build Settings中添加User-Defined设置BUNDLE_DISPLAY_NAME_SUFFIX,用于显示


  2. 在应用的plist文件中为Bundle display name添加后缀${BUNDLE_DISPLAY_NAME_SUFFIX}

  • 原来为appABC,修改后为appABC${BUNDLE_DISPLAY_NAME_SUFFIX}
  1. Build SettingsPackaging区找到Product Bundle Identifier,为debug添加后缀.dev
  • KZBootstrap本身推荐使用BUNDLE_ID_SUFFIX变量来区分,但是我实验时使用这个变量在编译时中Xcode不能正确匹配证书。我猜测原作者用的是wildcard cert所以不会遇到这个问题。
  1. Build Settings中添加User-Defined设置KZBEnv

  2. Build SettingsPreprocessing区修改Preprocessor Macro,添加KZBEnv=${KZBEnv}

    此处会自动读取User-Defined中的设置

  3. 本文不涉及用户自定义macro的使用,所以不添加KZBootstrapUserMacros.h文件

  4. 在项目中添加Settings.bundleNew File -> Resource -> Settings Bundle,修改Root.plist文件如下:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>StringsTable</key>
    <string>Root</string>
    <key>PreferenceSpecifiers</key>
    <array>
        <dict>
            <key>Type</key>
            <string>PSGroupSpecifier</string>
            <key>Title</key>
            <string>Info</string>
        </dict>
        <dict>
            <key>DefaultValue</key>
            <string>NoVersion</string>
            <key>Key</key>
            <string>Version</string>
            <key>Title</key>
            <string>Version</string>
            <key>Type</key>
            <string>PSTitleValueSpecifier</string>
        </dict>
    </array>
</dict>
</plist>
  • 如果设置相关的内容在系统设置中没有出现,双击HOME键关闭设置app再打开就可以出现了。(Refer)
  1. 在target的Build Phases中添加Run Script Phase,设置命令为
"${SRCROOT}/Pods/KZBootstrap/Pod/Assets/Scripts/bootstrap.sh" -t -n -i

脚本共支持5个参数

  • -l
    开启行数警告(250行以上都会被警告)
  • -t
    开启TODO警告
  • -u
    开启用户宏
  • -n
    开启自动build-number
  • -i
    开启icon versioning(开启这一项会同时启用自动build-number)
    要支持icon versioning需要在系统中安装imagemagickghostscript,推荐使用brew安装
brew install imagemagick
brew install ghostscript

另外,0.6.0版本并不支持@3x图片的icon version,但是最新的master分支上的代码已支持。

  1. 在AppDelegate中添加处理代码
    [[NSUserDefaults standardUserDefaults] setObject:VERSION_APP forKey:@"Version"];

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,599评论 18 139
  • Fastlane简介 Fastlane是用Ruby语言编写的一套自动化工具集和框架,每一个工具实际都对应一个Rub...
    小_夭阅读 7,759评论 2 15
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,748评论 6 342
  • 看到一篇对iOS多环境配置介绍不错的文章,翻译了一下,原文链接这里: 原文链接 下面的例子展示了如何在Xcode中...
    可了个可阅读 4,717评论 5 17
  • 同上。 从小,我就随便惯了,稀里糊涂的活到现在。 突然想有一份自己的事业。 然后开始东想西凑。 纠结,从此开始。 ...
    楼31阅读 156评论 0 2