user模式下編譯android 代碼被proguard最佳化導致類和變數丟失

標籤：android   http   io   ar   os   使用   sp   for   java   

在Android項目中用到JNI，當用了proguard後，發現native方法找不到很多變數，原來是被produard最佳化掉了。所以，在JNI應用中該慎用progurad啊。 

解決辦法： 
1、在Android.mk中加入一行： 
LOCAL_PROGUARD_FLAGS := -include $(LOCAL_PATH)/proguard.flags 
2、建立proguard.flag檔案，裡面寫入不需要proguard最佳化的類和方法。例如： 

-keep class oms.miracle.mobiletv.broadcast.ServiceContext { 
*; 
} 

我的這個類是和JNI相關的，不想讓proguard去最佳化而引起錯誤，向上面寫就能實現。 

----------下面是網上找到的一些proguard的資料，貼出來分享： 
ProGuard是一個免費的java類檔案壓縮,最佳化,混淆器.它探測並刪除沒有使用的類,欄位,方法和屬性.它刪除沒有用的說明並使用位元組碼得到最大最佳化.它使用無意義的名字來重新命名類,欄位和方法. 

ProGuard的使用是為了: 

1.建立緊湊的代碼文檔是為了更快的網路傳輸,快速裝載和更小的記憶體佔用. 
2.建立的程式和程式庫很難使用反向工程. 
3.所以它能刪除來自源檔案中的沒有調用的代碼 
4.充分利用java6的快速載入的優點來提前檢測和返回java6中存在的類檔案. 

參數： 

-include {filename}    從給定的檔案中讀取配置參數 

-basedirectory {directoryname}    指定基礎目錄為以後相對的設定檔名稱 

-injars {class_path}    指定要處理的應用程式jar,war,ear和目錄 

-outjars {class_path}    指定處理完後要輸出的jar,war,ear和目錄的名稱 

-libraryjars {classpath}    指定要處理的應用程式jar,war,ear和目錄所需要的程式庫檔案 

-dontskipnonpubliclibraryclasses    指定不去忽略非公用的庫類。 

-dontskipnonpubliclibraryclassmembers    指定不去忽略包可見的庫類的成員。 


保留選項 
-keep {Modifier} {class_specification}    保護指定的類檔案和類的成員 

-keepclassmembers {modifier} {class_specification}    保護指定類的成員，如果此類受到保護他們會保護的更好 

-keepclasseswithmembers {class_specification}    保護指定的類和類的成員，但條件是所有指定的類和類成員是要存在。 

-keepnames {class_specification}    保護指定的類和類的成員的名稱（如果他們不會壓縮步驟中刪除） 

-keepclassmembernames {class_specification}    保護指定的類的成員的名稱（如果他們不會壓縮步驟中刪除） 

-keepclasseswithmembernames {class_specification}    保護指定的類和類的成員的名稱，如果所有指定的類成員出席（在壓縮步驟之後） 

-printseeds {filename}    列出類和類的成員-keep選項的清單，標準輸出到給定的檔案 

壓縮 
-dontshrink    不壓縮輸入的類檔案 

-printusage {filename} 

-whyareyoukeeping {class_specification}     

最佳化 
-dontoptimize    不最佳化輸入的類檔案 

-assumenosideeffects {class_specification}    最佳化時假設指定的方法，沒有任何副作用 

-allowaccessmodification    最佳化時允許訪問並修改有修飾符的類和類的成員 

混淆 
-dontobfuscate    不混淆輸入的類檔案 

-printmapping {filename} 

-applymapping {filename}    重用映射增加混淆 

-obfuscationdictionary {filename}    使用給定檔案中的關鍵字作為要混淆方法的名稱 

-overloadaggressively    混淆時應用侵入式重載 

-useuniqueclassmembernames    確定統一的混淆類的成員名稱來增加混淆 

-flattenpackagehierarchy {package_name}    重新封裝所有重新命名的包並放在給定的單一包中 

-repackageclass {package_name}    重新封裝所有重新命名的類檔案中放在給定的單一包中 

-dontusemixedcaseclassnames    混淆時不會產生形形色色的類名 

-keepattributes {attribute_name,...}    保護給定的可選屬性，例如LineNumberTable, LocalVariableTable, SourceFile, Deprecated, Synthetic, Signature, and InnerClasses. 

