Android 开发应该掌握的 Proguard 技巧

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();
}

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

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

保留继承的support类

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

#保留我们自定义控件（继承自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);
}

#Fragment不需要在AndroidManifest.xml中注册，需要额外保护下
-keep public class * extends android.app.Fragment

保持测试相关的代码

-dontnote junit.framework.**
-dontnote junit.runner.**
-dontwarn android.test.**
-dontwarn android.support.test.**
-dontwarn org.junit.**

下面是针对我们App的配置。

1. 实体类需要保留

我们需要保留实体类的get和set方法(反射会用到)，boolean类型的get方法是isXXX，不要忘记保留。

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

如果所有的实体类在一个包下的话，上面的配置只用写一遍就可以了。可是实际中我们更多的是以业务来划分包名的，于是我们还可以这样配置(实体类的类名一定要含有"Model")

-keep public class .Model. {
public void set*(*);
public *** get();
public *** is()​
;
}

2. 对内部类的处理

如果项目中使用了内部类，要对其进行保留。

1.保留写在某个类里面的所有内部类。下面表示写在类A里面的内部类都会被保留($符号是用来分割内部类与其母体的标志），什么意思呢，比如类A里面有一个内部类B,而B里面也有个内部类C，这时，B和C都会被保留，以此类推，对多重嵌套的情况，都会被保留(当然我们写代码也不会写出这么深层级的内部类出来)，这里的内部类包含静态内部类，非静态内部类，不包含匿名内部类，如果是匿名内部类，只会保留其方法和成员变量（其继承的类或实现的接口的名字会被混淆），另外如果对应的类被保留，在该类里面定义的接口也会被保留，{*;}匹配该类里面的所有部分。

-keep class com.dev.example.A$* { *; }

2.保留写在某个内部类里面所有的内部类，这话听着有点绕口，举个例子，类A里面有个内部类B，下面表示写在类B里面的内部类都会被保留。此时，类B像上面第一点所举得类A一样，有点递归意思在里面。还有就是此时类B的名字不会被混淆，但里面的方法和成员变量会被混淆，如果其它地方没有对类B的方法和成员变量进行保留的话。

-keep class com.dev.example.A$B$* { *; }

3. 对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);
}

4. 保留js调用的原生方法

如果我们的app中涉及到和h5交互，需要保留js调用的原生方法。

Keep JavascriptInterface

-keepclassmembers class ** {
@android.webkit.JavascriptInterface public *;
}

5. 对含有反射类的处理

有时候项目中有些类不是实体类，但仍然用到反射功能,如Class.forName(“xxx”)，这是我们需要保留的。比如这些类在com.dev.example包下，可以通过下面的配置进行保留。

-keep class com.dev.example.* { *; }

另外上面只是保留了该包下的类，如果该包下还有子包，则子包的类仍然会被混淆， 如果想保留该包下子包的类，我们可以如下配置（**能匹配本包和所含子包，其中子包也可以含有子包）

-keep class com.dev.example.**{ *; }

6. 常见的自定义的配置

1.保留某个特定的类

#保留Test类
-keep public class com.dev.example.Test { *; }

2.保留某个类的子类

#保留继承了AbstractClass的子类
-keep class * extends com.dev.example.AbstractClass{*;}

3.保留接口的实现类

#保留实现了Callable接口的类
-keep class * implements Callable{*;}

4.保留类的特定部分 保留TaskRepository类的所有构造方法，变量和普通方法。

-keep class com.dev.example.TaskRepository{
; //匹配所有构造器
; //匹配所有域
; //匹配所有方法
}

还可以保留的更具体一点，如下所示

-keepclassmembers com.dev.example.TaskRepository{
// 保留该类的修饰符是public且有一个参数(类型是String)的构造方法
public (java.lang.String);
// 保留该类的所有修饰符是public且返回类型void的方法
public void *(**);
// 保留该类的具体某一个方法
public String getUserName();
}

7. 对于第三方依赖库的处理

下面给出几个例子,用到具体第三发依赖库的时候，对应的文档会给出相应配置的。

#okhttp
-dontwarn com.squareup.okhttp.**
-dontwarn com.squareup.okhttp3.**
-keep class com.squareup.okhttp3.** { ;}
-dontwarn okio.*

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

fresco SDK

-keep,allowobfuscation @interface com.facebook.common.internal.DoNotStrip

Do not strip any method/class that is annotated with @DoNotStrip

-keep @com.facebook.common.internal.DoNotStrip class *
-keepclassmembers class * {
@com.facebook.common.internal.DoNotStrip *;
}

#rx
-dontwarn rx.**
-keep class rx.** { *;}

#keep GSON stuff
-keep class sun.misc.Unsafe { ; }
-keep class com.google.gson.* { *; }

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

-keepclasseswithmembernames class * {
@butterknife.* ;
}

-keepclasseswithmembernames class * {
@butterknife.* ;
}

#enventbus
-keep class org.greenrobot.eventbus.** { ;}
-dontwarn org.greenrobot.eventbus.*

-keepclassmembers class ** {另外说一下
public void onEvent*(**);
}

Bugly

-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}

aliyun push

-keepclasseswithmembernames class ** {
native ;
}

QQ share SDK

-dontwarn com.tencent.**
-keepnames class com.tencent.** {*;}

sina share SDK

-dontwarn com.sina.**
-keepnames class com.sina.** {*;}

umeng SDK

-keep public class * extends com.umeng.**
-dontwarn com.umeng.**
-keep class com.umeng.** { *; }

其它

还有关于多module项目的配置，一种方法是关闭子module的Proguard功能，在我们主app的proguard-rules.pro文件中配置所有module的配置选项。这样会使主app的proguard配置文件变得比较杂乱，如果业务发展过程中，某个子module的功能不需要了，还要在主app的配置文件中找到对应子module的配置，并删除它们，不建议使用。另一种方式是各个module配置好自己的配置文件，要注意的是，子module中制定配置文件的方式如下所示:

buildTypes {
release {
consumerProguardFiles ‘proguard-rules.pro’
}
}

子module是通过consumerProguardFiles来指定配置文件的，而不是proguardFiles。

在导出包时，如果发现有很多could not reference class之类的warning信息，确认app在运行时和这些warning没有任何关系，可以配置-dontwarn选项，就不会提示这些warning信息了。

到这里Proguard配置部分基本已经说完了。Proguard是对class字节码文件进行操作的，有时我们还想对资源文件进行混淆，比较成熟的是微信的资源混淆文件方案，由于本次讨论的重点不是这个，不再多说。附上该项目的链接： https://github.com/shwenzhang/AndResGuard

检查混淆和追踪异常

开启Proguard功能，则每次构建时 ProGuard 都会输出下列文件：

• dump.txt 说明 APK 中所有类文件的内部结构。
• mapping.txt 提供原始与混淆过的类、方法和字段名称之间的转换。
• seeds.txt 列出未进行混淆的类和成员。
• usage.txt 列出从 APK 移除的代码。

最后

小编这些年深知大多数初中级Android工程师，想要提升自己，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友。

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人

都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

资料⬅专栏获取
初中级Android工程师，想要提升自己，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助**。

因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友。

[外链图片转存中…(img-7hKizJgg-1719079937250)]一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人

都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

资料⬅专栏获取