Android教程網 >> Android技術 >> 關於Android編程 >> Android代碼混淆ProGuard工作原理簡介

Android代碼混淆ProGuard工作原理簡介

編輯：關於Android編程

ProGuard能夠對Java類中的代碼進行壓縮（Shrink）,優化（Optimize）,混淆（Obfuscate）,預檢（Preveirfy)。
　　 1. 壓縮（Shrink）: 在壓縮處理這一步中，用於檢測和刪除沒有使用的類，字段，方法和屬性。
　　 2. 優化（Optimize）: 在優化處理這一步中，對字節碼進行優化，並且移除無用指令。
　　 3. 混淆（Obfuscate）: 在混淆處理這一步中，使用a,b,c等無意義的名稱，對類，字段和方法進行重命名。
　　 4. 預檢（Preveirfy）: 在預檢這一步中，主要是在Java平台上對處理後的代碼進行預檢。
對於ProGuard執行流程圖如下圖所示：　這裡寫圖片描述

ProGuard使用:

ProGuard已集成到Android構建系統中，所以我們不用手動調用這個工具。我們可以選擇在只發布模式下構建系統的時候再去運行ProGuard。
　在AndroidStudio中我們需要將Proguard添加到gradle.build文件的構建類型當中。不過在我們創建一個Android工程的時候，系統已經自動為我們添加到了gradle.build中。

buildTypes {
    release {
        minifyEnabled true
        proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
    }
}

minifyEnabled:開啟混淆,我們新建的工程默認為false，因此，如果我們需要開啟混淆的話就需要手動設為true。
proguardFiles:這部分有兩段，前一段代表系統默認的android程序的混淆文件，該文件已經包含了基本的混淆聲明，免去了我們很多事，這個文件的目錄在/tools/proguard/proguard-android.txt, 後一部分是我們項目裡的自定義的混淆文件，目錄就在app/proguard-rules.pro,在這個文件裡我們可以聲明一些我們所需要的定制的混淆規則。
　下面我們就來看一下這個默認的android程序混淆文件proguard-android.txt。對於下面一些指令與代碼的含義在後面會進行說明:

# This is a configuration file for ProGuard.
 # http://proguard.sourceforge.net/index.html#manual/usage.html

-dontusemixedcaseclassnames
-dontskipnonpubliclibraryclasses
-verbose

# Optimization is turned off by default. Dex does not like code run
# through the ProGuard optimize and preverify steps (and performs some
# of these optimizations on its own).
-dontoptimize
-dontpreverify
# Note that if you want to enable optimization, you cannot just
# include optimization flags in your own project configuration file;
# instead you will need to point to the
# "proguard-android-optimize.txt" file instead of this one from your
# project.properties file.

-keepattributes *Annotation*
-keep public class com.google.vending.licensing.ILicensingService
-keep public class com.android.vending.licensing.ILicensingService

# For native methods, see http://proguard.sourceforge.net/manual/examples.html#native
-keepclasseswithmembernames class * {
    native ;
}

# keep setters in Views so that animations can still work.
# see http://proguard.sourceforge.net/manual/examples.html#beans
-keepclassmembers public class * extends android.view.View {
   void set*(***);
   *** get*();
}

# We want to keep methods in Activity that could be used in the XML attribute onClick
-keepclassmembers class * extends android.app.Activity {
   public void *(android.view.View);
}

# For enumeration classes, see http://proguard.sourceforge.net/manual/examples.html#enumerations
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

-keepclassmembers class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator CREATOR;
}

-keepclassmembers class **.R$* {
    public static ;
}

# The support library contains references to newer platform versions.
# Don't warn about those in case this app is linking against an older
# platform version.  We know about them, and they are safe.
-dontwarn android.support.**

# Understand the @Keep support annotation.
-keep class android.support.annotation.Keep

-keep @android.support.annotation.Keep class * {*;}

-keepclasseswithmembers class * {
    @android.support.annotation.Keep ;
}

-keepclasseswithmembers class * {
    @android.support.annotation.Keep ;
}

-keepclasseswithmembers class * {
    @android.support.annotation.Keep (...);
}

proguard-rules.pro配置

ProGuard基本指令

下面列舉了我們開發中需要使用的一些指令:

#代碼混淆壓縮比，在0~7之間，默認為5，一般不做修改
-optimizationpasses 5

#混合時不使用大小寫混合，混合後的類名為小寫
-dontusemixedcaseclassnames

#指定不去忽略非公共庫的類
-dontskipnonpubliclibraryclasses

#這句話能夠使我們的項目混淆後產生映射文件
#包含有類名->混淆後類名的映射關系
-verbose

#指定不去忽略非公共庫的類
-dontskipnonpubliclibraryclassmembers

#不做預校驗，preverify是proguard的四個步驟之一，Android不需要preverify，去掉這一步能夠加快混淆速度。
-dontpreverify

#保留Annotation不混淆
-keepattributes *Annotation*,InnerClasses

