Android分享：代碼混淆那些事
Android代碼混淆之混淆規則
Android-Dev-Favorites
簡介
ProGuard是一個開源的Java代碼混淆器。它可以混淆Android項目里面的java代碼，對的，你沒看錯，僅僅是java代碼。它是無法混淆Native代碼，資源文件drawable、xml等。
ProGuard作用
- 壓縮: 移除無效的類、屬性、方法等
- 優化: 優化字節碼，并刪除未使用的結構
- 混淆: 將類名、屬性名、方法名混淆為難以讀懂的字母，比如a,b,c；
混淆注意事項
1. 不能混淆
- 在AndroidManifest中配置的類，比如四大組件
- JNI調用的方法
- 反射用到的類
- WebView中JavaScript調用的方法
- Layout文件引用到的自定義View
- 一些引入的第三方庫（一般都會有混淆說明的）
推薦兩個開源項目，里面收集了一些第三方庫的混淆規則
android-proguard-snippets
android-proguard-cn
2. Crash信息處理
代碼混淆的時候記得加上在混淆文件里面記得加上這句：
# keep住源文件以及行號
-keepattributes SourceFile,LineNumberTable
否則你看到的崩潰信息就會變成這樣子:（圖片來自bugly）
4HQAG}@A%VHYAELV1BA}DFG.png
這里推薦bugly的一篇文章： http://bugly.qq.com/bbs/forum.php?mod=viewthread&tid=26&extra=page%3D1
ProGuard使用
1. 常用語法
// 從給定的文件中讀取配置參數
-include {filename}
// 指定基礎目錄為以后相對的檔案名稱
-basedirectory {directoryname}
// 指定要處理的應用程序jar,war,ear和目錄
-injars {class_path}
// 指定處理完后要輸出的jar,war,ear和目錄的名稱
-outjars {class_path}
// 指定要處理的應用程序jar,war,ear和目錄所需要的程序庫文件
-libraryjars {classpath}
// 指定不去忽略非公共的庫類。
-dontskipnonpubliclibraryclasses
// 指定不去忽略包可見的庫類的成員。
-dontskipnonpubliclibraryclassmembers
保留
// 保護指定的類文件和類的成員
-keep {Modifier} {class_specification}
// 保護指定類的成員，如果此類受到保護他們會保護的更好
-keepclassmembers {modifier} {class_specification}
// 保護指定的類和類的成員，但條件是所有指定的類和類成員是要存在。
-keepclasseswithmembers {class_specification}
// 保護指定的類和類的成員的名稱（如果他們不會壓縮步驟中刪除）
-keepnames {class_specification}
// 保護指定的類的成員的名稱（如果他們不會壓縮步驟中刪除）
-keepclassmembernames {class_specification}
// 保護指定的類和類的成員的名稱，如果所有指定的類成員出席（在壓縮步驟之后）
-keepclasseswithmembernames {class_specification}
// 列出類和類的成員-keep選項的清單，標準輸出到給定的文件
-printseeds {filename}
壓縮
-dontshrink 不壓縮輸入的類文件
-printusage {filename}
-whyareyoukeeping {class_specification}
優化
-dontoptimize 不優化輸入的類文件
-assumenosideeffects {class_specification} 優化時假設指定的方法，沒有任何副作用
-allowaccessmodification 優化時允許訪問并修改有修飾符的類和類的成員
混淆
// 不混淆輸入的類文件
-dontobfuscate
// 使用給定文件中的關鍵字作為要混淆方法的名稱
-obfuscationdictionary {filename}
// 混淆時應用侵入式重載
-overloadaggressively
// 確定統一的混淆類的成員名稱來增加混淆
-useuniqueclassmembernames
// 重新包裝所有重命名的包并放在給定的單一包中
-flattenpackagehierarchy {package_name}
// 重新包裝所有重命名的類文件中放在給定的單一包中
-repackageclass {package_name}
// 混淆時不會產生形形色色的類名
-dontusemixedcaseclassnames
// 保護給定的可選屬性，例如LineNumberTable, LocalVariableTable, SourceFile, Deprecated, Synthetic, Signature, and InnerClasses.
-keepattributes {attribute_name,…}
// 設置源文件中給定的字符串常量
-renamesourcefileattribute {string}
通配符匹配規則
？
匹配單個字符
*
匹配類名中的任何部分，但不包含額外的包名
**
匹配類名中的任何部分，并且可以包含額外的包名
%
匹配任何基礎類型的類型名
***
匹配任意類型名 ,包含基礎類型/非基礎類型
...
匹配任意數量、任意類型的參數
<init>
匹配任何構造器
<ifield>
匹配任何字段名
<imethod>
匹配任何方法
*(當用在類內部時)
匹配任何字段和方法
$
指內部類
更詳細的語法請戳:http://proguard.sourceforge.net/manual/usage.html#classspecification
2. Android Studio中使用方法
按照上面的語法規則編寫proguard-rules.pro后，需要在build.gradle中配置，需要混淆的時候，設置minifyEnabled為true即可
buildTypes {
debug {
minifyEnabled false
}
release {
signingConfig signingConfigs.release
minifyEnabled true
proguardFiles 'proguard-rules.pro'
}
}
3. Eclipse 中使用方法
- 1 在工程目錄下有個描述文件project.properties, 注意不是proguard-project.txt文件(當時因為這個原因一直失敗)，添加一句話，啟用ProGuard;
// 原文件內容：
# proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt
// 修改后內容(其實只是去除注釋，并未添加):
proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt
這樣，Proguard就可以使用了。當我們正常通過Android Tools導出Application Package時（或者使用ant執行release打包），Proguard就會自動啟用，優化混淆你的代碼。
- 2 這一步并不是必要的，第一步中已經添加了sdk目錄下的混淆工具，但是為了避免各個項目出現混亂（直接添加導致所有的項目都是使用sdk目錄下的ProGard工具）；因此往往會將 proguard-android.txt復制到項目的跟目錄下，使每個項目各自擁有獨立的ProGuard文件；
// 因此project.properties修改后：
proguard.config=proguard-android.txt:proguard-project.txt
// proguard-project.txt表示項目目錄下的proguard-project.txt文件
- 3 例子
################common###############
-keep class **.R$* { *; }
-keep class com.jph.android.entity.** { *; } #實體類不參與混淆
-keep class com.jph.android.view.** { *; } #自定義控件不參與混淆
-keepattributes Signature
-keepattributes *Annotation*
-keep public class * extends android.app.Activity
-keep public class * extends android.app.Application
-keep public class * extends android.app.Service
-keep public class * extends android.content.BroadcastReceiver
-keep public class * extends android.content.ContentProvider
################baidu map###############
-libraryjars libs/baidumapapi_v3_2_0.jar
-libraryjars libs/locSDK_5.0.jar
-keep class com.baidu.** { *; }
-keep class vi.com.gdi.bgl.android.**{*;}
-dontwarn com.baidu.**
################afinal##################
#-libraryjars libs/afinal_0.5_bin.jar
#-keep class net.tsz.afinal.** { *; }
#-keep public class * extends net.tsz.afinal.**
#-keep public interface net.tsz.afinal.** {*;}
#-dontwarn net.tsz.afinal.**
################xutils##################
-libraryjars libs/xUtils-2.6.14.jar
-keep class com.lidroid.xutils.** { *; }
-keep public class * extends com.lidroid.xutils.**
-keepattributes Signature
-keepattributes *Annotation*
-keep public interface com.lidroid.xutils.** {*;}
-dontwarn com.lidroid.xutils.**
-keepclasseswithmembers class com.jph.android.entity.** {
<fields>;
<methods>;
}
################支付寶##################
-libraryjars libs/alipaysecsdk.jar
-libraryjars libs/alipayutdid.jar
-libraryjars libs/alipaysdk.jar
-keep class com.alipay.android.app.IAliPay{*;}
-keep class com.alipay.android.app.IAlixPay{*;}
-keep class com.alipay.android.app.IRemoteServiceCallback{*;}
-keep class com.alipay.android.app.lib.ResourceMap{*;}
################gson##################
-libraryjars libs/gson-2.2.4.jar
-keep class com.google.gson.** {*;}
#-keep class com.google.**{*;}
-keep class sun.misc.Unsafe { *; }
-keep class com.google.gson.stream.** { *; }
# 是要確保javaBean的包路徑
# -keep class com.google.gson.examples.android.model.** { *; }
-keep class com.mycom.mycomcn.entity.** { *; }
-keep class com.google.** {
<fields>;
<methods>;
}
-keepclassmembers class * implements java.io.Serializable {
static final long serialVersionUID;
private static final java.io.ObjectStreamField[] serialPersistentFields;
private void writeObject(java.io.ObjectOutputStream);
private void readObject(java.io.ObjectInputStream);
java.lang.Object writeReplace();
java.lang.Object readResolve();
}
-dontwarn com.google.gson.**
################httpmime/httpcore##########
-libraryjars libs/httpcore-4.3.2.jar
-libraryjars libs/httpmime-4.3.5.jar
-keep class org.apache.http.** {*;}
-dontwarn org.apache.http.**
####################jpush##################
-libraryjars libs/jpush-sdk-release1.7.1.jar
-keep class cn.jpush.** { *; }
-keep public class com.umeng.fb.ui.ThreadView { } #雙向反饋功能代碼不混淆
-dontwarn cn.jpush.**
-keepclassmembers class * {
public <init>(org.json.JSONObject);
}
#不混淆R類
-keep public class com.jph.android.R$*{
public static final int *;
}
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
####################umeng##################
-libraryjars libs/umeng-analytics-v5.2.4.jar
-keep class com.umeng.analytics.** {*;}
-dontwarn com.umeng.analytics.**
#-keep public class * extends com.umeng.**
#-keep public class * extends com.umeng.analytics.**
#-keep public class * extends com.umeng.common.**
#-keep public class * extends com.umeng.newxp.**
-keep class com.umeng.** { *; }
-keep class com.umeng.analytics.** { *; }
-keep class com.umeng.common.** { *; }
-keep class com.umeng.newxp.** { *; }
-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.** {*; }
####################universal-image-loader########
-libraryjars libs/universal-image-loader-1.9.3.jar
-keep class com.nostra13.universalimageloader.** {*;}
-dontwarn com.nostra13.universalimageloader.**
####################zxing#####################
-libraryjars libs/zxing.jar
-libraryjars libs/zxing_apply.jar
-keep class com.google.zxing.** {*;}
-dontwarn com.google.zxing.**
####################BASE64Decoder##################
-libraryjars libs/sun.misc.BASE64Decoder.jar
####################support.v4#####################
-libraryjars libs/android-support-v4.jar
-keep class android.support.v4.** { *; }
-dontwarn android.support.v4.**
###################other####################
# slidingmenu 的混淆
-dontwarn com.jeremyfeinstein.slidingmenu.lib.**
-keep class com.jeremyfeinstein.slidingmenu.lib.** { *; }
# ActionBarSherlock混淆
-dontwarn com.actionbarsherlock.**
-keep class com.actionbarsherlock.** { *; }
-keep interface com.actionbarsherlock.** { *; }
-keep class * extends java.lang.annotation.Annotation { *; }
-keepclasseswithmembernames class * {
native <methods>;
}
-keep class com.jph.android.entity.** {
<fields>;
<methods>;
}
-dontwarn android.support.**
-dontwarn com.slidingmenu.lib.app.SlidingMapActivity
-keep class android.support.** { *; }
-keep class com.actionbarsherlock.** { *; }
-keep interface com.actionbarsherlock.** { *; }
-keep class com.slidingmenu.** { *; }
-keep interface com.slidingmenu.** { *; }
4. ProGuard的輸出文件說明
混淆后，會在/build/proguard/目錄下輸出下面的文件 (Eclipse使用Export Android Application會在項目根目錄下產生proguard目錄；
- dump.txt 描述apk文件中所有類文件間的內部結構。
- mapping.txt 列出了原始的類，方法，和字段名與混淆后代碼之間的映射。
- seeds.txt 列出了未被混淆的類和成員;
- usage.txt 列出了從apk中刪除的代碼 ;
