在app module下默认生成了项目的自定义混淆规则文件proguard-rules.pro。
先上个干货,一般情况的混淆配置(含注解):
混淆
1.app/build.gradle/buildTypes把minifyEnabled从false改成ture来启动Proguard混淆功能(AS)。
- buildTypes {
- release {
- minifyEnabled true
- proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
- }
- }
- #忽略警告,避免打包时某些警告出现
- -ignorewarnings
- #指定压缩级别
- -optimizationpasses 5
- #包名不混合大小写
- -dontusemixedcaseclassnames
- #不跳过非公共的库的类
- -dontskipnonpubliclibraryclasses
- -dontskipnonpubliclibraryclassmembers
- #不优化输入的类文件
- -dontoptimize
- #关闭预校验
- -dontpreverify
- #混淆时记录日志
- -verbose
- -printmapping proguardMapping.txt
- #混淆时采用的算法
- -optimizations !code/simplification/cast,!field/*,!class/merging/*
- #保护注解
- -keepattributes *Annotation*,InnerClasses
- -keepattributes Signature
- #保留行号
- -keepattributes SourceFile,LineNumberTable
- #keep相关注解
- -keep class android.support.annotation.Keep
- -keep @android.support.annotation.Keep class * {*;}
- -keepclasseswithmembers class * {
- @android.support.annotation.Keep <methods>;
- }
- -keepclasseswithmembers class * {
- @android.support.annotation.Keep <fields>;
- }
- -keepclasseswithmembers class * {
- @android.support.annotation.Keep <init>(...);
- }
- -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.** {*;}
- #保持所有拥有本地方法的类名及本地方法名
- -keepclasseswithmembernames class * {
- native <methods>;
- }
- #保持Activity中View及其子类入参的方法
- -keepclassmembers class * extends android.app.Activity{
- public void *(android.view.View);
- }
- #枚举
- -keepclassmembers enum * {
- public static **[] values();
- public static ** valueOf(java.lang.String);
- }
- #保持自定义View的get和set相关方法
- -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);
- }
- #Parcelable
- -keep class * implements android.os.Parcelable {
- public static final android.os.Parcelable$Creator *;
- }
- #Fragment不需要在AndroidManifest.xml中注册,需要额外保护下
- -keep public class * extends android.support.v4.app.Fragment
- -keep public class * extends android.app.Fragment
- #保持所有实现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();
- }
- -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、保持相关元素不参与混淆的规则相关的几种命令:
- -keep:防止类和成员被移除或者被重命名
- -keepnames:防止类和成员被重命名
- -keepclassmembers:防止成员被移除或者被重命名
- -keepnames:防止成员被重命名
- -keepclasseswithmembers:防止拥有该成员的类和成员被移除或者被重命名
- -keepclasseswithmembernames:防止拥有该成员的类和成员被重命名
- [保持命令] [类] {
- [成员]
- }
具体的类:
访问修饰符(public、protected、private);
通配符*,匹配任意长度字符,但不含包名分隔符(.);
通配符**,匹配任意长度字符,并且包含包名分隔符(.);
extends,即可以指定类的基类;
implement,匹配实现了某接口的类;
$,内部类;
“成员”代表类成员相关的限定条件,它将最终定位到某些符合该限定条件的类成员。它的内容可以使用:
匹配所有构造器
匹配所有域
匹配所有方法
通配符*,匹配任意长度字符,但不含包名分隔符(.)
通配符**,匹配任意长度字符,并且包含包名分隔符(.)
通配符***,匹配任意参数类型
…,匹配任意长度的任意类型参数。
比如void test(…)就能匹配任意void test(String a)或者是void test(int a, String b) 这些方法。
访问修饰符(public、protected、private)
举个例子,假如需要将name.huihui.test包下所有继承Activity的public类及其构造函数都保持住,可以这样写:
- -keep public class name.huihui.test.** extends Android.app.Activity {
- <init>
- }
- #不混淆某个类
- -keep public class name.huihui.example.Test { *; }
- #不混淆某个包所有的类
- -keep class name.huihui.test.** { *; }
- #不混淆某个类的子类
- -keep public class * extends name.huihui.example.Test { *; }
- #不混淆所有类名中包含了“model”的类及其成员
- -keep public class **.*model*.** {*;}
- #不混淆某个接口的实现
- -keep class * implements name.huihui.example.TestInterface { *; }
- #不混淆某个类的构造方法
- -keepclassmembers class name.huihui.example.Test {
- public <init>();
- }
- #不混淆某个类的特定的方法
- -keepclassmembers class name.huihui.example.Test {
- public void test(java.lang.String);
- }
1、实体类由于涉及到与服务端的交互,各种gson的交互如此等等,是要保留的。将你项目中实体类都拎出来,用以下语法进行保留。
- -keep class 你的实体类所在的包.** { *; }
- -keep class com.demo.login.bean.** { *; }
- dependencies {
- }
3、与js互调的类。
- -keep class 你的类所在的包.** { *; }
- -keepclasseswithmembers class 你的类所在的包.父类$子类 { <methods>; }
- -keepclasseswithmembers class com.demo.login.bean.ui.MainActivity$JSInterface {
- <methods>;
- }
假如项目命名规范要求实体类都要放在model包下的话,可以添加类似这样的代码把所有实体类都保持住:
- -keep public class **.*Model*.** {*;}
- -keep class 你的类所在的包.** { *; }
最后将build.gradle中minifyEnabled设置为true,shrinkResources设置为true,打开资源压缩。
注意,只有在用minifyEnabled开启了,资源压缩才会生效。
- release {
- minifyEnabled true
- shrinkResources true
- proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
- }
这行代码定义了混淆规则由两部分构成:位于SDK的tools/proguard/文件夹中的proguard-android.txt的内容以及默认放置于模块根目录的proguard-rules.pro的内容。前者是SDK提供的默认混淆文件(内容见附录1),后者是开发者自定义混淆规则的地方。
检查混淆结果:混淆过的包必须进行检查,避免因混淆引入的bug。
使用上文的配置进行混淆打包后在 <module-name>/build/outputs/mapping/release/ 目录下会输出以下文件:
dump.txt:描述APK文件中所有类的内部结构;
mapping.txt:提供混淆前后类、方法、类成员等的对照表;
seeds.txt:列出没有被混淆的类和成员;
usage.txt:列出被移除的代码;
我们可以根据seeds.txt文件检查未被混淆的类和成员中是否已包含所有期望保留的,再根据usage.txt文件查看是否有被误移除的代码。
解出混淆
混淆后,对追踪线上crash也造成了阻碍。我们拿到crash的堆栈信息后会发现很难定位,这时需要将混淆反解。
在<sdk-root>/tools/proguard/bin路径下有附带反解工具(Window系统为proguardgui.bat,Mac或Linux系统为proguardgui.sh)。
这里以Window平台为例。双击运行proguardgui.bat后,可以看到左侧的一行菜单。点击ReTrace,选择该混淆包对应的mapping文件(混淆后在<module-name>/build/outputs/mapping/release/路径下会生成mapping.txt文件,它的作用是提供混淆前后类、方法、类成员等的对照表),再将crash的stack trace黏贴进输入框中,点击右下角的ReTrace,混淆后的堆栈信息就显示出来了。
另一种方式是利用该路径下的retrace工具通过命令行进行反解,命令是
- retrace.bat|retrace.sh [-verbose] mapping.txt [<stacktrace_file>]
- retrace.bat -verbose mapping.txt obfuscated_trace.txt