android app proguard混淆配置與常見問題

proguard 原理

        Java代碼編譯成二進制class 文件，這個class 文件也能夠反編譯成源代碼 ，除了註釋外，原來的code 基本均可以看到。爲了防止重要code 被泄露，咱們每每須要混淆（Obfuscation code） ， 也就是把方法，字段，包和類這些java 元素的名稱改爲無心義的名稱，這樣代碼結構沒有變化，還能夠運行，可是想弄懂代碼的架構卻很難。 proguard 就是這樣的混淆工具，它能夠分析一組class 的結構，根據用戶的配置，而後把這些class 文件的能夠混淆java 元素名混淆掉。在分析class 的同時，他還有其餘兩個功能，刪除無效代碼（Shrinking 收縮），和代碼進行優化 （Optimization Options）。

        缺省狀況下，proguard 會混淆全部代碼，可是下面幾種狀況是不能改變java 元素的名稱，不然就會這樣就會致使程序出錯。

一， 咱們用到反射的地方。
二， 咱們代碼依賴於系統的接口，好比被系統代碼調用的回調方法，這種狀況最複雜。
三， 是咱們的java 元素名稱是在配置文件中配置好的。

因此使用proguard時，咱們須要有個配置文件告訴proguard 那些java 元素是不能混淆的。

proguard 配置

最經常使用的配置選項

-dontwarn 缺省proguard 會檢查每個引用是否正確，可是第三方庫裏面每每有些不會用到的類，沒有正確引用。若是不配置的話，系統就會報錯。
-keep 指定的類和類成員被保留做爲 入口 。
-keepclassmembers 指定的類成員被保留。
-keepclasseswithmembers 指定的類和類成員被保留，假如指定的類成員存在的話。

proguard 問題和風險

代碼混淆後雖然有混淆優化的好處，可是它每每也會帶來以下的幾點問題

1，混淆錯誤，用到第三方庫的時候，必須告訴 proguard 不要檢查，不然proguard 會報錯。

2，運行錯誤，當code 不能混淆的時候，咱們必需要正確配置，不然程序會運行出錯，這種狀況問題最多。

3，調試苦難，出錯了，錯誤堆棧是混淆後的代碼 ，本身也看不懂。

        爲了防止混淆出問題，你須要熟悉你全部的code ，系統的架構 ，以及系統和你code的集成的接口，並細心分析。 同時你必須須要一輪全面的測試。 因此混淆也仍是有必定風險的。 爲了不風險，你能夠只是混淆部分關鍵的代碼，可是這樣你的混淆的效果也會有所下降。

常見的不能混淆的android Code

Android 程序 ，下面這樣代碼混淆的時候要注意保留。
Android系統組件，系統組件有固定的方法被系統調用。
被Android Resource 文件引用到的。名字已經固定，也不能混淆，好比自定義的View 。
Android Parcelable ，須要使用android 序列化的。

其餘Anroid 官方建議 不混淆的，如

android.app.backup.BackupAgentHelper
android.preference.Preference
com.android.vending.licensing.ILicensingService
Java序列化方法，系統序列化須要固定的方法。
枚舉 ，系統須要處理枚舉的固定方法。
本地方法，不能修改本地方法名
annotations 註釋
數據庫驅動
有些resource 文件
用到反射的地方

如何實施

如今的系統已經配置爲混淆時候會保留

Android系統組件
自定義View
Android Parcelable
Android R 文件
Android Parcelable
枚舉

        各個開發人員必須檢查本身的code 是否用到反射 ，和其餘不能混淆的地方。告訴我來修改配置文件（已經保留的就不須要了）

目前系統不檢查的第三方庫爲

-dontwarn android.support.**

proguard 用法

-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}    設置源文件中給定的字符串常量

配置實例

-injars  androidtest.jar【jar包所在地址】 
-outjars  out【輸出地址】
-libraryjars    'D:\android-sdk-windows\platforms\android-9\android.jar' 【引用的庫的jar，用於解析injars所指定的jar類】
-optimizationpasses 5
-dontusemixedcaseclassnames 【混淆時不會產生形形色色的類名 】
-dontskipnonpubliclibraryclasses 【指定不去忽略非公共的庫類。 】
-dontpreverify 【不預校驗】
-verbose
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/* 【優化】
-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
-keep public class * extends android.app.backup.BackupAgentHelper
-keep public class * extends android.preference.Preference
-keep public class com.android.vending.licensing.ILicensingService
-keep public abstract interface com.asqw.android.Listener{
public protected <methods>;  【全部方法不進行混淆】
}
-keep public class com.asqw.android{
public void Start(java.lang.String); 【對該方法不進行混淆】
}
-keepclasseswithmembernames class * { 【保護指定的類和類的成員的名稱，若是全部指定的類成員出席（在壓縮步驟以後）】
native <methods>;
}
-keepclasseswithmembers class * { 【保護指定的類和類的成員，但條件是全部指定的類和類成員是要存在。】
public <init>(android.content.Context, android.util.AttributeSet);
}
-keepclasseswithmembers class * {
public <init>(android.content.Context, android.util.AttributeSet, int);
}
-keepclassmembers class * extends android.app.Activity {【保護指定類的成員，若是此類受到保護他們會保護的更好 】
public void *(android.view.View);
}
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
-keep class * implements android.os.Parcelable {【保護指定的類文件和類的成員】
public static final android.os.Parcelable$Creator *;
}
//不混淆指定包下的類 
-keep class com.aspire.**