iOS APP包分析工具 | 京東云技術團隊

介紹

分享一款用于分析iOSipa包的腳本工具，使用此工具可以自動掃描發現可修復的包體積問題，同時可以生成包體積數據用于查看。這塊工具我們團隊內部已經使用很長一段時間，希望可以幫助到更多的開發同學更加效率的優化包體積問題。

工具下載地址

背景

APPAnalyze工具最早誕生主要是為了解決以下包體積管理的問題：

對于定位下沉市場的APP來講，包體積是一個非常重要的性能指標，包體積過大會影響用戶下載APP的意愿。但是在早期我們缺少一些手段幫助我們更高效的去進行包體積管理。

自動發現問題

提升效率- 人工排查問題效率低，對于常見的問題盡可能自動掃描出來。并且對于組件化工程來講，很多外部組件是通過Framework方式提供，沒有倉庫源碼權限用于分析包體積問題。
流程化- 形成自動化的質量流程，添加到CI流水線自動發現包體積問題。

數據指標量化

包體積問題- 提供數據化平臺查看每個組件的包體積待修復問題
包體積大小- 提供數據化平臺查看每個組件的包體積占比，包括總大小，單個文件二進制大小和每個資源大小。可以針對不同的APP版本進行組件化粒度的包體積數據對比，更方便查看每個版本的組件大小增量。

實現方式

我們選擇了不依賴源碼而是直接掃描二進制庫的方式來實現這個能力，總體的執行流程一下：

提示：基于組件化工程的掃描方式內部支持，只是暫時不對外開放。

使用指南

安裝

無需安裝。通過下載鏈接直接下載終端可執行命令文件APPAnalyzeCommand到本地即可使用。

APPAnalyzeCommand 下載地址

使用

$ /Users/Test/APPAnalyzeCommand --help
OPTIONS:--version <version>     當前版本 1.0.0--output <output>       輸出文件目錄。必傳參數--config <config>       配置JSON文件地址。非必傳參數--ipa <ipa>             ipa.app文件地址。必傳參數-h, --help              Show help information.

執行

打開終端程序直接執行以下shell指令，即可生成ipa的包體積數據以及包體積待修復問題。

提示：不能直接使用AppStore的包，AppStore的包需要砸殼。建議盡量使用XCodeDebug的包。

/Users/Test/APPAnalyzeCommand --ipa ipas/JDAPP/JDAPP.app --output ipas/JDAPP

提示：如果提示permission denied沒有權限，執行sudo chmod -R 777 /Users/a/Desktop/ipas/APPAnalyzeCommand即可。

生成產物

生成產物
指令執行完成以后，會在ouput參數指定的文件夾生成APPAnalyze文件夾。具體文件介紹如下：

包體積信息

app_size.html- 展示ipa每個framework的包體積數據，可直接用瀏覽器打開。

提示：按照主程序和動態庫進行粒度劃分

app_size.html

framework_size.html- 展示單個framework所有的包體積數據，二級頁面不要直接打開。

framework_size.html

提示：XCode生成Assets.car時會將一些小圖片拼接成一張PackedAssetImage的大圖片。

package_size.json-ipa包體積 JSON 數據

包體積待修復問題

app_issues.html- 展示ipa每個framework的包體積待修復問題數量，可直接用瀏覽器打開。

提示：按照主程序和動態庫進行粒度劃分

framework_issues.html- 展示單個framework所有的待修復問題詳細數據，二級頁面不要單獨打開。

framework_issues.html

issues.json-ipa待修復包體積問題 JSON 數據

提示：json數據可用于搭建自己的數據平臺，擴展更多的能力。例如查看不同APP版本以及支持多個APP版本對比等。

規則介紹

包體積

未使用的類

定義了類沒有被使用到，包含ObjC類和Swift類。

掃描規則

沒有查到到對應的ObjC類被引用
沒有被當做父類使用
沒有使用的字符串和類名一致
沒有被當做屬性類型使用
沒有被創建或調用方法
沒有實現+load方法

可選的修復方式

移除未使用的類
Swift類如果只是用了static方法考慮修改成Enum類型
如果只是在類型轉換時使用了也會檢測出是未使用的類，例如(ABCClass *)object;。建議檢查是否真的有沒有到相關類后刪除
對于ObjC，如果只是作為方法參數類型使用也會被檢測出是未使用的類。建議刪除相關方法即可。

