應(yīng)用場(chǎng)景:在開發(fā)app過程中,你肯定需要有測(cè)試環(huán)境碉考,而測(cè)試環(huán)境和線上環(huán)境的切換如果你是根據(jù)修改代碼來實(shí)現(xiàn)那你就太low了导绷。這時(shí)候你會(huì)實(shí)現(xiàn)一個(gè)debug功能模塊累魔,不但你能進(jìn)行環(huán)境切換走诞,產(chǎn)品經(jīng)理副女,測(cè)試員同樣能用這功能。而隨著產(chǎn)品逐漸成熟蚣旱,需要的debug功能也會(huì)越來越多碑幅,如:ABTest切換戴陡,用戶登錄登出,指定頁面跳轉(zhuǎn)沟涨,日志查看等功能恤批。從另一個(gè)方面說你的debug模塊代碼會(huì)越來越多。那么裹赴,怎樣讓debug代碼不污染線上app呢喜庞?
一般,你可能會(huì)想到的是我只需要在每個(gè)類或方法上添加上宏的判斷就行了篮昧,在debug下才會(huì)定義某個(gè)類或方法赋荆,如下:
#if DEBUG
@interface DebugA : UIViewController
// 方法...
@end
#endif
#if DEBUG
@implementation DebugA
// 方法實(shí)現(xiàn)...
@end
#endif
#if DEBUG
DebugA *a = [[DebugA alloc] init] ;
// 方法調(diào)用...
#endif
上面的方法笋妥,看起來是可行的懊昨。它保證了只有在 Debug 環(huán)境下,才會(huì)有 DebugA
類的定義和實(shí)現(xiàn)春宣,也保證了只在 Debug 環(huán)境下才對(duì) DebugA 進(jìn)行實(shí)例化酵颁。
問題: 雖然在 Release 下類和方法是沒定義了,但是文件在打包的時(shí)候還是會(huì)被打包進(jìn)app月帝, 另外躏惋,類的定義和實(shí)現(xiàn)都用宏包起來,從一定程度上對(duì)代碼造成了污染嚷辅; 另一個(gè)問題簿姨,如果在實(shí)現(xiàn)過程中涉及到圖片或者xib的使用,這些文件在 Release 下即使不顯示也不使用簸搞,但是已經(jīng)被打包進(jìn) app 了扁位。怎么杜絕這兩個(gè)問題呢?
EXCLUDED_SOURCE_FILE_NAMES 能很好的幫你解決這個(gè)問題趁俊。從key的名稱可以大概知道域仇,它是用來 通過文件名排除資源文件 的。
你只需要在相應(yīng)的 Target 下的 Build Settings 中添加 User-Defined Setting寺擂,然后添加 EXCLUDED_SOURCE_FILE_NAMES暇务,并在不同編譯配置下進(jìn)行文件名的忽略(支持正則匹配)即可。
上圖怔软,在 Release 下通過匹配文件名存在 Debug 字樣的文件垦细,這樣,在 Release 下就會(huì)將文件名包含 Debug 的文件忽略了挡逼。所以括改,在定義 debug 功能模塊的類和方法上都不需要通過 #if Debug #endif
來污染代碼了,同樣的挚瘟,debug 的資源文件也不會(huì)被打包進(jìn) Release 下的 app 內(nèi)了叹谁。
等等饲梭,問題解決了嗎?如果你的需求是只要 release 下就排除 debug 文件焰檩,那上面的方案已經(jīng)足夠了憔涉。但如果你遇到像我這樣的需求,那就得另尋蹊徑了析苫。
由于公司項(xiàng)目使用 cocopods 來管理各個(gè)業(yè)務(wù)線模塊兜叨,每個(gè)業(yè)務(wù)在更新了業(yè)務(wù)代碼后需要打一個(gè)提供給其他業(yè)務(wù)使用的 rc 包,而這個(gè) rc 包的打包環(huán)境是 Release衩侥,但我們又需要 debug 功能国旷。基于這種需求茫死,我們通過 ruby 腳本動(dòng)態(tài)的定義了一個(gè)宏:IS_BETA跪但,下面是代碼片段:
if xcconfig.include? 'GCC_PREPROCESSOR_DEFINITIONS = $(inherited)'
if debugMode
c1 = xcconfig.sub('GCC_PREPROCESSOR_DEFINITIONS = $(inherited)', 'GCC_PREPROCESSOR_DEFINITIONS = $(inherited) IS_BETA=1')
else
c1 = xcconfig.sub('GCC_PREPROCESSOR_DEFINITIONS = $(inherited)', 'GCC_PREPROCESSOR_DEFINITIONS = $(inherited) IS_BETA=0')
end
File.open(xcconfig_path, "w") { |file| file << c1 }
else
if debugMode
s1 = 'GCC_PREPROCESSOR_DEFINITIONS = IS_BETA=1'
else
s1 = 'GCC_PREPROCESSOR_DEFINITIONS = IS_BETA=0'
end
File.open(xcconfig_path, "a+") { |file| file.write("\n#{s1}") }
end
內(nèi)部代碼則是通過這個(gè)宏來判斷是否引入 debug 代碼,如下:
#if IS_BETA
DebugA *a = [[DebugA alloc] init] ;
// 方法調(diào)用
#endif
這時(shí)候峦萎,上面的方法就沒法用了屡久。既然這個(gè)宏是通過腳本動(dòng)態(tài)寫入的,我們是否同樣可以動(dòng)態(tài)寫入 EXCLUDED_SOURCE_FILE_NAMES 的值呢爱榔?當(dāng)然是可以的被环。同樣通過 ruby 腳本,引入當(dāng)前項(xiàng)目模塊详幽,遍歷所有 target 的 build configuration筛欢,然后根據(jù)當(dāng)前要編譯的類型(這里定義為 defaultType)給 ** EXCLUDED_SOURCE_FILE_NAMES** 對(duì)應(yīng)的設(shè)置上值。如下:
require 'xcodeproj'
def dealBuildSettings
project = Xcodeproj::Project.open('./Train.xcodeproj')
project.targets.each do |target|
target.build_configurations.each do |config|
if $defaultType == 'rc'
config.build_settings['EXCLUDED_SOURCE_FILE_NAMES'] = ''
else
if config.name == 'Release'
config.build_settings['EXCLUDED_SOURCE_FILE_NAMES'] = '*Debug*.*'
else
config.build_settings['EXCLUDED_SOURCE_FILE_NAMES'] = ''
end
end
end
end
project.save()
end
最后在 podfile 引入這個(gè)腳本唇聘,并執(zhí)行下 dealBuildSettings 即可版姑。這樣,在通過 Jenkins打包時(shí)雳灾,執(zhí)行 podfile 后就會(huì)動(dòng)態(tài)根據(jù)環(huán)境去設(shè)置 ** EXCLUDED_SOURCE_FILE_NAMES** 的值了漠酿。
附:
通過 xcodebuild -showBuildSettings
可以查看當(dāng)前項(xiàng)目下的所有配置信息; xcodebuild -configuration Release -showBuildSettings
命令谎亩,可以查看當(dāng)前項(xiàng)目 Release下的所有配置信息炒嘲,通過這些配置信息你可以在寫腳本時(shí)知道對(duì)應(yīng)的 key 名稱。