Android 开发应该掌握的 Proguard 技巧

说起重命名，为什么需要保留一些类和类的成员(方法和变量)不被重命名呢 ? 原因是Proguard对class文件经过一系列处理后，能保证功能上和原来是一样的，但有些情况它却不能良好的处理，比如我们代码中有些功能依赖于它们原来的名字，如反射功能，native调用(函数签名)等，如果换成其它名字，会出现找不到，不对应的情况，可能引起程序崩溃，或者我们的对外提供了一些功能，必须保持原来的名字，才能保证其它依赖这些功能的模块能正确的运行等。这就是我们为什么要配置-keep选项的原因之一，还有一个原因是我们要用-keep告诉Proguard程序的入口（带有-keep的选项都会作为Entry Point），以此来确定哪些是未被使用的类和类的成员，方法等，并删除它们，因此，我们要针对我们的项目配置对应的选项。当然Proguard不仅提供了-keep选项，还有一些其它配置选项，比如-dontoptimize 对输入的Java class 文件不进行优化处理，-verbose 生成混淆后的映射文件等。下面介绍一下app中proguard文件的常用配置和项目中可能会用到的指令。更多详细的用法，可以参考Proguard帮助文档

编写Proguard配置文件

第1条是可以作为Android App的配置模板的(默认的proguard-android.txt文件里的配置没有列举出来)，基本所有的app都会用到。

通用配置

#代码混淆压缩比，在0~7之间，默认为5，一般不做修改
-optimizationpasses 5

#把混淆类中的方法名也混淆了
-useuniqueclassmembernames

#优化时允许访问并修改有修饰符的类和类的成员
-allowaccessmodification

避免混淆内部类、泛型、匿名类

-keepattributes InnerClasses,Signature,EnclosingMethod

#抛出异常时保留代码行号
-keepattributes SourceFile,LineNumberTable

#重命名抛出异常时的文件名称为"SourceFile"
-renamesourcefileattribute SourceFile

#保持所有实现 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();
}

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

总结

【Android 详细知识点思维脑图（技能树）】

其实Android开发的知识点就那么多，面试问来问去还是那么点东西。所以面试没有其他的诀窍，只看你对这些知识点准备的充分程度。so，出去面试时先看看自己复习到了哪个阶段就好。

虽然 Android 没有前几年火热了，已经过去了会四大组件就能找到高薪职位的时代了。这只能说明 Android 中级以下的岗位饱和了，现在高级工程师还是比较缺少的，很多高级职位给的薪资真的特别高（钱多也不一定能找到合适的），所以努力让自己成为高级工程师才是最重要的。

这里附上上述的面试题相关的几十套字节跳动，京东，小米，腾讯、头条、阿里、美团等公司19年的面试题。把技术点整理成了视频和PDF（实际上比预期多花了不少精力），包含知识脉络 + 诸多细节。

由于篇幅有限，这里以图片的形式给大家展示一小部分。

网上学习 Android的资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。希望这份系统化的技术体系对大家有一个方向参考。
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！
诸多细节。

由于篇幅有限，这里以图片的形式给大家展示一小部分。

[外链图片转存中…(img-ludFmo8I-1714685028949)]

网上学习 Android的资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。希望这份系统化的技术体系对大家有一个方向参考。
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！