Hyena-词典-非常精简的混淆使用

[Hyena鬣狗快速开发库][Hyena]核心为快速开发，定位小巧精悍，内容简单精致，整合常用View、Base类、通用、词典、推荐类库

为什么混淆

• android的ProGuard，可以起到压缩，混淆，预检，优化的作用
• 混淆流程将主项目以及依赖库中未被使用的类、类成员、方法、属性移除，这有助于规避64K方法数的瓶颈
• 同时，将类、类成员、方法重命名为无意义的简短名称，增加了逆向工程的难度
• 而依靠 Gradle 的 Android 插件，我们将移除未被使用的资源，可以有效减小 apk 安装包大小。

怎么混淆 [使用示例][使用示例]

• 开启混淆

buildTypes {
   release {
        minifyEnabled true      //开启混淆
        shrinkResources true    //打开资源压缩（去除没有引用的资源）
        zipAlignEnabled true    //zipAlign可以让安装包中的资源按4字节对齐，这样可以减少应用在运行时的内存消耗。
        proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
    }
}

• proguard-rules.pro 基本配置

#指定压缩级别
-optimizationpasses 5
#不跳过非公共的库的类成员
-dontskipnonpubliclibraryclassmembers
#混淆时采用的算法
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
#把混淆类中的方法名也混淆了
-useuniqueclassmembernames
#优化时允许访问并修改有修饰符的类和类的成员
-allowaccessmodification
#将文件来源重命名为“SourceFile”字符串
-renamesourcefileattribute SourceFile
#保留行号
-keepattributes SourceFile,LineNumberTable
#保持泛型
-keepattributes Signature
#保护注解
-keepattributes *Annotation*
#R文件的静态成员
-keepclassmembers class **.R$* {
    public static <fields>;
}

• 进阶配置

# 保持native方法不被混淆    
-keepclasseswithmembernames class * { 
    native <methods>;
}
#Parcelable
-keepclassmembers class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator CREATOR;
}
#保持所有实现 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();
}
#枚举
-keepclassmembers enum * {
    **[] $VALUES;
    public *;
}

• 基本规则

#一颗星表示只是保持该包下的类名，而子包下的类名还是会被混淆
-keep class com.knifestone.hyena.test.*
#两颗星表示把本包和所含子包下的类名都保持
-keep class com.knifestone.hyena.test.**
#用以上方法保持类后，你会发现类名虽然未混淆，但里面的具体方法和变量命名还是变了
#如果既想保持类名，又想保持里面的内容不被混淆
-keep class com.knifestone.hyena.test.* {*;}
#也可以使用Java的基本规则来保护特定类不被混淆，用extend，implement等这些Java规则
#如下表示：避免所有继承Activity的类被混淆
-keep public class * extends android.app.Activity
#如果我们要保留一个类中的内部类不被混淆则需要用$符号
#如下表示：保持ScriptFragment内部类JavaScriptInterface中的所有public内容不被混淆
-keepclassmembers class com.knifestone.hyena.ui.fragment.ScriptFragment$JavaScriptInterface {
   public *;
}
#一个类中你不希望保持全部内容不被混淆，而只是希望保护类下的特定内容，就可以使用
#如下表示：One类下的所有public方法都不会被混淆
-keep class com.knifestone.hyena.One {
    public <methods>;
}
#如下表示：用JSONObject作为入参的构造函数不会被混淆
-keep class com.knifestone.hyena.One {
   public <init>(org.json.JSONObject);
}
#不需要保持类名，我只需要把该类下的特定方法保持不被混淆就好，需要用keepclassmembers
-keep    防止类和成员被移除或者被重命名
-keepnames    防止类和成员被重命名
-keepclassmembers    防止成员被移除或者被重命名
-keepnames    防止成员被重命名
-keepclasseswithmembers    防止拥有该成员的类和成员被移除或者被重命名
-keepclasseswithmembernames    防止拥有该成员的类和成员被重命名

• 注意事项

1，jni方法不可混淆，因为这个方法需要和native方法保持一致
2，反射用到的类不混淆(否则反射可能出现问题)；
3，AndroidMainfest中的类不混淆，所以四大组件和Application的子类和Framework层下所有的类默认不会进行混淆。自定义的View默认也不会被混淆；所以像网上贴的很多排除自定义View，或四大组件被混淆的规则在Android Studio中是无需加入的；
4，与服务端交互时，使用GSON、fastjson等框架解析服务端数据时，所写的JSON对象类不混淆，否则无法将JSON解析成对应的对象
5，使用第三方开源库或者引用其他第三方的SDK包时，如果有特别要求，也需要在混淆文件中加入对应的混淆规则
6，有用到WebView的JS调用也需要保证写的接口方法不混淆，原因和第一条一样
7，Parcelable的子类和Creator静态成员变量不混淆，否则会产生Android.os.BadParcelableException异常
8，使用enum类型时应不被混淆

• mapping.txt

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

• 伸手党福利 （开袋即食）

# 基本配置区 ################### 分割线
#指定压缩级别
-optimizationpasses 5
#不跳过非公共的库的类成员
-dontskipnonpubliclibraryclassmembers
#混淆时采用的算法
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
#把混淆类中的方法名也混淆了
-useuniqueclassmembernames
#优化时允许访问并修改有修饰符的类和类的成员
-allowaccessmodification
#将文件来源重命名为“SourceFile”字符串
-renamesourcefileattribute SourceFile
#保留行号
-keepattributes SourceFile,LineNumberTable
#保持泛型
-keepattributes Signature
#保护注解
-keepattributes *Annotation*
# 进阶配置区 ################### 分割线
#R文件的静态成员
-keepclassmembers class **.R$* {
    public static <fields>;
}
# 保持native方法不被混淆    
-keepclasseswithmembernames class * { 
    native <methods>;
}
#Parcelable
-keepclassmembers class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator CREATOR;
}
#保持所有实现 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();
}
#枚举
-keepclassmembers enum * {
    **[] $VALUES;
    public *;
}
# 自定配置区 ################### 分割线
#实体类
#-keep class 实体类所在包.** { *; }
#与js交互的类
#与反射有关的类和方法
#第三方库       

更多功能请前往Github查看，传送门： [Hyena鬣狗快速开发库][Hyena]
[Hyena]:https://github.com/KnifeStone/Hyena
[AndroidUtilCode]:https://github.com/Blankj/AndroidUtilCode
[使用示例]:https://github.com/KnifeStone/Hyena/blob/master/wikis/proguard-rules.md