ProGuard可以對Java類中的代碼進行壓縮(Shrink),優化(Optimize),混淆(Obfuscate),預檢(Preveirfy)。
1. 壓縮(Shrink): 在壓縮處理這一步中,用於檢測和刪除沒有使用的類,字段,方法和屬性。
2. 優化(Optimize): 在優化處理這一步中,對字節碼進行優化,而且移除無用指令。
3. 混淆(Obfuscate): 在混淆處理這一步中,使用a,b,c等無心義的名稱,對類,字段和方法進行重命名。
4. 預檢(Preveirfy): 在預檢這一步中,主要是在Java平臺上對處理後的代碼進行預檢。
對於ProGuard執行流程圖以下圖所示: javascript
ProGuard使用:
ProGuard已集成到Android構建系統中,因此咱們不用手動調用這個工具。咱們能夠選擇在只發布模式下構建系統的時候再去運行ProGuard。
在AndroidStudio中咱們須要將Proguard添加到gradle.build文件的構建類型當中。不過在咱們建立一個Android工程的時候,系統已經自動爲咱們添加到了gradle.build中。html
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。對於下面一些指令與代碼的含義在後面會進行說明:java
# 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,不可以遺漏。在開發的時候咱們能夠將全部的實體類放在一個包內,這樣咱們寫一次混淆就好了。android
-keep public class com.ljd.example.entity.** {
public void set*(***);
public *** get*();
public *** is*();
}
2. 在咱們的app中使用了webView須要進行特殊處理
在咱們的項目中常常會嵌入一些webview作一些複雜的操做,這時候咱們可以添加以下代碼。web
-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要調用的原生方法不可以被混淆,因而咱們須要作以下處理:apache
-keepclassmembers class com.ljd.example.JSInterface {
;
}
4. 對含有反射類的處理json
-keep class 類所在的包.** { *; }
5.對於第三方依賴庫的處理
這個取決於第三方的混淆策略。下面列舉一些第三方依賴庫的混淆策略。具體還以官方給出的爲準:app
#支付寶
-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中已經添加過得代碼在這裏能夠選擇忽略:ide
#############################################
#
# 對於一些基本指令的添加
#
#############################################
-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文件的體積,從而優化咱們的代碼. --------------------- 做者:談談的心情 來源:CSDN 原文:https://blog.csdn.net/ljw124213/article/details/52948842 版權聲明:本文爲博主原創文章,轉載請附上博文連接!