Android — 混淆配置

目录

1. 为什么要混淆
2. Android Studio 混淆配置
3. ProGuard的作用
4. 规则
5. 实操中需注意的问题
6. 完整配置示例
7. 错误日志的还原

---

原文链接： 5分钟搞定android混淆

一、为什么要混淆

混淆时，会使用 a, b, c, d 这种简短而无意义的名称，对类，字段和方法进行重新命名，从而达到保护源代码的目的。

二、Android Studio 混淆配置

Android Studio 集成了 Java 语言的 ProGuard 作为压缩，优化和混淆工具，配合Gradle构建工具使用需要两步：

1. 在工程应用目录的 build.gradle 文件中设置 minifyEnabled 为 true 即可。
2. 在 proguard-rules.pro 文件中加入我们的混淆规则。

buildTypes {
    debug {
        // 如果没有提供混淆规则文件，则设置默认的混淆规则文件（SDK/tools/proguard/proguard-android.txt）
        pseudoLocalesEnabled true
        // 显示Log
        buildConfigField "boolean", "LOG_DEBUG", "true"
        //混淆
        minifyEnabled false
        //Zipalign优化
        zipAlignEnabled true
        // 移除无用的resource文件
        shrinkResources true
        //加载默认混淆配置文件
        proguardFiles getDefaultProguardFile('proguard-Android.txt'), 'proguard-rules.pro'
        //签名
        signingConfig signingConfigs.debug
    }
    
    release {
        // 如果没有提供混淆规则文件，则设置默认的混淆规则文件（SDK/tools/proguard/proguard-android.txt）
        pseudoLocalesEnabled true
        // 不显示Log
        buildConfigField "boolean", "LOG_DEBUG", "false"
        //混淆
        minifyEnabled true
        //Zipalign优化
        zipAlignEnabled true
        // 移除无用的resource文件
        shrinkResources true
        //加载默认混淆配置文件
        proguardFiles getDefaultProguardFile('proguard-Android.txt'), 'proguard-rules.pro'
        //签名
        signingConfig signingConfigs.relealse
    }
}

三、ProGuard的作用

1. 压缩(shrink)：默认开启，用于减小应用的体积，侦测并且移除代码中无用的类，字段，方法和特性。

   dontshrink 关闭压缩

2. 优化（Optimization）：默认开启，在字节码级别执行优化，让应用运行的更快。

   dontoptimize 关闭优化
   optimizationpasses n： 表示proguard对代码进行迭代优化的次数，Android一般为5；

3. 混淆（Obfuscation）：默认开启，a,b,c,d 这样简短而无意义的名称，对类，字段和方法进行重命名，增大反编译难度，除非用keep保护。

   dontobfuscate 关闭混淆
   混淆后默认会在工程目录 app/build/outputs/mapping/release 下生成一个
   mapping.txt 文件，这就是混淆规则，我们可以根据这个文件把混淆后的代码反推回源本的代码，所以这个文件很重要，注意保护好。

四、规则

1. 先看如下两个比较常用命令的区别

    -keep class com.example.elson.**
    -keep class com.example.elson.*
   

   一个通配符： 表示只是保持该包下的类名，而子包下的类名还是会被混淆；
   两个通配符： 表示把本包和所含子包下的类名都保持；

2. 用以上方法保持类后，发现类名虽然未混淆，但里面的具体方法和变量命名还是变了，这时如果既想保持类名，又想保持里面的内容不被混淆，我们就需要以下方法了

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

3. 在此基础上，我们也可以 使用Java的基本规则来保护特定类不被混淆，如可以用 extend，implement 等这些Java规则。如下例子就避免所有继承Activity的类被混淆

   -keep public class * extends android.app.Activity
   

4. 如保留一个类中的内部类不被混淆则需要用$符号，如保持 OuterClass 内部类 InnerClass 中的所有public内容不被混淆。

   -keepclassmembers class com.example.elson.OuterClass$InnerClass {
      public *;
   }
   

5. 保持一个类中特定的内容不被混淆

   如果一个类中你不希望保持全部内容不被混淆，而只是希望保护类下的特定内容，就可以使用；

   <init>;     //匹配所有构造器
   <fields>;   //匹配所有域
   <methods>;  //匹配所有方法方法
   

