無效資源清理實踐
前言
在實際的項目中隨著APP地迭代在新功能的不斷添加的同時也會有一些功能廢棄了或者是伴隨著UI的改版我們在疲于應付產品的各種需求的同時很難保證每次UI改版或者功能廢棄時去完整的刪除所有的無效的代碼以及清除這些模塊引用的各種失效的資源。
因此隨著APP的不斷迭代，功能越來越多Apk的大小是不以我們程序猿的意志而不斷增長的。雖然我們不能阻止APK不斷增長的大勢，但是我們可以放緩增長的速度，因此在Apk瘦身這一塊也有很多我們程序猿們發揮的空間。
對于APK瘦身包括代碼混淆減少未引用的代碼以及簡化命名，圖片壓縮使用Webp適當合理適配，引入的各種第三庫的權衡等等。 限于篇幅和本文目的不會面面俱到。
本文目的
這篇文章主要是介紹利用Lint掃描項目中失效的各種String、layout、drawable、dimen等資源以及圖片資源。 雖然在AndroidStudio中為我們提供了一鍵掃描一鍵清理的功能。在我們實際的一個比較大的項目中想必大家不敢直接這么簡單粗暴的操作吧。畢竟lint無法發現我們動態的訪問資源的方式，更麻煩的是編譯雖然能夠通過，但是運行時去訪問這些被刪的資源輕則做了異常處理就是各種顯示異常重則就是各種Crash。這時除了在心里默默的吐槽哪個隊友這樣子訪問資源而不是直接引用呢?我們能做的就是增加一些自定義去解決這種問題咯。這里我就像大家介紹我們項目中結合Lint掃描發現無效資源，然后利用自己開發的java小程序 對掃描的資源添加白名單，備份 刪除功能。 這樣可以在一鍵清除和手動一個個查找之間尋找到一個平衡。
清理資源實踐步驟
- 在AndroidStudio的terminal中執行gradlew lint 生成lint-results-debug.xml分析結果文件。
- 開啟備份模式 執行UnUsedResourceCleanUtil 清理資源Java Application 對資源進行清理; (這一步只是列出項目中無效資源的清單不會執行刪除操作)
- 找出動態引用的資源加入白名單的配置中，避免誤刪除(這一步第一次執行資源清理會比較麻煩，特別是工程規模比較大歷史悠久的項目 很難完全確定哪些掃描出的無效資源是被動態引用的，一般一堆命名為abc_1 abc_2 這樣一組圖片極有可能在代碼中是動態引用的，因此對于掃描出的這種資源需要在代碼中確認是否有被動態訪問。 第一遍后有了白名單就要輕松一些了； 對于第一次執行 最好是讓QA注意全回歸 不然某些邊邊角角的功能出現crash就麻煩了)
- 執行實際的刪除資源的操作(建議第一次執行時 每個module分別執行 然后自測 畢竟一個大的項目一起執行完 自測會hold不住的)
- 重復步驟1 (一般執行一次資源清理 后再次掃描 又會有新的資源成為了無效資源 因此一般需要重復個2到3次直到沒有掃描出新的無效資源為止
UnUsedResourceCleanUtil Java小程序簡介
1.整體功能：UnUsedResourceCleanUtil 主要是對lint生成的xml文件進行處理對xml文件中的UnusedResourcestag的數據進行處理，資源文件分為兩種 一種是比如圖片 以及drawable、 anim、layout等整個文件為單位進行備份和刪除而values 目錄下的string、dimens、corlors等以文件中每一行定義的字符串 、顏色等為單位進行備份和刪除
2.基本配置
- 首先要配置項目的路徑: 在項目入口類UnUsedResourceCleanUtil中配置PROJECT_ROOT_PATH字段為你項目的根地址例如“C:/project_solution/trunk/”；
- 掃描出的無效資源清單以及備份文件目錄 DES_DIR 這個可以配置電腦上你覺得方便的地方就好例如“D:/UnUsedResourceBackup”
- 指定白名單文件 IGNORE_FILE_NAME字段例如 ignore_delete_resource.txt
對于不能刪的文件比如一些圖片 就在此txt文件中添加一行例如{module}\src\main\res\drawable-hdpi\abc_ 那么該路徑下abc_*的圖片均不會被刪除
-備份模式以及實際刪除模式配置：UnUsedResourceCleanUtil.cleanUnUseResourceByModuleName(String moduleName, boolean isDelete)第二個參數重點注意 傳FALSE僅僅只是列出無效資源清單 以及備份 true時才會實際執行刪除 - 模塊配置 MODULE_NAMES數組列出Android Studio工程中需要清理資源的模塊名稱清單{"module1", "module2", "module23"}
- 完成上面一些主要和本地環境路徑相關的配置和白名單清單的配置就可以之間run UnUsedResourceCleanUtil 小程序就可以對項目中的各種無效資源進行清理啦。
END
小程序代碼量也比較小，功能也比較簡單 so 在利用我提供的這個工具對實際項目進行資源清理前還是務必先read the fucking soure code
奉上 GitHub地址
最后的最后 其實清理資源最麻煩的還是 資源誤刪 不好測試的問題； 我這里主要是通過第一次吃螃蟹后整理出項目中動態引用資源的白名單，然后有了白名單工作就要輕松一些了。 至于大家還有什么其它的妙招，還請不吝賜教
也非常歡迎大家看看源碼提出您寶貴的意見和issue 好讓我對UnUsedResourceCleanUtil的代碼和功能進一步進行完善。
