混淆总结

2019年6月5日 174次阅读来源: JasonWangUp

一，为什么要混淆

为了避免我们开发的应用被人反编译，看到应用的源代码，混淆之后，就会使用a，b,c,d这样简短而无意义的名称，对类，字段和方法进行重新命名，我们代码即使被反编译，也难以阅读，从而达到保护应用的目的。

二，在android studio 如何进行混淆

Android Studio自身集成Java语言的ProGuard作为压缩，优化和混淆工具，配合Gradle构建工具使用很简单，只需要在工程应用目录的build.gradle文件中设置minifyEnabled为true即可。然后我们就可以到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
    }
}

以上代码表示在release版本中，minifyEnabled true：表示开启混淆，默认的混淆文件是：proguard-android.txt

三，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 cn.hadcn.test.**
-keep class cn.hadcn.test.*

一颗星表示只是保持该包下的类名，而子包下的类名还是会被混淆；两颗星表示把本包和所含子包下的类名都保持；用以上方法保持类后，你会发现类名虽然未混淆，但里面的具体方法和变量命名还是变了，这时如果既想保持类名，又想保持里面的内容不被混淆，我们就需要以下方法了

-keep class cn.hadcn.test.* {*;}

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

-keep public class * extends android.app.Activity

如果我们要保留一个类中的内部类不被混淆则需要用$符号，如下例子表示保持ScriptFragment内部类JavaScriptInterface中的所有public内容不被混淆。

-keepclassmembers class             cc.ninty.chat.ui.fragment.ScriptFragment$JavaScriptInterface {
   public *;
}

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

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

你还可以在<fields>或<methods>前面加上private 、public、native等来进一步指定不被混淆的内容，如

-keep class cn.hadcn.test.One {
public <methods>;
}

表示One类下的所有public方法都不会被混淆，当然你还可以加入参数，比如以下表示用JSONObject作为入参的构造函数不会被混淆

-keep class cn.hadcn.test.One {
 public <init>(org.json.JSONObject);
}

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

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

移除是指在压缩(Shrinking)时是否会被删除。以上内容时混淆规则中需要重点掌握的，了解后，基本所有的混淆规则文件你应该都能看懂了。再配合以下几点注意事项，开启你为自己代码，实现混淆规则之旅吧。

五，实际操作中注意的问题

1，jni方法不可混淆，因为这个方法需要和native方法保持一致；

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

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

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

}

3，AndroidMainfest中的类不混淆，所以四大组件和Application的子类和Framework层下所有的类默认不会进行混淆。自定义的View默认也不会被混淆；所以像网上贴的很多排除自定义View，或四大组件被混淆的规则在Android Studio中是无需加入的；

4，所写的JSON对象类不混淆

5，所有硬编码的名称都不能混淆.

所谓硬编码:
a. xml中的东西, 如上.
b. 字符串中写死的类名, 变量名, 方法名, 包名……..
c. 反射 —— 这个其实在上一条中有所体现, 如放射去方法或变量时就是用了硬编码 ——- 字符串!
如下：

Class a = getSomeClass(2);
a.getMethod("methodName", int.class);
a.getField("aField");

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

7，有用到WebView的JS调用也需要保证写的接口方法不混淆，原因和第一条一样；

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

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

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

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

10，发布一款应用除了设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()等,根本不知道具体错误在哪儿,这就是混淆后调试的确定,竟然提供了混淆肯定就可以还原啦,google早就考虑到了.那我要怎么还原呢?

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

资料引入：
https://www.jianshu.com/p/f3455ecaa56e
https://blog.csdn.net/u010316858/article/details/52595843
https://www.jianshu.com/p/7436a1a32891
https://blog.csdn.net/voo00oov/article/details/49928351

    原文作者：JasonWangUp
    原文地址: https://www.jianshu.com/p/d90d607e35ad
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。