-renamesourcefileattribute {string}    設定源檔案中給定的字串常量 


因為我們開發的是webwork+spring+hibernate的架構的項目，所有需要很詳細的配置。（經過n次失敗後總結） 

Example: 
    -injars <project>.jar 
    -outjars <project>_out.jar 

    -libraryjars <java.home>/lib/rt.jar 
    -libraryjars <project.home>/webroot/WEB-INF/lib/webwork.jar 
    ....... 

    # 保留實現Action介面類中的公有的，友好的，私人的屬性 和 公有的，友好的方法。其它的全部壓縮，最佳化，混淆。 
    # 因為設定檔中的類名是一個完整的類名，如果經過處理後就有可能找不到這個類。 
    # 屬性是jsp頁面所需要的，如果經過處理jsp頁面就無法得到action中的資料。 
    -keep public class * implements com.opensymphony.xwork.Action{ 
        public protected private <fields>; 
        public protected <methods>; 
    } 

    # 保留實現了Serializable介面類中的公有的，友好的，私人的成員（屬性和方法） 
    # 這個配置主要是對應實體類的配置。 
    -keep public class * implements java.io.Serializable{ 
        public protected private *; 
    } 

    ...... 




>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> 


我們做java開發的一般都會遇到如何保護我們開發的代碼問題。java語言由於是基於jvm上面，所以反編譯class 檔案很很容易。假如我們做了一個web程式，並把這個web程式發布給客戶。實際上，客戶是很容易反編譯出我們的原始碼出來，包括所有的src檔案和 jsp檔案等等。 

那麼，如何保護我們的原始碼，實際上，應該有幾種方法可以使用：1、使用代碼混淆器 2、重載應用伺服器的classloader 

對於第一種方法來說，現在外面有很多開源工具可以使用，個人認為最好用的當屬proguard莫屬。proguard主要是易用易學。而且提供的功能也挺多。下面是個人一點使用心得 

（1）、從網上download proguard工具，proguard工具主要包含是幾個jar檔案和一些example，http://proguard.sourceforge.net/ 

（2）、將裡面的幾個jar檔案添加到類路徑下面。當然，也可以不添加，但是下面在做混淆的時候，必須指定classpath，使在做混淆的過程中，能否訪問該類 

（3）、編寫一個設定檔，主要是混淆器的一些參數。比如，下面是一個例子 
-injars platform.jar 
-outjars platform_out.jar 
-libraryjars <java.home>/lib/rt.jar 
-libraryjars ibatis-common-2.jar 
-libraryjars ibatis-dao-2.jar 
-libraryjars ibatis-sqlmap-2.jar 
-libraryjars junit-3.8.1.jar 
-libraryjars d:/j2ee.jar 
-libraryjars struts.jar 
-libraryjars commons-lang.jar 
-libraryjars D:/0working/coreproject/byislib/jasperreports-0.6.1.jar 
-libraryjars commons-beanutils.jar 

-printmapping proguard.map 
-overloadaggressively 
-defaultpackage ‘‘ 
-allowaccessmodification 
-dontoptimize 
-keep public class * 
{ 
public protected *; 
} 
-keep public class org.** 
-keep public class it.** 

各個參數的含義參考proguard文檔，該文檔非常詳細，上手很容易 

OK，到此就完成了代碼混淆，開啟產生的jar包可以看到，多了好多a、b、c之類的類檔案。說明混淆結果已經成功。將原jar刪除、運行產生的混淆jar包，一切正常！ 

常見問題：使用過程中個人遇到了幾個問題，開始也是找了很久才解決 
a. 記憶體溢出異常： 主要是proguard在做混淆的時候，吃了很多記憶體，因此，在運行混淆器的時候，可以增加記憶體，比如 java -mx512m ..... 
b.棧溢出異常： 主要是proguard在做混淆的時候，會對一些代碼進行最佳化，若遇到一些相對複雜的方法時，可能會拋出此異常。對付的辦法是增加配置參數-dontoptimize，如上面的配置例子所示 