#避免混淆泛型
-keepattributes Signature

#拋出異常時保留代碼行號
-keepattributes SourceFile,LineNumberTable

#指定混淆是采用的算法，後面的參數是一個過濾器
#這個過濾器是谷歌推薦的算法，一般不做更改
-optimizations !code/simplification/cast,!field/*,!class/merging/*

需要保留的代碼

下面列舉了一些在我們的app開發中需要保留的內容:

#保留我們使用的四大組件，自定義的Application等等這些類不被混淆
#因為這些子類都有可能被外部調用
-keep public class * extends android.app.Activity
-keep public class * extends android.app.Appliction
-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 * extends android.view.View
-keep public class com.android.vending.licensing.ILicensingService

#保留support下的所有類及其內部類
-keep class android.support.** {*;}

#保留R下面的資源
-keep class **.R$* {*;}

#保留本地native方法不被混淆
-keepclasseswithmembernames class * {
    native ;
}

#保留在Activity中的方法參數是view的方法，
#這樣以來我們在layout中寫的onClick就不會被影響
-keepclassmembers class * extends android.app.Activity{
    public void *(android.view.View);
}

#保留枚舉類不被混淆
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

#保留我們自定義控件（繼承自View）不被混淆
-keep public class * extends android.view.View{
    *** get*();
    void set*(***);
    public (android.content.Context);
    public (android.content.Context, android.util.AttributeSet);
    public (android.content.Context, android.util.AttributeSet, int);
}

#保留Parcelable序列化類不被混淆
-keep class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator *;
}

#保留Serializable序列化的類不被混淆
-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();
}

#對於帶有回調函數的onXXEvent的，不能被混淆
-keepclassmembers class * {
    void *(**On*Event);
}

針對我們的App進行配置

1. 對於實體類我們不能混淆
　　對於實力類我們不能進行混淆，我們需要保留他們的set和get方法。對於boolean類型的get方法為isXXX,不能夠遺漏。在開發的時候我們可以將所有的實體類放在一個包內，這樣我們寫一次混淆就行了。

-keep public class com.ljd.example.entity.** {
    public void set*(***);
    public *** get*();
    public *** is*();
}

2. 在我們的app中使用了webView需要進行特殊處理
　　在我們的項目中經常會嵌入一些webview做一些復雜的操作，這時候我們能夠添加如下代碼。

-keepclassmembers class fqcn.of.javascript.interface.for.webview {
   public *;
}
-keepclassmembers class * extends android.webkit.webViewClient {
    public void *(android.webkit.WebView, java.lang.String, android.graphics.Bitmap);
    public boolean *(android.webkit.WebView, java.lang.String);
}
-keepclassmembers class * extends android.webkit.webViewClient {
    public void *(android.webkit.webView, jav.lang.String);
}

3. 在app中與HTML5的JavaScript的交互進行特殊處理
　　在我們的App中有時候需要與Html5中的JavaScript進行交互。例如：

package com.ljd.example;

public class JSInterface {
    @JavascriptInterface
    public void callAndroidMethod(){
        // do something
    }
}

我們需要確保這些js要調用的原生方法不能夠被混淆，於是我們需要做如下處理：

-keepclassmembers class com.ljd.example.JSInterface {
    ;
}

4. 對含有反射類的處理

-keep class 類所在的包.** { *; }

5.對於第三方依賴庫的處理
　　這個取決於第三方的混淆策略。下面列舉一些第三方依賴庫的混淆策略。具體還以官方給出的為准:

#支付寶
-libraryjars libs/alipaysdk.jar
-dontwarn com.alipay.android.app.**
-keep public class com.alipay.**  { *; }

# Retrolambda
-dontwarn java.lang.invoke.*

#realm
-keep class io.realm.annotations.RealmModule
-keep @io.realm.annotations.RealmModule class *
-keep class io.realm.internal.Keep
-keep @io.realm.internal.Keep class * { *; }
-dontwarn javax.**
-dontwarn io.realm.**

# OrmLite
-keep class com.j256.**
-keepclassmembers class com.j256.** { *; }
-keep enum com.j256.**
-keepclassmembers enum com.j256.** { *; }
-keep interface com.j256.**
-keepclassmembers interface com.j256.** { *; }

#極光推送
-dontoptimize
-dontpreverify

-dontwarn cn.jpush.**
-keep class cn.jpush.** { *; }

#EventBus
-keepattributes *Annotation*
-keepclassmembers class ** {
    @org.greenrobot.eventbus.Subscribe ;
}
-keep enum org.greenrobot.eventbus.ThreadMode { *; }

# Only required if you use AsyncExecutor
-keepclassmembers class * extends org.greenrobot.eventbus.util.ThrowableFailureEvent {
    (java.lang.Throwable);
}

#retroift
-dontwarn retrofit2.**
-keep class retrofit2.** { *; }
-keepattributes Signature
-keepattributes Exceptions

#ButterKnife
-keep class butterknife.** { *; }
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder { *; }

-keepclasseswithmembernames class * {
    @butterknife.* ;
}

-keepclasseswithmembernames class * {
    @butterknife.* ;
}

#fastjson
-dontwarn com.alibaba.fastjson.**
-keep class com.alibaba.fastjson.** { *; }

#rxjava
-dontwarn sun.misc.**
-keepclassmembers class rx.internal.util.unsafe.*ArrayQueue*Field* {
 long producerIndex;
 long consumerIndex;
}
-keepclassmembers class rx.internal.util.unsafe.BaseLinkedQueueProducerNodeRef {
 rx.internal.util.atomic.LinkedQueueNode producerNode;
}
-keepclassmembers class rx.internal.util.unsafe.BaseLinkedQueueConsumerNodeRef {
 rx.internal.util.atomic.LinkedQueueNode consumerNode;
}

#jackson
-dontwarn org.codehaus.jackson.**
-dontwarn com.fasterxml.jackson.databind.**
-keep class org.codehaus.jackson.** { *;}
-keep class com.fasterxml.jackson.** { *; }

#Facebook
-keep class com.facebook.** {*;}
-keep interface com.facebook.** {*;}
-keep enum com.facebook.** {*;}

#Fresco
-keep class com.facebook.fresco.** {*;}
-keep interface com.facebook.fresco.** {*;}
-keep enum com.facebook.fresco.** {*;}

在Android中配置ProGuard模板代碼

對於ProGuard的配置在下面給出代碼的通用部分，在使用的時候直接復制即可，之後根據自己的項目進行添加一些自己項目中所需要保留的內容，以及所依賴第三方庫的處理即可。在下面代碼中對於在proguard-android.txt中已經添加過得代碼在這裡可以選擇忽略:

#############################################
#
# 對於一些基本指令的添加
#
#############################################
-optimizationpasses 5
-dontusemixedcaseclassnames
-dontskipnonpubliclibraryclasses
-verbose
-dontskipnonpubliclibraryclassmembers
-dontpreverify
-keepattributes *Annotation*,InnerClasses
-keepattributes Signature
-keepattributes SourceFile,LineNumberTable
-optimizations !code/simplification/cast,!field/*,!class/merging/*


#############################################
#
# Android開發中一些需要保留的公共部分
#
#############################################

-keep public class * extends android.app.Activity
-keep public class * extends android.app.Appliction
-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 * extends android.view.View
-keep public class com.android.vending.licensing.ILicensingService
-keep class android.support.** {*;}
-keep class **.R$* {*;}
-keepclasseswithmembernames class * {
    native ;
}
-keepclassmembers class * extends android.app.Activity{
    public void *(android.view.View);
}
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}
-keep public class * extends android.view.View{
    *** get*();
    void set*(***);
    public (android.content.Context);
    public (android.content.Context, android.util.AttributeSet);
    public (android.content.Context, android.util.AttributeSet, int);
}
-keep class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator *;
}
-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();
}
-keepclassmembers class * {
    void *(**On*Event);
}

#webView處理，項目中沒有使用到webView忽略即可
-keepclassmembers class fqcn.of.javascript.interface.for.webview {
   public *;
}
-keepclassmembers class * extends android.webkit.webViewClient {
    public void *(android.webkit.WebView, java.lang.String, android.graphics.Bitmap);
    public boolean *(android.webkit.WebView, java.lang.String);
}
-keepclassmembers class * extends android.webkit.webViewClient {
    public void *(android.webkit.webView, jav.lang.String);
}

#############################################
#
# 項目中特殊處理部分
#
#############################################

#-----------處理反射類---------------

......

#-----------處理js交互---------------

......

#-----------處理實體類---------------

......

#-----------處理第三方依賴庫---------

......

注意事項

1. 確保混淆不會對項目產生影響
　　對於我們的Android項目最好是能夠在一開始就是用ProGuard進行處理。並且在debug模式下也進行ProGuard處理，這樣就能夠在我們的開發中進行處理ProGuard所造成的影響。
2. 打包時忽略警告
　　在我們打包的時候，會發現很多could not reference class之類的warning信息。如果我們能夠確認App在運行中和那些引用沒有什麼關系，可以添加-dontwarn標簽。如-dontwarn org.apache.harmony.**。
　　我們不要使用-ignorewarnings語句，這個會忽略所有警告，會有很多潛在的風險。

總結

對於ProGuard的使用不是很復雜，但是在我們的項目中使用ProGuard是必不可少的，它不僅僅能夠對代碼進行混淆，還能夠優化我們的代碼，減少我們apk文件的體積，從而優化我們的代碼.

上一頁:關於Android中處理崩潰異常和記錄日志的另一種實現思路
下一頁:Android 磁盤緩存 DiskLruCache

關於Android編程

Android編程入門 Android技術基礎 Android資訊關於Android編程 Android開發 Android開發環境 Android開發實例

相關文章