6. 还可以在前面加上 private 、public、native 等来进一步指定不被混淆的内容

   // 如下表示 Main 类下的所有 public 方法都不会被混淆
   -keep class com.example.elson.Main{
     public <methods>;
   }
   // 当然还可以加入参数，
   // 比如以下表示用 JSONObject 作为入参的构造函数不会被混淆；
   -keep class com.example.elson.Main {
     public <init>(org.json.JSONObject);
   }
   

7. 不保持类名，只需要把该类下的特定方法保持不被混淆

   有时我们不需要保持类名，只需要把该类下的特定方法保持不被混淆，那你就不能用keep方法了，keep方法会保持类名，而需要用 keepclassmembers ，如此类名就不会被保持，为了便于对这些规则进行理解，官网给出了以下表格：

   保留 防止被移除或者被重命名 防止被重命名
   类和类成员 -keep -keepnames
   仅类成员 -keepclassmembers -keepclassmembernames
   如果拥有某成员，保留类和类成员
   -keepclasseswithmembers
   -keepclasseswithmembernames

   移除是指在压缩(Shrinking)时是否会被删除；以上内容是混淆规则中需要重点掌握的。此外，还需要以下几点注意事项。

五、实操中需注意的问题

1. JNI 方法不可混淆

   JNI 方法不可混淆，这个方法需要和native方法保持一致；

   # 保持native方法不被混淆  
   -keepclasseswithmembernames class * {  
       native <methods>;
   }
   

2. 反射用到的类不混淆(包名类名, 方法名, 变量名)，如果你把类名混淆了, 下面的语句会出什么问题?

   if(obj.getClass().getName().equals("a.b.c.SomeClass")) {
       //do something
   }
   

3. AndroidMainfest 中的类不混淆，如 四大组件、Application 的子类和 Framework 层下所有的类默认不会进行混淆。

4. JSON 对象类不混淆

5. 使用第三方开源库或者引用其他第三方的SDK包时，如果有特别要求，也需要在混淆文件中加入对应的混淆规则；

6. 有用到 WebView 的 JS 调用也需要保证写的接口方法不混淆，原因同第1条；

7. Parcelable 的子类和Creator静态成员变量不混淆，否则会产生 Android.os.BadParcelableException 异常；

   -keep class * implements Android.os.Parcelable { 
   	# 保持Parcelable不被混淆           
   	public static final Android.os.Parcelable$Creator *;
   }
   

8. 使用 enum 类型时需要注意避免以下两个方法混淆，因为enum类的特殊性，以下两个方法会被反射调用，见第2条规则。

   -keepclassmembers enum * {  
     public static **[] values();
     public static ** valueOf(java.lang.String);
   }
   

9. 发布一款应用除了设 minifyEnabled = ture，也应该设置 zipAlignEnabled = true，像 Google Play 强制要求开发者上传的应用必须是经过 zipAlign 的，zipAlign 可以让安装包中的资源按4字节对齐，这样可以减少应用在运行时的内存消耗。

六、完整配置示例

#-----------------------定制化区域----------------------------
#-------------1.实体类--------------

#-------------2.第三方包-------------

#-------------3.与js互相调用的类-------------

#-------------4.反射相关的类和方法--------------

#---------------------- 常规配置 ---------------------------
#----------------- 基本指令区 -----------------
-optimizationpasses 5
-dontskipnonpubliclibraryclassmembers
-printmapping proguardMapping.txt
-optimizations !code/simplification/cast,!field/*,!class/merging/*
-keepattributes *Annotation*,InnerClasses
-keepattributes Signature
-keepattributes SourceFile,LineNumberTable
#----------------------------------------------------------------------------

#------------------默认保留区------------------
-keep public class * extends android.app.Activity
-keep public class * extends android.app.Application
-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 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);
}
-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);
}
#----------------------------------------------------------------------------

七、错误日志的还原

问： 混淆之后出错了，如何处理?
混淆后的错误日志全是 a.b.c.d() 等等，需要通过mapping.txt文件还原；

操作步骤如下：

1. cmd 进入sdk/tools/proguard/bin 目录。
2. 将混淆后的日志和上文提到的 mapping 文件放入此目录中。
3. 执行命令：retrace.bat mapping.txt XXX.txt。