對於第二種方法，重載伺服器的classloader的原理是這樣。 首先我們通過一定演算法把class檔案加密； 然後寫我們自己的classloader，替換伺服器的classloader。 這樣，我們可以讀取class檔案，通過我們自己的演算法反加密成正確的class，然後再次進行load。這個方式還沒應用起來，這幾天個人正在研究，有什麼新成果會在此做一些總結。


ProGuard是一個開源的項目，首頁：http://proguard.sourceforge.net/，目前最新的版本是3.3.2.。載入混淆器是非常簡單的，只需要解壓縮 proguard3.3.2.zip，然後在 J2ME->Packing->Obfuscation 標籤中選擇 Proguard 的安裝目錄。如所示，在這裡可以對需要在混淆過程中保留的類名進行配置，MIDlet 類的名稱必須保留，以便裝置的 Java 運行時環境（JRE）能夠找到執行的進入點。 
http://images.csdn.net/20050726/image027.jpg，It’s about the above pic. 



另一篇文檔 
ProGuard 是一款免費的Java類檔案壓縮器、最佳化器和混淆器。它能發現並刪除無用類、欄位（field）、方法和屬性值（attribute）。它也能最佳化位元組碼並刪除無用的指令。最後，它使用簡單無意義的名字來重新命名你的類名、欄位名和方法名。經過以上操作的jar檔案會變得更小，並很難進行逆向工程。這裡提到了ProGuard的主要功能是壓縮、最佳化和混淆，下面我就先介紹一下這些概念，然後再介紹ProGuard的基本使用方法。 

l 什麼是壓縮： 

Java 原始碼（.java檔案）通常被編譯為位元組碼（.class檔案）。而完整的程式或程式庫通常被壓縮和發布成Java文檔（.jar檔案）。位元組碼比 Java源檔案更簡潔，但是它仍然包含大量的無用代碼，尤其它是一個程式庫的時候。ProGuard的壓縮程式操作能分析位元組碼，並刪除無用的類、欄位和方法。程式只保留功能上的等價，包括異常堆棧描述所需要的資訊。 

l 什麼是混淆： 

通常情況下，編譯後的位元組碼仍然包含了大量的調試資訊：源檔案名稱，行號，欄位名，方法名，參數名，變數名等等。這些資訊使得它很容易被反編譯和通過逆向工程獲得完整的程式。有時，這是令人厭惡的。例如像ProGuard這樣的混淆器就能刪除這些調試資訊，並用無意義的字元序列來替換所有名字，使得它很難進行逆向工程，它進一步免費的精簡代碼。除了異常堆棧資訊所需要的類名，方法名和行號外，程式只會保留功能上的等價。通過以上的瞭解，你應該明白為什麼需要混淆了。 

l ProGuard支援那些種類的最佳化： 

除了在壓縮操作刪除的無用類，欄位和方法外，ProGuard也能在位元組碼級提供效能最佳化，內部方法有： 

² 常量運算式求值 

² 刪除不必要的欄位存取 

² 刪除不必要的方法調用 

² 刪除不必要的分支 

² 刪除不必要的比較和instanceof驗證 

² 刪除未使用的代碼 

² 刪除唯寫欄位 

² 刪除未使用的方法參數 

² 像push/pop簡化一樣的各種各樣的peephole最佳化 

² 在可能的情況下為類添加static和final修飾符 

² 在可能的情況下為方法添加private, static和final修飾符 

² 在可能的情況下使get/set方法成為內聯的 

² 當介面只有一個實作類別的時候，就取代它 

² 選擇性的刪除日誌代碼 

實際的最佳化效果是依賴於你的代碼和執行代碼的虛擬機器的。簡單的虛擬機器比有複雜JIT編譯器的進階虛擬機器更有效。無論如何，你的位元組碼會變得更小。 

仍有一些明顯需要最佳化的技術不被支援： 

² 使非final的常量欄位成為內聯 

² 像get/set方法一樣使其他方法成為內聯 

² 將常量運算式移到迴圈之外 

² Optimizations that require escape analysis 



