Android代码混淆ProGuard工做原理简介

时间 2019-11-08

标签 android 代码混淆 proguard 原理简介栏目 Android 繁體版

原文原文链接

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 版权声明：本文为博主原创文章，转载请附上博文连接！