Android開發之程式碼混淆
應用混淆(ProGuard)
ProGuard是一個免費的JAVA類檔案壓縮,優化,混淆器。
它探測並刪除沒有使用的類,欄位,方法和屬性,它刪除沒有用的說明並使用位元組碼得到最大優化,它使用無意義的名字重新命名類,欄位和方法。
我們先來介紹下ProGuard
我們為啥要使用ProGuard?
- 優化應用:建立緊湊的程式碼文件是為了更快的網路傳輸,快速裝載和更小的記憶體佔用;
- 防止反向:建立的程式和程式庫很難使用反向工程;
- 預處理應用:充分利用JAVA的快捷載入的優點來提前檢測和返回JAVA中存在的類檔案。
有些什麼引數可用?
- -include {filename} 從指定的檔案中讀取配置引數
- -basedirectory {directoryname} 指定基礎目錄為以後相對的檔案檔案
- -injars {class_path} 指定要處理的應用程式jar,war,ear的目錄
- -outjars {class_path} 指定處理完後要輸出的jar,war,ear目錄的名稱
- -libraryjars {class_path} 指定要處理的應用程式jar,war,ear和目錄所需要的程式庫檔案
- dontskipnonpubliclibraryclasses 指定不去忽略非公共的庫類
- dontskipnonpubliclibraryclassmebmbers 指定不去忽略可見的庫類的成員
上面提到了Jar、war、ear三種檔案
Jar、war、ear、在檔案結構上,三者並沒有什麼不同,它們都採用zip或jar檔案檔案壓縮格式。但是它們的使用目的有所區別:
Jar檔案(副檔名為. Jar,Java Application Archive)包含Java類的普通庫、資源(resources)、輔助檔案(auxiliary files)等。
War檔案(副檔名為.War,Web Application Archive)包含全部Web應用程式。在這種情形下,一個Web應用程式被定義為單獨的一組檔案、類和資源,使用者可以對jar檔案進行封裝,並把它作為小型服務程式(servlet)來訪問。
Ear檔案(副檔名為.Ear,Enterprise Application Archive)包含全部企業應用程式。在這種情形下,一個企業應用程式被定義為多個jar檔案、資源、類和Web應用程式的集合。
每一種檔案(.jar, .war, .ear)只能由應用伺服器(application servers)、小型服務程式容器(servlet containers)、EJB容器(EJB containers)等進行處理。
有哪些保留選項?
- -keep {Modifier} {class_specification} 保護指定的類檔案和類的成員
- -keepclassmembers {Modifier} {class_specification} 保護指定類的成員,如果此類受到保護他們會保護得更好
- -keepclasseswithmembers {class_specification} 保護指定的類和類的成員,但條件是所有指定的類和類的成員是要存在的
- -keepnams {class_specification} 保護指定的類的成員和名稱(如果他們不會在壓縮的過程中被刪除)
- -keepclassmembernames {class_specification} 保護指定類的成員的名稱(如果他們不會在壓縮的過程中被刪除)
- -keepclasseswithmembersnams {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,...} 保護給定的可選屬性,例如LocalVariableTable(本地變數), SourceFile(原始檔), InnerClasses(內部類)
- -renamesourcefileattribute {string} 設定原始檔中給定的字串常量
上面介紹了一下ProGuard的基本方法
下面來介紹一下Android中的混淆檔案。
對應於專案下的proguard-rules.pro檔案
基本配置項
1.指定要處理的應用程式jar,war,ear和目錄所需要的程式庫檔案
-libraryjars libs/apns_1.0.6.jar
-libraryjars libs/armeabi/libBaiduMapSDK_v2_3_1.so
-libraryjars libs/armeabi/liblocSDK4.so
-libraryjars libs/core.jar
-libraryjars libs/gesture-imageview.jar
-libraryjars libs/gson-2.6.2.jar
-libraryjars libs/infogracesound.jar
-libraryjars libs/universal-image-loader-1.9.0.jar
方法: libraryjars jar路徑 ->libraryjars 專案中匯入的jar包等
現在Studio的話可以忽略此配置了。
2.不優化輸入的class檔案,預設情況下是啟用優化的
#不優化輸入的class檔案,預設情況下是啟用優化的
-dontoptimize
3.Proguard對你的程式碼進行迭代優化的次數 0~7,一直優化到程式碼不能被優化為止
#Proguard對你的程式碼進行迭代優化的次數 0~7,一直優化到程式碼不能被優化為止
-optimizationpasses 5
4.跳過庫中非public的類,可以加快proguard處理速度;但是有些類庫包含從public類中繼承來的非public類。這時如果加了這條會產生一個warning(find classes)
-skipnonpubliclibraryclasses
5.指定不去忽略非公共的庫類
-dontskipnonpubliclibraryclasses
6.指定不去忽略包可見的庫類的成員。
-dontskipnonpubliclibraryclassmembers
7.確定統一的混淆類的成員名稱來增加混淆
-useuniqueclassmembernames
8.混淆時不會產生形形色色的類名
-dontusemixedcaseclassnames
9.混淆前認證,去掉可加快混淆速度
-dontpreverify
10.假如專案中有用到註解,保留註解,不混淆
-keepattributes *Annotation*
Android中的配置項
1.保留所有的v4包中類不被混淆
-keep class android.support.v4.**
2.保留所有的v4包中介面不被混淆
-keep interface android.support.v4.**
3.保留系統中繼承v4/v7包的類,不被混淆
-keep class android.support.** { *; }
-keep class android.support.v4.** { *; }
-keep public class * extends android.support.v4.**
-keep interface android.support.v4.app.** { *; }
-keep class android.support.v7.** { *; }
-keep public class * extends android.support.v7.**
-keep interface android.support.v7.app.** { *; }
-dontwarn android.support.**
4.保留系統中繼實現v4/v7包的介面,不被混淆
-keep public class * implements android.support.v4.**
-dontwarn android.support.v4.**
5.所有的native方法不被混淆
-keepclasseswithmembers class * {
native <methods>;
}
6.自定義View構造方法不混淆
-keepclasseswithmembers class * {
public <init>(android.content.Context);
}
-keepclasseswithmembers class * {
public <init>(android.content.Context,android.util.AttributeSet);
}
-keepclasseswithmembers class * {
public <init>(android.content.Context,android.util.AttributeSet,int);
}
被Android Resource 檔案引用到,名字已經固定,不能混淆。
7.列舉不被混淆
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
8.release版不列印log
-assumenosideeffects class android.util.Log {
public static *** d(...);
public static *** v(...);
public static *** i(...);
public static *** e(...);
public static *** w(...);
}
9.四大元件不能混淆
-dontwarn android.support.v4.**
-keep class android.support.v4.app.** { *; }
-keep interface android.support.v4.app.** { *; }
-keep class android.support.v4.** { *; }
-keep public class * extends android.app.Application
-dontwarn android.support.v7.**
-keep class android.support.v7.internal.** { *; }
-keep interface android.support.v7.internal.** { *; }
-keep class android.support.v7.** { *; }
-keep public class * extends android.app.Activity
-keep public class * extends android.app.Fragment
-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
10.Design包不混淆
-dontwarn android.support.design.**
-keep class android.support.design.** { *; }
-keep interface android.support.design.** { *; }
-keep public class android.support.design.R$* { *; }
11.確保JavaBean不被混淆-否則Gson將無法將資料解析成具體物件
-keep class com.rair.circle.bean.** { *; }
-keep class com.rair.circle.db.bean.** { *; }
12.不混淆資源類
-keepclassmembers class **.R$* {
public static <fields>;
}
13.忽略警告
-ignorewarning
當我們使用第三方框架,jar包,如果配置混淆,都有對應的混淆配置提供。
例如Jpush(極光推送)
我們只要copy到專案混淆檔案中就行
把混淆配置好後,記得在build.gradle開啟混淆(設定為true)
buildTypes {
release {
minifyEnabled true
proguardFiles 'proguard-rules.pro'
}
}
五步搞定
1
開啟專案中的proguard-rules.pro,將下面的程式碼複製進去。我的思路是將混淆分為2個主要部分
- 定製化區域。這裡邊的內容是我們主要需要補充的部分,大致分為4個小部分,我們接下來的步驟主要是補充這4個部分的東西。
- 基本不用動區域。顧名思義,基本不用動。這塊的內容我已經寫好了,除非有特殊的需求,基本不用改動。。。請叫我雷鋒。。。。。
#-------------------------------------------定製化區域----------------------------------------------
#---------------------------------1.實體類---------------------------------
#-------------------------------------------------------------------------
#---------------------------------2.第三方包-------------------------------
#-------------------------------------------------------------------------
#---------------------------------3.與js互相呼叫的類------------------------
#-------------------------------------------------------------------------
#---------------------------------4.反射相關的類和方法-----------------------
#----------------------------------------------------------------------------
#---------------------------------------------------------------------------------------------------
#-------------------------------------------基本不用動區域--------------------------------------------
#---------------------------------基本指令區----------------------------------
-optimizationpasses 5
-dontusemixedcaseclassnames
-dontskipnonpubliclibraryclasses
-dontskipnonpubliclibraryclassmembers
-dontpreverify
-verbose
-printmapping proguardMapping.txt
-optimizations !code/simplification/cast,!field/*,!class/merging/*
-keepattributes *Annotation*,InnerClasses
-keepattributes Signature
-keepattributes SourceFile,LineNumberTable
#----------------------------------------------------------------------------
#---------------------------------預設保留區---------------------------------
-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 * extends android.view.View
-keep public class com.android.vending.licensing.ILicensingService
-keep class android.support.** {*;}
-keepclasseswithmembernames class * {
native <methods>;
}
-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 <init>(android.content.Context);
public <init>(android.content.Context, android.util.AttributeSet);
public <init>(android.content.Context, android.util.AttributeSet, int);
}
-keepclasseswithmembers class * {
public <init>(android.content.Context, android.util.AttributeSet);
public <init>(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();
}
-keep class **.R$* {
*;
}
-keepclassmembers class * {
void *(**On*Event);
}
#----------------------------------------------------------------------------
#---------------------------------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);
}
#----------------------------------------------------------------------------
#---------------------------------------------------------------------------------------------------
2
理解完戰略級思想後,我們開始第一部分補充-實體類。實體類由於涉及到與服務端的互動,各種gson的互動如此等等,是要保留的。將你專案中實體類都拎出來,用以下語法進行保留。
-keep class 你的實體類所在的包.** { *; }
如我的專案下類User的完整路徑為:com.demo.login.bean.User, 那我的混淆如下
#---------------------------------1.實體類---------------------------------
-keep class com.demo.login.bean.** { *; }
#-------------------------------------------------------------------------
當然你的實體類肯定不止這一個,請用上邊的方式一一新增,如果你的實體類都在一個包下,那你就幸福了。
3
第2部分是第三方包。開啟你的build.gradle檔案,檢視你用了哪些第三方的包。
dependencies {
compile 'com.github.bumptech.glide:glide:3.7.0'
compile 'org.greenrobot:eventbus:3.0.0'
}
我這裡用了glide,eventbus。我去他們的官網把已經寫好的混淆copy下來。
#---------------------------------2.第三方包-------------------------------
#eventBus
-keepattributes *Annotation*
-keepclassmembers class ** {
@org.greenrobot.eventbus.Subscribe <methods>;
}
-keep enum org.greenrobot.eventbus.ThreadMode { *; }
-keepclassmembers class * extends org.greenrobot.eventbus.util.ThrowableFailureEvent {
<init>(java.lang.Throwable);
}
#glide
-keep public class * implements com.bumptech.glide.module.GlideModule
-keep public enum com.bumptech.glide.load.resource.bitmap.ImageHeaderParser$** {
**[] $VALUES;
public *;
}
#-------------------------------------------------------------------------
一般官網都是有混淆的,沒有的話就google,也沒有的話自己按照上面的寫法自己寫,還不會的話。。。。。只能換個包。。。。。如果你是直接包含的jar包的話,你這樣寫
#---------------------------------2.第三方包-------------------------------
#log4j
-libraryjars log4j-1.2.17.jar
-dontwarn org.apache.log4j.**
-keep class org.apache.log4j.** { *;}
#-------------------------------------------------------------------------
大致意思就是不混淆,不報warn。如果gradle報錯的話,可以考慮註釋掉-libraryjars log4j-1.2.17.jar這句。
4
第三部分與js互調的類,工程中沒有直接跳過。一般你可以這樣寫
-keep class 你的類所在的包.** { *; }
如果是內部類的話,你可以這樣
-keepclasseswithmembers class 你的類所在的包.父類$子類 { <methods>; }
例如
-keepclasseswithmembers class com.demo.login.bean.ui.MainActivity$JSInterface {
<methods>;
}
5
第四部分與反射有關的類,工程中沒有直接跳過。類的話直接這樣
-keep class 你的類所在的包.** { *; }
熟練後不用五分鐘就能搞定。大家可以把自己寫完混淆所用的時間寫在評論裡(0,0)
深入瞭解
先逐條介紹下基本指令區指令的含義
-optimizationpasses 5
程式碼混淆的壓縮比例,值在0-7之間
-dontusemixedcaseclassnames
混淆後類名都為小寫
-dontskipnonpubliclibraryclasses
指定不去忽略非公共的庫的類
-dontskipnonpubliclibraryclassmembers
指定不去忽略非公共的庫的類的成員
-dontpreverify
不做預校驗的操作
-verbose
-printmapping proguardMapping.txt
生成原類名和混淆後的類名的對映檔案
-optimizations !code/simplification/cast,!field/*,!class/merging/*
指定混淆是採用的演算法
-keepattributes *Annotation*,InnerClasses
不混淆Annotation
-keepattributes Signature
不混淆泛型
-keepattributes SourceFile,LineNumberTable
丟擲異常時保留程式碼行號
基本指令區基本介紹完了,說下2條用的最多的指令
-keep class XXXX
保留類名不變,也就是類名不混淆,而類中的成員名不保證。當然也可以是繼承XXX類的所有類名不混淆,具體程式碼不貼了,重在理解。
-keepclasseswithmembers class XXXX
保留類名和成員名。當然也可以是類中特定方法,程式碼不貼了,理由同上。
附:完整的混淆
#-------------------------------------------定製化區域----------------------------------------------
#---------------------------------1.實體類---------------------------------
-keep class com.demo.login.bean.** { *; }
-keep class com.demo.main.bean.** { *; }
#-------------------------------------------------------------------------
#---------------------------------2.第三方包-------------------------------
#eventBus
-keepattributes *Annotation*
-keepclassmembers class ** {
@org.greenrobot.eventbus.Subscribe <methods>;
}
-keep enum org.greenrobot.eventbus.ThreadMode { *; }
-keepclassmembers class * extends org.greenrobot.eventbus.util.ThrowableFailureEvent {
<init>(java.lang.Throwable);
}
#glide
-keep public class * implements com.bumptech.glide.module.GlideModule
-keep public enum com.bumptech.glide.load.resource.bitmap.ImageHeaderParser$** {
**[] $VALUES;
public *;
}
#log4j
-libraryjars log4j-1.2.17.jar
-dontwarn org.apache.log4j.**
-keep class org.apache.log4j.** { *;}
#-------------------------------------------------------------------------
#---------------------------------3.與js互相呼叫的類------------------------
-keepclasseswithmembers class com.demo.login.bean.ui.MainActivity$JSInterface {
<methods>;
}
#-------------------------------------------------------------------------
#---------------------------------4.反射相關的類和方法-----------------------
#TODO 我的工程裡沒有。。。
#----------------------------------------------------------------------------
#---------------------------------------------------------------------------------------------------
#-------------------------------------------基本不用動區域--------------------------------------------
#---------------------------------基本指令區----------------------------------
-optimizationpasses 5
-dontusemixedcaseclassnames
-dontskipnonpubliclibraryclasses
-dontskipnonpubliclibraryclassmembers
-dontpreverify
-verbose
-printmapping proguardMapping.txt
-optimizations !code/simplification/cast,!field/*,!class/merging/*
-keepattributes *Annotation*,InnerClasses
-keepattributes Signature
-keepattributes SourceFile,LineNumberTable
#----------------------------------------------------------------------------
#---------------------------------預設保留區---------------------------------
-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 * extends android.view.View
-keep public class com.android.vending.licensing.ILicensingService
-keep class android.support.** {*;}
-keepclasseswithmembernames class * {
native <methods>;
}
-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 <init>(android.content.Context);
public <init>(android.content.Context, android.util.AttributeSet);
public <init>(android.content.Context, android.util.AttributeSet, int);
}
-keepclasseswithmembers class * {
public <init>(android.content.Context, android.util.AttributeSet);
public <init>(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();
}
-keep class **.R$* {
*;
}
-keepclassmembers class * {
void *(**On*Event);
}
#----------------------------------------------------------------------------
#---------------------------------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);
}
#----------------------------------------------------------------------------
#---------------------------------------------------------------------------------------------------
更新日誌
1.模板中的規則有部分與預設的proguard-android.txt檔案中的重複了,可以精簡一下
#-------------------------------------------定製化區域----------------------------------------------
#---------------------------------1.實體類---------------------------------
#-------------------------------------------------------------------------
#---------------------------------2.第三方包-------------------------------
#-------------------------------------------------------------------------
#---------------------------------3.與js互相呼叫的類------------------------
#-------------------------------------------------------------------------
#---------------------------------4.反射相關的類和方法-----------------------
#----------------------------------------------------------------------------
#---------------------------------------------------------------------------------------------------
#-------------------------------------------基本不用動區域--------------------------------------------
#---------------------------------基本指令區----------------------------------
-optimizationpasses 5
-dontskipnonpubliclibraryclassmembers
-printmapping proguardMapping.txt
-optimizations !code/simplification/cast,!field/*,!class/merging/*
-keepattributes *Annotation*,InnerClasses
-keepattributes Signature
-keepattributes SourceFile,LineNumberTable
#----------------------------------------------------------------------------
#---------------------------------預設保留區---------------------------------
-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 * extends android.view.View
-keep public class com.android.vending.licensing.ILicensingService
-keep class android.support.** {*;}
-keep public class * extends android.view.View{
*** get*();
void set*(***);
public <init>(android.content.Context);
public <init>(android.content.Context, android.util.AttributeSet);
public <init>(android.content.Context, android.util.AttributeSet, int);
}
-keepclasseswithmembers class * {
public <init>(android.content.Context, android.util.AttributeSet);
public <init>(android.content.Context, android.util.AttributeSet, int);
}
-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();
}
-keep class **.R$* {
*;
}
-keepclassmembers class * {
void *(**On*Event);
}
#----------------------------------------------------------------------------
#---------------------------------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);
}
#----------------------------------------------------------------------------
#-------------------------------------------------------------------------------------------------
連結:https://www.jianshu.com/p/f3455ecaa56e