Proguard-Android“混淆”原理规则综述

摘要：

        你是否经常对Android的混淆规则一知半解？只用用到的时候才会去查一查，查完就完了，下次遇到仍要重新查，本文致力于整体把握proguard部分的作用、基本配置规则。

一、概述

Proguard，网上大多数资料都译为混淆，其实是不准确的，根据官方的介绍：ProGuard is an open-sourced Java class file shrinker, optimizer, obfuscator, and preverifier。混淆只占1/4，还包括其他功能，具体如下：

shrink（删减）：删减无用代码，包括类、变量、方法和属性

optimize（优化）：优化方法字节码，并移除无用的构造方法

obfuscate（混淆）：混淆现有代码，将有意义的命名替换为无意义的命名

preverify（预校验）：给类添加预校验信息，这是J2ME和Java 6及以上要求的

二、基本原理

如上图所示，将输入的jars按顺序进行shrink、optimize、obfuscate、preverify四种情况的处理，可以选择跳过其中一项或几项。

三、语法规则

     本部分主要介绍混淆

     常用用法为keep class specifications，下面将分别从keep 和class specifications两方面说明

3.1 keep 常用用法

     from being：防止的意思

    If you specify a class, without class members, ProGuard only preserves the class and its parameterless     constructor as entry points. It may still remove, optimize, or obfuscate its other class members.

If you specify a method, ProGuard only preserves the method as an entry point. Its code may still be optimized and adapted.

3.2 类指定（class specifications）语法

 []：代表可选

  |：代表多选1

…：代表后续还可指定多个

 ()：代表是一个整体

3.2.1 类名（class name）

       必须全命名，内部类需加$，可以使用通配符如下表所示

通配符	规则	举例
?	匹配名称中的单个字符	Text?匹配Text1和Text2，不匹配Text12
*	匹配任意部分，除了包分隔符	com.example.*Text*匹配com.example.Text和com.example.MyTextApp，但不匹配com.example.subexample.MyTextApp the class name *  代表任意class
**	匹配任意部分，包含分隔符	**.Text匹配除根目录下的所有目录下的Text类，com.example.**匹配下面所有的类，包含子包的类
<n>	匹配同一选项中第n个匹配的通配符	com.example.*Fool<1>匹配com.example.BarFoolBar

3.2.2 成员和方法名（fields和methods）

通配符	规则	举例
<init>	匹配任意构造器
<fields>	匹配任意成员
<methods>	匹配任意方法
*	匹配任意成员和方法

成员和方法名称也可以使用通配符如下表

通配符	规则	举例
?	匹配名称中单个字符
*	匹配名称任意部分
<n>	匹配同一选项中第n个匹配的通配符

类型描述符可使用通配符如下表：

通配符	规则	举例
%	匹配基本数据类型	byte、boolean、int、long、double、float、string、char
？	匹配单个字符，除了基本类型
*	匹配任意部分，除了包分隔符，，除了基本类型
**	匹配任意部分，包含分隔符，，除了基本类型
***	匹配任意类型
...	匹配任意数量的任意类型
<n>	匹配同一选项中第n个匹配的通配符

四、示例

#下面代码中的路径配置,你要修改成与你相对应的路径

#引入依赖包rt.jar（jdk路径）(注意：如在makeJar的时候提示指定了两次，可以将其注释掉)

#-libraryjars 'C:\Program Files\Java\jdk1.8.0_101\jre\lib\rt.jar'

#引入依赖包android.jar(android SDK路径)(注意：如在makeJar的时候提示指定了两次，可以将其注释掉)

#-libraryjars 'C:\Android_Develop_Tools\sdk\platforms\android-23\android.jar'

#如果用到Appcompat包，需要引入(注意：如在makeJar的时候提示指定了两次，可以将其注释掉)

#-libraryjars 'D:\AndroidStudioProjects\MyApplication\mylibrary\build\intermediates\exploded-aar\com.android.support\appcompat-v7\23.4.0\jars\classes.jar'

#-libraryjars 'D:\AndroidStudioProjects\MyApplication\mylibrary\build\intermediates\exploded-aar\com.android.support\support-v4\23.4.0\jars\classes.jar'

#忽略警告 不忽略可能打包不成功

-ignorewarnings

#不要压缩(这个必须，因为开启混淆的时候 默认 会把没有被调用的代码 全都排除掉)

# -dontshrink

#保护泛型 如果混淆报错建议关掉

#-keepattributes Signature

#保持BuildConfig不被混淆(因为混淆之后就无法在导出jar时排除该类)

#-keep class com.ywj.mylibrary.BuildConfig{

#    public *;

#}

#保持特定类不被混淆

#-keep class com.ywj.mylibrary.Hehe{

#    public *;

#}

#保持jar包里的类不被混淆

-keep class com.google.gson.**

#-keep class com.blankj.utilcode.**

##########################################################################默认配置

# 代码混淆压缩比，在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/*

#############################################

#

# Android开发中一些需要保留的公共部分

#

#############################################

# 保留我们使用的四大组件，自定义的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.** {*;}

# 保留继承的

-keep public class * extends android.support.v4.**

-keep public class * extends android.support.v7.**

-keep public class * extends android.support.annotation.**

#androidx包使用混淆

-keep class com.google.android.material.** {*;}

-keep class androidx.** {*;}

-keep public class * extends androidx.**

-keep interface androidx.** {*;}

-dontwarn com.google.android.material.**

-dontnote com.google.android.material.**

-dontwarn androidx.**

# 保留R下面的资源

-keep class **.R$* {*;}

# 保留本地native方法不被混淆

-keepclasseswithmembernames class * {

    native <methods>;

}

# 保留在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 <init>(android.content.Context);

    public <init>(android.content.Context, android.util.AttributeSet);

    public <init>(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;

    !static !transient <fields>;

    !private <fields>;

    !private <methods>;

    private void writeObject(java.io.ObjectOutputStream);

    private void readObject(java.io.ObjectInputStream);

    java.lang.Object writeReplace();

    java.lang.Object readResolve();

}

# 对于带有回调函数的onXXEvent、**On*Listener的，不能被混淆

-keepclassmembers class * {

    void *(**On*Event);

    void *(**On*Listener);

}

# 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);

}

五、可能会遇到的问题

5.1 -keep class androidx.**与-keep class androidx.** {*;}区别？

答：尽管keep是保持类名和成员，但若后面不带{*;}，则还是会混淆成员

5.2 同样配置的工程，运行多次，混淆结果一样么？

答：一样的

5.3 资源能混淆么？

对资源文件进行混淆操作本质上是通过修改resources.arsc(详见resources.arsc作用及文件格式)。目前知道的一种是微信的资源混淆方案，另一种是美团的资源混淆方案。

附：官网地址：ProGuard Manual: Usage | Guardsquare