當前是有些工具比如apktool,dextojar等是可以對我們android安裝包進行反編譯,獲得源碼的。為了減少被別人破解,導致源碼泄露,程序被別人盜取代碼,等等。我們需要對代碼進行混淆,android的sdk中為我們提供了ProGrard這個工具,可以對代碼進行混淆(一般是用無意義的名字來重命名),以及去除沒有使用到的代碼,對程序進行優化和壓縮,這樣可以增加你想的難度。最近我做的項目,是我去配置的混淆配置,因此研究了一下,這里分享一下。
如何啟用ProGuard
ant項目和eclipse項目啟用方法
在項目的project.properties文件中添加一下代碼
proguard.config=proguard.cfg //proguard.cfg為proguard的配置文件
proguard.config=/path/to/proguard.cfg //路徑不在項目根目錄時,填寫實際路徑
填寫這句配置后,在release打包時就會按照我們的配置進行混淆,注意,在我們平時的debug時是不會進行混淆的。
Gradle項目(以及Android Studio)
在build.gradle中進行配置
android {
buildTypes {
release {
runProguard true
proguardFiles getDefaultProguardFile('proguard-android.txt'),'some-other-rules.txt'
//proguardFile 'some-other-rules.txt' 配置單個文件這樣
}
}
}
如上面代碼所示,我們可以使用runProguard true開啟,并且對其配置混淆配置,可以配置多個文件或單個文件。
android的sdk中已經為我們提供了兩個默認的配置文件,我們可以拿過來進行使用,proguard-android.txt和proguard-android-optimize.txt。
ProGuard配置
上面說到android為我們提供了兩個默認的配置文件,在其中,我們可以看到他的一些語法。本節進行描述。
保留選項(配置不進行處理的內容)
-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 不混淆輸入的類文件
-obfuscationdictionary {filename} 使用給定文件中的關鍵字作為要混淆方法的名稱
-overloadaggressively 混淆時應用侵入式重載
-useuniqueclassmembernames 確定統一的混淆類的成員名稱來增加混淆
-flattenpackagehierarchy {package_name} 重新包裝所有重命名的包并放在給定的單一包中
-repackageclass {package_name} 重新包裝所有重命名的類文件中放在給定的單一包中
-dontusemixedcaseclassnames 混淆時不會產生形形色色的類名
-keepattributes {attribute_name,...} 保護給定的可選屬性,例如LineNumberTable, LocalVariableTable, SourceFile, Deprecated, Synthetic, Signature, and InnerClasses.
-renamesourcefileattribute {string} 設置源文件中給定的字符串常量
后面的文件名,類名,或者包名等可以使用占位符代替
?表示一個字符
- 可以匹配多個字符,但是如果是一個類,不會匹配其前面的包名
** 可以匹配多個字符,會匹配前面的包名。
在android中在android Manifest文件中的activity,service,provider, receviter,等都不能進行混淆。一些在xml中配置的view也不能進行混淆,android提供的默認配置中都有。
ProGuard的輸出文件及用處
混淆之后,會給我們輸出一些文件,在gradle方式下是在<project_dir>/build/proguard/目錄下,ant是在<project_dir>/bin/proguard目錄,eclipse構建在<project_dir>/proguard目錄像。
分別有以下文件:
- dump.txt 描述apk文件中所有類文件間的內部結構。
- mapping.txt 列出了原始的類,方法,和字段名與混淆后代碼之間的映射。
- seeds.txt 列出了未被混淆的類和成員
- usage.txt 列出了從apk中刪除的代碼
當我們發布的release版本的程序出現bug時,可以通過以上文件(特別時mapping.txt)文件找到錯誤原始的位置,進行bug修改。同時,可能一開始的proguard配置有錯誤,也可以通過錯誤日志,根據這些文件,找到哪些文件不應該混淆,從而修改proguard的配置。
注意:重新release編譯后,這些文件會被覆蓋,所以沒吃發布程序,最好都保存一份配置文件。
調試Proguard混淆后的程序
上面說了輸出的幾個文件,我們在改bug時可以使用,通過mapping.txt,通過映射關系找到對應的類,方法,字段等。
另外Proguard文件中包含retrace腳本,可以將一個被混淆過的堆棧跟蹤信息還原成一個可讀的信息,window下時retrace.bat,linux和mac是retrace.sh,在<sdk_root>/tools/proguard/文件夾下。語法為:
retrace.bat|retrace.sh [-verbose] mapping.txt [<stacktrace_file>]
例如:
retrace.bat -verbose mapping.txt obfuscated_trace.txt
如果你沒有指定<stacktrace_file>,retrace工具會從標準輸入讀取。
一些常用包的Proguard配置
下面再寫一些我在項目中使用到的一些第三方包需要單獨配置的混淆配置
sharesdk混淆注意
-keep class android.net.http.SslError
-keep class android.webkit.**{*;}
-keep class cn.sharesdk.**{*;}
-keep class com.sina.**{*;}
-keep class m.framework.**{*;}
Gson混淆配置
-keepattributes *Annotation*
-keep class sun.misc.Unsafe { *; }
-keep class com.idea.fifaalarmclock.entity.***
-keep class com.google.gson.stream.** { *; }
Umeng sdk混淆配置
-keepclassmembers class * {
public <init>(org.json.JSONObject);
}
-keep class com.umeng.**
-keep public class com.idea.fifaalarmclock.app.R$*{
public static final int *;
}
-keep public class com.umeng.fb.ui.ThreadView {
}
-dontwarn com.umeng.**
-dontwarn org.apache.commons.**
-keep public class * extends com.umeng.**
-keep class com.umeng.** {*; }
關于配置方面,我寫的不夠詳細,可以去看參考資料第二條,proguard官方文檔。也歡迎大家交流使用遇到的問題和心得。
資料參考:
1.http://proguard.sourceforge.net/
2.http://developer.android.com/tools/help/proguard.html