提示：刪除類相對是一種安全的行為，因為刪除后如果有被使用到會產生編譯時錯誤。雖然有做字符串調用的掃描過濾，不過還是建議檢查是否可能被Runtime動態創建調用

未使用的ObjC協議

定義了ObjC協議沒有被類使用

掃描規則

對應的協議沒有被類引用

可選的修復方式

移除未使用的協議

Bundle內多Scale圖片

Bundle內同一張圖片包含多個Scale會導致更大的包體積。

掃描規則

同一個Bundle內存在同名但是scale不同的圖片。例如a@2x.png/a@3x.png

可選的修復方式

移除Scale更低的圖片

大資源

文件大小超過一定大小的即為大資源，默認為20KB。

掃描規則

某個文件超過設置的大資源限額

可選的修復方式

移除資源動態下發
使用更小的數據格式，例如使用更小的圖片格式

重復的資源文件

存在多個同樣的重復文件。

掃描規則

多個文件MD5一致即判定為重復文件。

可選的修復方式

移除多余的文件

未使用的類Property屬性

ObjC類中定義的屬性沒有被使用到。

掃描規則

對應的屬性沒有被調用 set/get 方法，同時也沒有被_的方式使用
不是來自實現協議的屬性
不是來自Category的屬性
不存在字符串使用和屬性名一致

可選的修復方式

移除對應的屬性
如果是接口協議的屬性，需要添加類實現此接口

注意事項

可能存在部分動態使用的場景，需要進行一定的檢查。例如一些繼承NSObject的數據模型類，可能存在屬性沒有被直接使用到，但是可能會被傳喚成JSON作為參數的情況。例如后臺下發的數據模型

未使用的ImageSet/DataSet

包含的Imageset/DataSet并沒有被使用到。

掃描規則

未檢測到和Imageset同樣名字的字符串使用

可選的修復方式

移除ImageSet/DataSet

注意事項

某些Swift代碼中使用的字符串不能被發現所以會被當做未使用。
使用字符串拼接的名字作為imageset的名字。
被合成到PackedAssetImage里的Imageset不能被掃描出來

未使用的ObjC方法

定義的ObjCCategory 方法并未被使用到。

掃描規則

不存在和此方法一樣的方法名使用
不存在使用的字符串和方法名一致
不是來自父類或Category的方法
不是來自實現接口的方法
不是屬性 set/get 方法

可選的修復方式

移除對應方法

未使用的分類方法

定義的ObjCCategory 方法并未被使用到。

掃描規則

不存在和此方法一樣的方法名使用
不存在和方法名一致的字符串使用
不是來自父類或Category的方法
不是來自實現接口的方法

可選的修復方式

移除未使用的方法
如果是接口協議的方法，需要添加類實現此接口

未使用的資源文件

包含的文件資源并沒有被使用到。這里的資源不包含Imageset/DataSet。

掃描規則

未檢測到和文件名同樣名字的字符串使用

可選的修復方式

移除資源

注意事項

某些Swift代碼中使用的字符串不能被發現所以會被當做未使用
使用字符串拼接的名字作為資源的名字

安全

動態反射調用ObjC類

存在類名和字符串一致，可能使用NSClassFromString()方法動態調用類。當字符串或類名變更時無法利用編譯時檢查發現問題，可能會導致功能異常。

掃描規則

存在使用的字符串和NSObject子類類名相同

可選的修復方式

使用NSStringFromClass()獲取類名字符串
使用Framework外部的類應該使用方法封裝，除了少部分功能不應該使用反射去調用類

提示：包含繼承NSObject的 swift 類。

ObjC屬性內存申明錯誤

一些特殊的NSObject類型的屬性內存類型申明錯誤，可能會導致功能異常或觸發Crash。

掃描規則

NSArray/NSSet/NSDictionary類型的屬性使用strong申明
NSMutableArray/NSMutableSet/NSMutableDictionary類型的屬性使用copy申明

可選的修復方式

修改strong/copy申明

沖突的分類方法

ObjC同一個類的多個Category分類中存在多個相同的方法，由于運行時最終會加載方法可能是不確定的，可能會導致功能異常等未知的行為。

掃描規則

NSObject類的多個Category分類中存在多個相同的方法

