應(yīng)用場(chǎng)景:在開(kāi)發(fā)app過(guò)程中嗽冒,你肯定需要有測(cè)試環(huán)境呀伙,而測(cè)試環(huán)境和線上環(huán)境的切換如果你是根據(jù)修改代碼來(lái)實(shí)現(xiàn)那你就太low了。這時(shí)候你會(huì)實(shí)現(xiàn)一個(gè)debug功能模塊添坊,不但你能進(jìn)行環(huán)境切換剿另,產(chǎn)品經(jīng)理,測(cè)試員同樣能用這功能贬蛙。而隨著產(chǎn)品逐漸成熟雨女,需要的debug功能也會(huì)越來(lái)越多,如:ABTest切換阳准,用戶登錄登出氛堕,指定頁(yè)面跳轉(zhuǎn),日志查看等功能溺职。從另一個(gè)方面說(shuō)你的debug模塊代碼會(huì)越來(lái)越多岔擂。那么,怎樣讓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
上面的方法痛倚,看起來(lái)是可行的。它保證了只有在 Debug 環(huán)境下澜躺,才會(huì)有?DebugA類的定義和實(shí)現(xiàn)蝉稳,也保證了只在 Debug 環(huán)境下才對(duì) DebugA 進(jìn)行實(shí)例化抒蚜。
問(wèn)題: 雖然在 Release 下類和方法是沒(méi)定義了,但是文件在打包的時(shí)候還是會(huì)被打包進(jìn)app耘戚, 另外嗡髓,類的定義和實(shí)現(xiàn)都用宏包起來(lái),從一定程度上對(duì)代碼造成了污染收津; 另一個(gè)問(wèn)題饿这,如果在實(shí)現(xiàn)過(guò)程中涉及到圖片或者xib的使用,這些文件在 Release 下即使不顯示也不使用撞秋,但是已經(jīng)被打包進(jìn) app 了长捧。怎么杜絕這兩個(gè)問(wèn)題呢?
EXCLUDED_SOURCE_FILE_NAMES能很好的幫你解決這個(gè)問(wèn)題吻贿。從key的名稱可以大概知道串结,它是用來(lái)通過(guò)文件名排除資源文件的。
你只需要在相應(yīng)的 Target 下的 Build Settings 中添加 User-Defined Setting舅列,然后添加?EXCLUDED_SOURCE_FILE_NAMES肌割,并在不同編譯配置下進(jìn)行文件名的忽略(支持正則匹配)即可。
添加User-Defined Setting
添加EXCLUDED_SOURCE_FILE_NAMES key
上圖剧蹂,在 Release 下通過(guò)匹配文件名存在 Debug 字樣的文件声功,這樣,在 Release 下就會(huì)將文件名包含 Debug 的文件忽略了宠叼。所以,在定義 debug 功能模塊的類和方法上都不需要通過(guò)?#if Debug #endif來(lái)污染代碼了其爵,同樣的冒冬,debug 的資源文件也不會(huì)被打包進(jìn) Release 下的 app 內(nèi)了。
等等摩渺,問(wèn)題解決了嗎简烤?如果你的需求是只要 release 下就排除 debug 文件,那上面的方案已經(jīng)足夠了摇幻。但如果你遇到像我這樣的需求横侦,那就得另尋蹊徑了。
由于公司項(xiàng)目使用 cocopods 來(lái)管理各個(gè)業(yè)務(wù)線模塊绰姻,每個(gè)業(yè)務(wù)在更新了業(yè)務(wù)代碼后需要打一個(gè)提供給其他業(yè)務(wù)使用的 rc 包枉侧,而這個(gè) rc 包的打包環(huán)境是 Release,但我們又需要 debug 功能狂芋≌ツ伲基于這種需求,我們通過(guò) 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)部代碼則是通過(guò)這個(gè)宏來(lái)判斷是否引入 debug 代碼翼虫,如下:
#if IS_BETA
DebugA *a = [[DebugA alloc] init] ;
// 方法調(diào)用
#endif
這時(shí)候屑柔,上面的方法就沒(méi)法用了。既然這個(gè)宏是通過(guò)腳本動(dòng)態(tài)寫(xiě)入的珍剑,我們是否同樣可以動(dòng)態(tài)寫(xiě)入?EXCLUDED_SOURCE_FILE_NAMES的值呢掸宛?當(dāng)然是可以的。同樣通過(guò) 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 即可。這樣闻妓,在通過(guò) Jenkins打包時(shí)菌羽,執(zhí)行 podfile 后就會(huì)動(dòng)態(tài)根據(jù)環(huán)境去設(shè)置 ** EXCLUDED_SOURCE_FILE_NAMES** 的值了。
附:
通過(guò)?xcodebuild -showBuildSettings可以查看當(dāng)前項(xiàng)目下的所有配置信息由缆;?xcodebuild -configuration Release -showBuildSettings命令注祖,可以查看當(dāng)前項(xiàng)目 Release下的所有配置信息,通過(guò)這些配置信息你可以在寫(xiě)腳本時(shí)知道對(duì)應(yīng)的 key 名稱均唉。