ProGuard 是一個命令列工具，並提供了圖形化使用者介面，它也可以結合Ant或J2ME Wireless Toolkit使用。通過ProGuard得到的更精簡的jar檔案意味著只需要更小的儲存空間；網路傳輸更省時；裝載速度更快和佔用更小的記憶體空間。另外，ProGuard非常快速和高效，它僅僅只花費幾秒鐘和幾兆的記憶體在處理常式。它處理的順序是先壓縮，然後最佳化，最後才進行混淆。The results section presents actual figures for a number of applications.與其他Java混淆器相比，ProGuard的主要優勢可能是它的基於模版檔案的簡單配置。一些直觀的命令列選項或一個簡單的設定檔已經足夠了。例如，下面的配置選項保護了jar檔案裡的所有applets： 

-keep public class * extends java.applet.Applet 

使用者指南裡說明了所有可用的選項，並以大量的例子為你示範這些功能強大的配置選項。 



上面談到了ProGuard的很多好處，現在我們就來看看如何在程式中使用ProGuard吧，之前也提到了ProGuard可以用命令列、圖形介面、Ant等來執行和處理常式，同時也提到了設定檔，下面我們一起來看如何使用： 

用命令列執行ProGuard的命令如下： 

java –jar proguard.jar options…… 

具體的選項可以參考ProGuard的使用者指南，你也可以把這些屬性寫在設定檔裡；運行時，我們只需要指定這個設定檔就行了，例如： 

java –jar proguard.jar @config.pro 

而設定檔的格式也是要按照ProGuard提供的格式來寫的，這個可以參考ProGuard例子裡的設定檔來配置適合你的應用系統的ProGuard設定檔。ProGuard提供了圖形介面的配置和運行程式，你可以在介面上配置你想要的參數，然後運行即可。前面提到的要手動寫的設定檔也可以用圖形介面來配置和產生。 

如果你要在Ant裡運行ProGuard，只需要添加一一個如下的target即可： 

<target name="proguard" depends="init"> 

<taskdef resource="proguard/ant/task.properties" classpath="${lib.dir}/proguard/proguard.jar" /> 

<proguard configuration="${src.dir}/config.pro" /> 

</target> 

你只需要制定lib.dir和src.dir屬性就行了，同樣的，這裡也用了proguard設定檔，跟上面提到的是一樣的。建議大家把ProGuardGUI當成一個組建組態檔案的嚮導來使用，這樣我們只需要修改設定檔而不用重新寫一個設定檔。 

如果你覺得ProGuard還不錯，那就快把它加入你的項目裡吧。 





