android 混淆配置proguard 原理

最近項目打包編譯,設計第三方包很多時候,混淆都會出現一些列的問題,所以給各位帥鍋美女總結下:

還有一個忘瞭說的是:如果是使用gson進行解析json數據時,你所創建的實體類不能混淆,如果混淆就解析出問題;(這個是我經常犯的錯誤)

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的集成的接口,並細心分析。 同時你必須需要一輪全面的測試。 所以混淆也還是有一定風險的。 為瞭避免風險,你可以隻是混淆部分關鍵的代碼,但是這樣你的混淆的效果也會有所降低。

常見的不能混淆的androidCode
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.**
-dontwarn com.tencent.**
-dontwarn org.dom4j.**
-dontwarn org.slf4j.**
-dontwarn org.http.mutipart.**
-dontwarn org.apache.**
-dontwarn org.apache.log4j.**
-dontwarn org.apache.commons.logging.**
-dontwarn org.apache.commons.codec.binary.**
-dontwarn weibo4android.**
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} 設置源文件中給定的字符串常量

解決export打包的報錯
這個時候export提示“conversion to Dalvik format failed with error 1”錯誤,網上說法有好多種,最後我還是把proguard從4.4升級到4.8就解決瞭。官方地址是https://proguard.sourceforge.net。上面的配置文件參數可以在這裡查閱。
升級辦法很簡單,就是把android sdk目錄下的tool/proguard目錄覆蓋一下即可。

打包出來的程序如何調試
一旦打包出來,就不能用eclipse的logcat去看瞭,這裡可以用android sdk中ddms.bat的tool來看,一用就發現和logcat其實還是一個東西,就是多瞭個設備的選擇。

使用 gson 需要的配置
當Gson用到瞭泛型就會有報錯,這個真給鬱悶瞭半天,提示“Missing type parameter”。最後找到一個資料給瞭一個解決辦法,參考:https://stackoverflow.com/questio
… sing-type-parameter。
另外我又用到瞭JsonObject,提交的Object裡面的members居然被改成瞭a。所以上面給的東西還不夠,還要加上
# 用到自己拼接的JsonObject
-keep class com.google.gson.JsonObject { *; }

個人建議減少這些依賴包混淆帶來的麻煩,幹脆都全部保留不混淆。例如
-keep class com.badlogic.** { *; }
-keep class * implements com.badlogic.gdx.utils.Json*
-keep class com.google.** { *; }

使用libgdx需要的配置
參考https://code.google.com/p/libgdx-users/wiki/Ant

驗證打包效果
利用瞭apktool的反編譯工具,把打包文件又解壓瞭看瞭一下,如果包路徑、類名、變量名、方法名這些變化和你期望一致,那就OK瞭。命令:

apktool.bat d xxx.apk destdir
配置實例

-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 ;  【所有方法不進行混淆】
}
-keep public class com.asqw.android{
public void Start(java.lang.String); 【對該方法不進行混淆】
}
-keepclasseswithmembernames class * { 【保護指定的類和類的成員的名稱,如果所有指定的類成員出席(在壓縮步驟之後)】
native ;
}
-keepclasseswithmembers class * { 【保護指定的類和類的成員,但條件是所有指定的類和類成員是要存在。】
public (android.content.Context, android.util.AttributeSet);
}
-keepclasseswithmembers class * {
public (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.**

發佈留言