Android 混淆注意事項

Android混淆

Eclipse中的Android項目預設使用Proguard（http://proguard.sourceforge.net/）混淆項目代碼檔案。

具體使用方法很簡單：

1. 在default.properties檔案中增加一句proguard.config=proguard.cfg

2. 在proguard.cfg中配置Proguard的參數（如果沒有這個檔案，在src目錄中建立一個即可。）

3. 導出apk檔案，即可得到混淆後的檔案了。

上面說的使用方法很簡單，簡單設定即可以使用了。

如果混淆項目以後，發現應用的某些功能無法正常使用了，就要去仔細的找原因，看看為什麼混淆後無法使用了，再去配置Proguard的參數檔案。

舉幾個例子。

比如項目中用到了映射，這時就要用到-keep參數，對于映射用到的類保持原狀，不讓這些類被混淆，否則混淆後就找不到這些類了。

再比如項目中用到了Annotation，這時就要-keepattributes *Annotation*保留Annotation，否則混淆後項目中的某些代碼無法使用。

還有一個經驗。

Proguard的參數非常複雜，有時候無法有一個很直覺的了解。這時可以使用Proguard提供的GUI程式，在GUI界面中配置各個參數後，導出為配置檔案。然後以文本的方式打開該檔案，即可看到各個參數的寫法了。

建立一個 2.3.3的項目，你會看到 項目 檔案裡 有一個 proguard.cfg 檔案？

好吧，偉大的 google 已經幫我們做了這麼多事兒了，可惜是從2.3開始的，

那我 悲催的 項目(基于2.2的sdk) 該如何 是好？（非得 殘忍的把 項目屬性設定為 2.3的麼？

其實即使你該了，google 也不會為你把 proguard.cfg檔案補上的）

呵呵，其實不用，你隻要 把 proguard.cfg 檔案 拷貝到 你的 舊項目裡就好了，

當然這樣還不夠，因為 google是預設不混淆項目的

To enable ProGuard so that it runs as part of an Ant or Eclipse build,

set the proguard.config property in the <project_root>/default.properties file.

The path can be an absolute path or a path relative to the project's root.

google 告訴我們 還要 配置 default.properties

嗯，

把 proguard.config=proguard.cfg 加上

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就解決了。官方位址是http://proguard.sourceforge.net。上面的配置檔案參數可以在這裡查閱。

更新辦法很簡單，就是把android sdk目錄下的tool/proguard目錄覆寫一下即可。

打包出來的程式如何調試

一旦打包出來，就不能用eclipse的logcat去看了，這裡可以用android sdk中ddms.bat的tool來看，一用就發現和logcat其實還是一個東西，就是多了個裝置的選擇。

使用 gson 需要的配置

當Gson用到了泛型就會有報錯，這個真給郁悶了半天，提示“Missing type parameter”。最後找到一個資料給了一個解決辦法，參考：http://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需要的配置

參考http://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 <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.**

1.在default.properties檔案中加入下面兩句，但是我們的項目是在project.properties中設定的:

target=android-7

proguard.config=proguard.cfg

2.<!--級别從5修改到7 -->

-optimizationpasses 7

-dontusemixedcaseclassnames

-dontskipnonpubliclibraryclasses

-dontpreverify

-verbose

-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*

3.對于使用了注解的類要特别注意，否則混淆後，可能造成功能不可用。

在這個路徑下：android-sdk\tools\proguard\examples\annotations 有個例子可以參看，它是這麼處理的：

# Preserve all annotations themselves.

-keepattributes *Annotation*

4.混淆中保留了繼承自Activity、Service、Application、BroadcastReceiver、ContentProvider等基本元件。

并保留了所有的Native變量名及類名，所有類中部分以設定了固定參數格式的構造函數，枚舉等等。(詳細資訊請參考<proguard_path>/examples中的例子及注釋。)

5.有反射之類的java檔案不能混淆

6.使用了第三方的jar包，混淆後容易報空指針錯誤，要特别注意混淆的方式，具體方法見後續。。。

7.使用了android.support.v4.jar包也要特别注意，容易出問題

android 混淆配置（這篇總結的不錯）

http://www.eoeandroid.com/forum.php?mod=viewthread&tid=209210&fromuid=511991

農民伯伯寫的一篇文章：

http://www.cnblogs.com/over140/archive/2011/04/22/2024528.html#ConfiguringProGuard

 dump.txt 32.35 MB  

 mapping.txt 1.41 MB  

 obfuscated.jar 2.28 MB  

 original.jar 2.71 MB 

 seeds.txt 454.81 KB

 2013-1-8号續：

1.-keep選項

The various 

-keep

 options for shrinking and obfuscation may seem a bit confusing at first, but there's actually a pattern behind them. The following table summarizes how they are related:

Keep	From being removed or renamed	From being renamed
Classes and class members	-keep	-keepnames
Class members only	-keepclassmembers	-keepclassmembernames
Classes and class members, if class members present	-keepclasseswithmembers	-keepclasseswithmembernames

Each of these 

-keep

 options is of course followed by a specification of the classes and class members (fields and methods) to which it should be applied.

If you're not sure which option you need, you should probably simply use 

-keep

. It will make sure the specified classes and class members are not removed in the shrinking step, and not renamed in the obfuscation step.

Always remember:

• Specifying a class without class members only preserves the class as an entry point — any class members may then still be removed, optimized, or obfuscated.
• Specifying a class member only preserves the class member as an entry point — any associated code may still be optimized and adapted.

 來自sdk - D:\android\android-sdk\tools\proguard\docs

<init>

matches any constructor.

<fields>

matches any field.

<methods>

matches any method.

*

matches any field or method.

Proguard的參數非常複雜，有時候無法有一個很直覺的了解。這時可以使用Proguard提供的GUI程式，在GUI界面中配置各個參數後，導出為配置檔案。然後以文本的方式打開該檔案，即可看到各個參數的寫法了。但是百度了下，沒看到具體的這個GUI到底怎麼使用。知道的朋友可以留言告之，特此感謝。

 參考連結：

1.http://blog.csdn.net/hick1213/article/details/7110321

2.http://huangyuan.iteye.com/blog/1472732

3.http://blog.csdn.net/object_mazip/article/details/7913953