清除Android工程中沒用到的資源

AngelDevil發表於2014-05-13
Android

專案需求一改再改，UI一調再調，結果就是專案中一堆已經用不到但卻沒有清理的垃圾資源，不說工程大小問題，對新進入專案的人或看其他模組的程式碼的人來說，這些沒清理的資源可能也可能會帶來困擾，所以最好還是清理掉這些垃圾，對於一個稍微大一點的工程來說，手工清理明顯是不現實的，這就需要一個方法做這些事情。

清理資原始檔

要清理沒用的資源，首要的工作當然是找到他們，我們知道Anroid SDK中有一個工具叫lint，可以幫助我們檢視工程中存在的問題，其中有一項功能就是查詢沒用到的資源，這樣這一步就簡單了，直接對需要清理的工程執行以下命令：

lint --check "UnusedResources" [project_path] > result.txt

執行完以上命令後工程中關於UnusedResources的問題就都儲存到result.txt了，先來看一下result.txt的內容

res/values/arrays.xml:202: Warning: The resource R.array.msg_my_friend_category_items appears to be unused [UnusedResources]
^M
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
res/layout/back_up_level_list.xml: Warning: The resource R.layout.back_up_level_list appears to be unused [UnusedResources]
res/layout/backup_list.xml: Warning: The resource R.layout.backup_list appears to be unused [UnusedResources]
res/layout/backup_listview_item.xml: Warning: The resource R.layout.backup_listview_item appears to be unused [UnusedResources]

可以看到列出了沒用到的layout及沒用到的values值等資訊。有了這些資訊，接下來需要做的就是分析這些資訊了，手工分析不太現實，因為這個檔案可能會非常大，比如我執行上述命令後檔案就有2212行，這種事情，當然是交給計算機解決了。

仔細看生成的文字中的內容會發現結果是按行輸出的，每個問題是單獨的一行，而且每一行中的內容也很有規律

file_path[:line]: Warning: info [UnusedResources}

所以還是可以很方便地得到哪個檔案甚至哪行有問題的，我處理的時候只清理了沒用的檔案，像上面的res/values/arrays.xml:202就沒有管，下面看下怎麼清除沒用到的資原始檔。

String projectPath = "***";
BufferedReader reader = new BufferedReader(new FileReader("/home/angeldevil/result.txt"));
String line;
int count = 0;
while((line = reader.readLine()) != null) {
    if (line.contains("UnusedResources") && !line.contains("res/value") && !line.contains("appcompat")) {
        count++;
        int end = line.indexOf(":");
        if (end != -1){
            String file = line.substring(0, end);
            String f = projectPath +file;
            System.out.println(f);
            new File(f).delete();
        }
    }
}

程式非常簡單，就幾行程式碼，就是讀取result.txt檔案的每一行，根據自己需要的條件過濾掉不需要處理的行（比如我只想清理anim、drawable及layout，所以過濾掉res/value目錄下的資訊，並且忽略appcompat相關的資訊），每一行":"前的字串就是檔名，找到了檔名就好處理了，直接刪除，或者列印出來，或者寫到一個檔案裡以再次確認是否確認要刪除，當把結果寫到一個檔案後我們就可以檢視這個檔案是否有現在沒用到但仍不想刪除的檔案，如果有，處理方法也很簡單，去掉這一行或簡單地做個標記，如前面打#，然後再讀取這個檔案把沒做標記的行對應的檔案刪除就行了。

看起來很簡單，但是有幾點需要注意：

  1. 有些layout檔案，可能你之前用了他們，並在相應的Java檔案中用了這個layout佈局中的id，如對某些ID的控制元件設定了onClickListener，並在onClick的switch...case中引用了這些ID，但最後又不用這個Layout了，這時這個layout就是UnusedResource，但是以前引用它的Java程式碼中對這個layout中的某些ID的引用還沒清除，此時刪掉這個Layout就會報錯，你可以選擇清理報錯的Java程式碼，因為它們其實時Dead Code。或者每次清理一部分資原始檔，如先清理layout，再清理drawable，對於每一項也可以根據檔名的規則每次再清理一小部分，如只清理res/layout中以item_of開頭的檔案。
  2. lint的分析貌似是不完全準確的，或者說不夠智慧，比如有一個drawable只被一個layout引用，而這個layout又是Unused的，lint可能不會發現這個drawable是Unused，這就需要我們多次重複執行前面的步驟，直到count為0。
  3. lint只能分析資原始檔，即res目錄下的檔案，如果要分析Java檔案還需要其他方法，而且，有可能某個資原始檔被某Java檔案引用，而這個Java檔案又是Unused，這樣這個資原始檔就會逃過lint的檢查，所以我們最好先清理了Java檔案再清理資原始檔。

清理Java檔案

首先還是要找到未用到的檔案，還是利用工具，我用的是UCDetector，即Unused Code Detector，使用方法就不說了，直接Google一下。

安裝Eclipse的UCDetector外掛，對工程執行檢查，這個需要的時間可能會很長，我當時檢查了兩個小時。。同lint一樣，結果會輸出到一個文字檔案中，同樣是每個問題一行，所以只要行分析就行了，比如這樣：

com..SampleAdapter.(SampleAdapter.java:18) Class "SampleAdapter" has 0 references SampleAdapter org.ucdetector.analyzeMarkerReference
com..SampleAdapter.(SampleAdapter.java:56) Change visibility of Member class "SampleAdapter.ViewHolder" to private - May cause compile errors! SampleAdapter.ViewHolder org.ucdetector.analyzeMarkerVisibilityPrivate

可以看到，檢測結果中包含很多資訊，如某個類沒被用到，某個方法的可見性太大等，同樣的，現在只處理沒用到的類檔案，其他不管了。

String reportPath = "**/ucdetector_reports/UCDetectorReport_001.txt";
BufferedReader reader = new BufferedReader(new FileReader(reportPath));
String line;
int count = 0;
while((line = reader.readLine()) != null) {
    if (line.contains("Class") && line.contains("has 0 references") && !line.contains("Method")[ && other conditions]) {
        count++;
        int end = line.indexOf(".<init>");
        if (end != -1){
            String className = line.substring(0, end);
            System.out.println(className);
        }
    }
}

通過以上程式碼基本上就能找到沒用到的類了，還是建議不直接刪除而是把結果輸出出來，因為結果輸出來以後你會發現很多檔案你是不想刪除的，如：

com.nostra13.universalimageloader.core.assist.DiscCacheUtil.(DiscCacheUtil.java:31) Class "DiscCacheUtil" has 0 references DiscCacheUtil org.ucdetector.analyzeMarkerReference Sergey Tarasevich (nostra13[at]gmail[dot]com)

某些類庫中的檔案也可能會被檢測出來，對於這種直接在if條件中過濾掉就好了，也可能自己的一些檔案暫時沒用到但不想刪除，從結果中過濾就好了。

總結

清理資源就兩個步驟：

  1. 找到未用到的資源
  2. 按需清理這些資源

通過UCDetector和lint基本上就可以檢測到專案中UnusedResource相關的問題了，一般像方法可見性，某個方法沒用到這種問題，不處理也罷，改到相應的檔案時手工處理算了，主要處理的就是某些檔案或類沒被用到，有檢測報告，分析下報告就行了。這種報告一般是每行報告一個問題並且每行的文字是有規律的（工具生成的肯定有規律），按規律過濾出我們需要的資訊就行了

相關文章