修復方式

移除多余的分類方法

重復的分類方法

ObjC原始類和類的Category分類中有相同的方法，分類中的方法會覆蓋原始類的方法，可能會導致功能異常等未知的行為。

掃描規則

NSObject原始類和類的Category分類中有相同的方法

修復方式

移除重復的分類方法

未實現的ObjC協議方法

類實現了某個ObjC協議，但是沒有實現協議的非可選方法。可能會導致功能異常或觸發Crash。

掃描規則

類和分類未實現NSObject協議的非可選方法

可選的修復方式

對應的類實現缺失的非可選協議方法
將對應的協議方法標識為optional可選方法

重復的ObjC類

多個動態庫和靜態庫之間存在同樣的類。不會導致編譯失敗，但是運行時只會使用其中一個類，可能會導致功能異常或觸發Crash。同時會增加包體積。

掃描規則

多個動態庫和靜態庫之間存在同樣的NSObject類符號

可能的修復方式

移除重復的類

性能

使用動態庫

使用動態庫會增加啟動耗時。

掃描規則

Macho為動態庫

可選的修復方式

使用靜態庫
使用Mergeable Library

實現`+load`方法的類

APP啟動后會執行所有+load方法，減少+load方法可以降低啟動耗時。

掃描規則

實現+load方法的NSObject類

可選的修復方式

移除+load方法
使用+initialize替代

自定義配置

重要配置

systemFrameworkPaths

可以基于自身項目進行系統庫目錄的配置，解析工程時也會對系統庫進行解析。配置系統庫目錄對于未使用方法的查找可以提供更多的信息避免誤報。但是配置更多會導致執行的更慢，建議至少配置Foundation/UIKit。

unusedObjCProperty-enable

unusedObjCProperty規則默認不開啟。

開啟未使用屬性檢查以后，會掃描macho的__TEXT段，會增加分析的耗時。

unusedClass-swiftEnable

unusedClass-swiftEnable默認不開啟。

開啟Swift類檢查以后，會掃描macho的__TEXT段，會增加分析的耗時。
未使用Swift類的項目建議不要開啟，如果考慮執行性能的話Swift使用相對比較多的再開啟。

提示：掃描macho的__TEXT段需要使用XCodeRun編譯出的包，不能直接使用用于上架APP Store構建出的包。主要是Debug會包含更多的信息用于掃描。

配置屬性

/Users/Test/APPAnalyzeCommand -ipa /Users/Desktop/ipas/APPMobile/APPMobile.app -config /Users/Desktop/ipas/config.json --output /Users/Desktop/ipas/APPMobile

可基于自身項目需要，添加下列規則可配置參數。在使用APPAnalyzeCommand指令時添加--config配置文件地址。

{"systemFrameworkPaths": ["/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Library/Developer/CoreSimulator/Profiles/Runtimes/iOS.simruntime/Contents/Resources/RuntimeRoot/System/Library/PrivateFrameworks/UIKitCore.framework/UIKitCore", "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Library/Developer/CoreSimulator/Profiles/Runtimes/iOS.simruntime/Contents/Resources/RuntimeRoot/System/Library/Frameworks/CoreFoundation.framework/CoreFoundation","/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Library/Developer/CoreSimulator/Profiles/Runtimes/iOS.simruntime/Contents/Resources/RuntimeRoot/System/Library/Frameworks/Foundation.framework/Foundation"], // 配置系統庫。會極大增加未使用方法的誤報"rules": {"dynamicCallObjCClass": { // 動態調`ObjC類"enable": false, // 是否啟用"excludeClasslist": [ // 過濾類名"NSObject","param"]},"incorrectObjCPropertyDefine": { // 錯誤的 ObjC 屬性定義"enable": false // 是否啟動},"largeResource": { // 大資源"maxSize": 20480 // 配置大資源判定大小。默認 20480Byte=20KB},"unusedObjCProperty": { // 未使用的 ObjC 屬性"enable": false, // 是否啟用。默認不開啟"excludeTypes": ["NSString", "NSArray", "NSDictionary", "NSNumber", "NSMutableArray", "NSMutableDictionary", "NSSet"] // 過濾掉部分類型的屬性},"unusedClass": { // 未使用的類"swiftEnable": false, // 是否支持 Swift 類。默認不支持"excludeSuperClasslist": ["JDProtocolHandler", "JDProtocolScheme"],// 如果類繼承了某些類就過濾"excludeProtocols": ["RCTBridgeModule"], // 如果類實現了某些協議就過濾"excludeClassRegex": ["^jd.*Module$", "^PodsDummy_", "^pg.*Module$", "^SF.*Module$"] // 過濾掉名字符合正則表達式的類},"unusedObjCMethod": { // 未使用的 ObjC 方法"excludeInstanceMethods": [""], // 過濾掉某些名字的對象方法"excludeClassMethods": [""], // 過濾掉某些名字的類方法"excludeInstanceMethodRegex": ["^jumpHandle_"], // 過濾掉名字符合正則表達式的對象方法"excludeClassMethodRegex": ["^routerHandle_"], // 過濾掉名字符合正則表達式的類方法"excludeProtocols": ["RCTBridgeModule"] // 如果類集成了某些協議就不再檢查，例如 RN 方法},"loadObjCClass": { //  調用 ObjC + load 方法"excludeSuperClasslist": ["ProtocolHandler"], // 如果類繼承了某些類就過濾"excludeProtocols": ["RCTBridgeModule"] // 如果類實現了某些協議就過濾，例如 RN 方法},"unusedImageset": { // 未使用 imageset"excludeNameRegex": [""] // 過濾掉名字符合正則表達式的imageset},"unusedResource": { // 未使用資源"excludeNameRegex": [""] // 過濾掉名字符合正則表達式的資源}}
}