第三文檔 
這是一個不應該在開源社區出現的東西，但它的的確確是一個開源的項目，正像它的名字一樣，Proguard，即Program Guard（程式衛士），它代表了開源的相對面－－代碼保護。 
　　作為JAVA這樣的進階語言，編譯的產物只是相對原始碼的一個概念而已，位元組碼雖然不像原始碼那樣易懂，但絕不是不可能進行反編譯的，針對JAVA的反編譯產品很多，如CAVAJ,JAD等等。面對反編譯產品的不斷出現，將代碼視為財富的那些開發人員，又何去何從。 
　　混淆器正是在這種背景下應運而生，既然不可能完全地將拒絕反編譯，那就讓他們去反編譯吧，只要反編譯的結果別人不能直接使用不就行了嗎？只要將代碼搞混，讓別人拿到了反編譯的結果也看不懂，甚至不能編譯。 
　　混淆的方法有很多，主要是以下幾方面。 
更名，將私人類，私人的成員，方法體內部的變數名改名，改成a,b,c等等，甚至1,2,3(代碼中不允許不等於成果物中不允許） 
改變邏輯的流向，如將if條件取反，if/else對換 
等價代碼，如將迴圈改成GOTO 
無效代碼，插入不可及的無用代碼 
　　Proguard是一個非常優秀的開源的JAVA混淆器,可以在http://proguard.sourceforge.net/下載到，現在就讓我一起來看一下Proguard. 
　　以3.2版為例，釋放壓縮包，我們看到，作為開源項目就有docs，lib,src,sample檔案夾，在此就不一一介紹了。 
　　進入lib目錄，內有proguard.jar，如果要自己有混淆器的外殼，或作ANT外掛程式的話，會用到它，詳細情況可以參考Proguard的文檔。 
　　我們要看的是proguardgui.jar，這是Proguard的圖形介面，我們使用JDK開啟，注意是JDK，不是JRE。 

點選Input/Output標籤，選擇要混淆的JAR包（注意是JAR包），輸出JAR包，以及用到的所有類庫。 
點選Obfuscation標籤，選中不需要混淆的類（要被反射的類絕對不能被混淆） 
點選Process標籤，Process按鈕，等著看結果吧。 
Proguard中還包括了代碼最佳化和代碼整理的功能，不是本文討論範圍，有興趣的就自己研究吧） 
只混淆方面的選項 



使用此種方式，如果a-z使用過，會轉向aa.class,如配置介面 
1,4,6,9,10,11,12 

原始碼 
package org.zwm.pub; 

public class Bru { 

/** 
* @param args 
*/ 

public static void main(String[] args) { 
// TODO Auto-generated method stub 
System.out.println(showMsg()); 
} 
public static String showMsg() { 
return "You are my sun"; 
} 
} 
反編譯後的代碼 
// Decompiled by Jad v1.5.8g. Copyright 2001 Pavel Kouznetsov. 
// Jad home page: http://www.kpdus.com/jad.html 
// Decompiler options: packimports(3) 

package org.zwm.pub; 

import java.io.PrintStream; 

public class Bru 
{ 

public Bru() 
{ 
} 

public static void main(String args[]) 
{ 
System.out.println(PK0304140008000800fZ()); 
} 

public static String PK0304140008000800fZ() 
{ 
return "You are my sun"; 
} 
} 




類名不變化，方法名混淆。 



另一個例子，希望對大家有協助： 

命令列下，運行ProGuard指令： java -jar proguard.jar @proguard.pro   其中proguard.pro檔案中是指定的混淆資訊。 

例：一個swing應用： 

-injars       gimt.jar 
-outjars      gimt_out.jar 
-libraryjars lib/rt.jar 
-libraryjars lib/antlr/antlr-2.7.5H3.jar 
-libraryjars lib/cglib/cglib-full-2.0.2.jar 
-libraryjars lib/db2-connector/db2jcc_license_cu.jar 
-libraryjars lib/dom4j/dom4j-1.5.2.jar 
-libraryjars lib/encache/ehcache-1.1.jar 
-libraryjars lib/hibernate/hibernate3.jar 
-libraryjars lib/jakarta-common/commons-beanutils.jar 
-libraryjars lib/log4j/log4j-1.2.9.jar 
-libraryjars lib/mysql-connector/mysql-connector-java-3.0.17-ga-bin.jar 
-libraryjars lib/spring/spring.jar 
-libraryjars lib/db2-connector/db2jcc.jar 
-libraryjars lib/jakarta-common/commons-collections-2.1.1.jar 
-libraryjars lib/jakarta-common/commons-dbcp-1.2.1.jar 
-libraryjars lib/jakarta-common/commons-lang-2.0.jar 
-libraryjars lib/jakarta-common/commons-logging-1.0.4.jar 
-libraryjars lib/jakarta-common/commons-pool-1.2.jar 
-libraryjars lib/spring/spring-mock.jar 
-libraryjars lib/j2ee/jta.jar 
-libraryjars lib/db2-connector/db2java.zip 

-printmapping proguard.map 
-overloadaggressively 
-defaultpackage ‘‘ 
-allowaccessmodification 
-dontoptimize 

-keep public class com.wisdom.tool.MainFrame { 
    public static void main(java.lang.String[]); 
} 

-keep class * extends javax.swing.plaf.ComponentUI { 
    public static javax.swing.plaf.ComponentUI createUI(javax.swing.JComponent); 
} 

-keep public class com.wisdom.model.user.* { 
    *; 
} 

-keep public class com.wisdom.service.* { 
    *; 
} 

-keep public class com.wisdom.service.impl.MenuServiceImpl 

一點說明： 
1. 開始沒有加-dontoptimize選項，有時可能會出問題，上面已經提到。 
2. 列出了所有依賴的.jar包。 
3. keep選項告訴proguard，那些不必混淆。 
    a. 對於swing應用，整個程式的入口，不能混淆。 
    b. 對於繼承自ComponentUI的類，createUI不能混淆。 
    c. 利用hibernate的領域對象 spring的服務物件，由於用到了反射機制。 

user模式下編譯android 代碼被proguard最佳化導致類和變數丟失