組件化工程掃描

可以基于APPAnalyzeCore.framework定制實現自己的組件化工程掃描，或者添加基于自身組件化工程的檢查規則。詳情可以看Demo。

基于組件化掃描方式有以下優勢：

細化數據粒度- 可以細化每個模塊的包體積和包體積問題，更容易進行包體積優化。
更多的檢查- 例如檢查不同組件同一個Bundle包含同名的文件，不同組件包含同一個category方法的的實現。
檢查結果更準確- 例如ObjC未使用方法的檢查，只要存在一個和方法名同樣的調用就表示方法有被使用到。但是整個ipa中可能存在很多一樣的方法名但是只有一個方法有真正被調用到，如果細分到組件的粒度就可以發現更多問題。

提示：只有APP主工程無代碼，全部通過子組件以framework的形式導入二進制庫的方式的工程才適合這種模式。

其他

掃描質量如何

這套工具我們團隊內部開發加逐步完善有一年的時間了。基于此工具修改了幾十個組件的包體積問題，同時不斷的修復誤報問題。目前現有提供的這些規則檢查誤報率是很低的，只有極少數幾個規則可能存在誤報的可能性，總體掃描質量還是很高的。

和社區開源的工具有什么差異

我們在早期調研了社區的幾個同類型的開源工具，主要存在以下幾個問題：

擴展性不夠- 無法支持項目更好的擴展定制能力，例如添加掃描規則、支持不同類型掃描方式、生成更多的報告類型。
功能不全- 只提供部分能力，例如只提供未使用資源或者未使用類。
無法生成包體積數據- 無法生成包體積完整的數據。
檢查質量不高- 掃描發現的錯誤數據多，或者有一些問題不能被發現。

開源計劃

后續一定會開源。主要是希望調整一些內部結構再開源，開源后就不方便調整。順便修復一些常見的問題。

開源帶來的好處

開源帶來的好處是，部分工程可以基于自身的業務需要，擴展定制自己的掃描工具。同時也可以將一些更好的想法實現添加進來。

擴展解析方式- 目前只支持ipa模式掃描，很快會開放支持project組件化工程的掃描方式。基于組件化工程的掃描可以更加準確，但是不同的公司組件化工程的構建方式可能是不一樣的，有需要可以在上層定制自身組件化工程的掃描解析。
擴展掃描規則- 雖然現在已經添加了比較多的通用性的規則，同時提供了一定的靈活性配置能力。但是不同的項目可能需要定制一些其他的規則，這些規則沒辦法通過在現有規則上添加配置能力實現。
擴展數據生成- 默認包里只包含兩種數據生成，包體積數據還有包體積待修復問題數據。可以擴展更多的數據生成格式，例如我們自身的項目就有添加基于組件的依賴樹格式。