性能优化|Android 项目架构系列之代码的混淆开发语言|android|java

被前辈问到代码混淆，决定从自己的模块跳出来，思考和优化项目的整体架构，写下系列的第一篇代码的混淆。
参考文章：
https://www.jianshu.com/p/b5b2a5dfaaf4
https://www.jianshu.com/p/390fdbd1361f
https://juejin.cn/post/7067160833041629220
代码混淆（Obfuscated code）亦称花指令，是将计算机程序的代码，转换成一种功能上等价，但是难于阅读和理解的形式的行为。可以加大反编译的成本,但是并不能彻底防止反编译。
混淆我在项目build.gradle中android下的配置如下：

buildTypes { release { minifyEnabled true proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' signingConfig signingConfigs.release } debug { minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' signingConfig signingConfigs.debug } }

minifyEnabled 是否启动混淆 ture:打开 false:关闭
proguard-rules.pro是我们自定义的混淆规则的文件：
1、Proguard是一个集文件压缩,优化,混淆和校验等功能的工具
2、它检测并删除无用的类,变量,方法和属性
3、它优化字节码并删除无用的指令.
4、它通过将类名,变量名和方法名重命名为无意义的名称实现混淆效果.
5、最后它还校验处理后的代码
混淆的常见配置：
Proguard关键字

文章图片

具体使用举例：
1、保留包下面的类
-keep class com.***.***.****.bean.*{ ; }
2、保留Activity当中的View相关方法
-keepclassmembers class * extends android.app.Activity {
public void (android.view.View);
}
3、保留枚举类
-keepclassmembers enum * {
public static [] values();
public static ** valueOf(java.lang.String);
}
4、保留我们自定义控件（继承自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);
}
5、保留Parcelable序列化类不被混淆
-keep class * implements android.os.Parcelable { *; }
保留Serializable序列化的类不被混淆
-keep class * implements java.io.Serializable { *; }
6、dontwarn
使用dontwarn处理这些我们无法解决的library的警告。
以gson为例：

-dontwarn com.google.gson.* -keep class com.google.gson.** { *; }

【性能优化|Android 项目架构系列之代码的混淆】Proguard通配符

文章图片

基本规则

//不混淆某个类 -keep public class name.huihui.example.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 (); } //不混淆某个类的特定的方法 -keepclassmembers class name.huihui.example.Test { public void test(java.lang.String); } //不混淆某个类的内部类 -keep class name.huihui.example.Test$* { *; } //两个常用的混淆命令，注意： //一颗星表示只是保持该包下的类名，而子包下的类名还是会被混淆； //两颗星表示把本包和所含子包下的类名都保持； -keep class com.suchengkeji.android.ui.** -keep class com.suchengkeji.android.ui.* //用以上方法保持类后，你会发现类名虽然未混淆，但里面的具体方法和变量命名还是变了， //如果既想保持类名，又想保持里面的内容不被混淆，我们就需要以下方法了//不混淆某个包所有的类 -keep class com.suchengkeji.android.bean.** { *; } //在此基础上，我们也可以使用Java的基本规则来保护特定类不被混淆，比如我们可以用extend，implement等这些Java规则。如下 # 保留我们使用的四大组件，自定义的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 -keep public class * extends android.view.View -keep public class com.android.vending.licensing.ILicensingService

哪些不应该混淆：
1、使用了自定义控件那么要保证它们不参与混淆
2、使用了枚举要保证枚举不被混淆
3、对第三方库中的类不进行混淆
4、运用了反射的类也不进行混淆
5、使用了 Gson 之类的工具要使 JavaBean 类即实体类不被混淆
6、在引用第三方库的时候，一般会标明库的混淆规则的，建议在使用的时候就把混淆规则添加上去，免得到最后才去找
7、有用到 WebView 的 JS 调用也需要保证写的接口方法不混淆，原因和第一条一样
8、Parcelable 的子类和 Creator 静态成员变量不混淆，否则会产生 Android.os.BadParcelableException 异常
9、使用的四大组件，自定义的Application* 实体类
10、JNI中调用的类
11、Layout布局使用的View构造函数（自定义控件）、android:onClick等。
混淆模板：

# #-------------------------------------------基本不用动区域---------------------------------------------- # # # -----------------------------基本 ----------------------------- ## 指定代码的压缩级别 0 - 7(指定代码进行迭代优化的次数，在Android里面默认是5，这条指令也只有在可以优化时起作用。) -optimizationpasses 5 # 混淆时不会产生形形色色的类名(混淆时不使用大小写混合类名) -dontusemixedcaseclassnames # 指定不去忽略非公共的库类(不跳过library中的非public的类) -dontskipnonpubliclibraryclasses # 指定不去忽略包可见的库类的成员 -dontskipnonpubliclibraryclassmembers #不进行优化，建议使用此选项， -dontoptimize # 不进行预校验,Android不需要,可加快混淆速度。 -dontpreverify # 屏蔽警告 -ignorewarnings # 指定混淆是采用的算法，后面的参数是一个过滤器 # 这个过滤器是谷歌推荐的算法，一般不做更改 -optimizations !code/simplification/arithmetic,!field/*,!class/merging/* # 保护代码中的Annotation不被混淆 -keepattributes *Annotation* # 避免混淆泛型, 这在JSON实体映射时非常重要 -keepattributes Signature # 抛出异常时保留代码行号 -keepattributes SourceFile,LineNumberTable #优化时允许访问并修改有修饰符的类和类的成员，这可以提高优化步骤的结果。 # 比如，当内联一个公共的getter方法时，这也可能需要外地公共访问。 # 虽然java二进制规范不需要这个，要不然有的虚拟机处理这些代码会有问题。当有优化和使用-repackageclasses时才适用。 #指示语：不能用这个指令处理库中的代码，因为有的类和类成员没有设计成public ,而在api中可能变成public -allowaccessmodification #当有优化和使用-repackageclasses时才适用。 -repackageclasses '' # 混淆时记录日志(打印混淆的详细信息) # 这句话能够使我们的项目混淆后产生映射文件 # 包含有类名->混淆后类名的映射关系 -verbose# # ----------------------------- 默认保留 ----------------------------- # #---------------------------------------------------- # 保持哪些类不被混淆 #继承activity,application,service,broadcastReceiver,contentprovider....不进行混淆 -keep public class * extends android.app.Activity -keep public class * extends android.app.Application -keep public class * extends android.support.multidex.MultiDexApplication -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 class android.support.** {*; }## 保留support下的所有类及其内部类-keep public class com.google.vending.licensing.ILicensingService -keep public class com.android.vending.licensing.ILicensingService #表示不混淆上面声明的类，最后这两个类我们基本也用不上，是接入Google原生的一些服务时使用的。 #----------------------------------------------------# 保留继承的 -keep public class * extends android.support.v4.** -keep public class * extends android.support.v7.** -keep public class * extends android.support.annotation.**#表示不混淆任何包含native方法的类的类名以及native方法名，这个和我们刚才验证的结果是一致 -keepclasseswithmembernames class * { native ; }#这个主要是在layout 中写的onclick方法android:οnclick="onClick"，不进行混淆 #表示不混淆Activity中参数是View的方法，因为有这样一种用法，在XML中配置android:onClick=”buttonClick”属性， #当用户点击该按钮时就会调用Activity中的buttonClick(View view)方法，如果这个方法被混淆的话就找不到了 -keepclassmembers class * extends android.app.Activity{ public void *(android.view.View); }#表示不混淆枚举中的values()和valueOf()方法，枚举我用的非常少，这个就不评论了 -keepclassmembers enum * { public static **[] values(); public static ** valueOf(java.lang.String); }#表示不混淆任何一个View中的setXxx()和getXxx()方法， #因为属性动画需要有相应的setter和getter的方法实现，混淆了就无法工作了。 -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); } -keepclasseswithmembers class * { public (android.content.Context, android.util.AttributeSet); public (android.content.Context, android.util.AttributeSet, int); }#表示不混淆Parcelable实现类中的CREATOR字段， #毫无疑问，CREATOR字段是绝对不能改变的，包括大小写都不能变，不然整个Parcelable工作机制都会失败。 -keep class * implements android.os.Parcelable { public static final android.os.Parcelable$Creator *; } # 这指定了继承Serizalizable的类的如下成员不被移除混淆 -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(); } # 保留R下面的资源 #-keep class **.R$* { # *; #} #不混淆资源类下static的 -keepclassmembers class **.R$* { public static ; }# 对于带有回调函数的onXXEvent、**On*Listener的，不能被混淆 -keepclassmembers class * { void *(**On*Event); void *(**On*Listener); }# 保留我们自定义控件（继承自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); }# #----------------------------- WebView(项目中没有可以忽略) ----------------------------- # #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); } #在app中与HTML5的JavaScript的交互进行特殊处理 #我们需要确保这些js要调用的原生方法不能够被混淆，于是我们需要做如下处理： -keepclassmembers class com.ljd.example.JSInterface { ; }# #---------------------------------实体类--------------------------------- #--------(实体Model不能混淆，否则找不到对应的属性获取不到值)----- # -dontwarn com.suchengkeji.android.confusiondemo.md.** #对含有反射类的处理 -keep class com.suchengkeji.android.confusiondemo.md.** { *; } # # ----------------------------- 其他的 ----------------------------- # # 删除代码中Log相关的代码 -assumenosideeffects class android.util.Log { public static boolean isLoggable(java.lang.String, int); public static int v(...); public static int i(...); public static int w(...); public static int d(...); public static int e(...); }# 保持测试相关的代码 -dontnote junit.framework.** -dontnote junit.runner.** -dontwarn android.test.** -dontwarn android.support.test.** -dontwarn org.junit.**# # ----------------------------- 第三方 ----------------------------- # -dontwarn com.orhanobut.logger.** -keep class com.orhanobut.logger.**{*; } -keep interface com.orhanobut.logger.**{*; }-dontwarn com.google.gson.** -keep class com.google.gson.**{*; } -keep interface com.google.gson.**{*; } #。。。。。。

signingConfigs debug模式使用一个默认的debug.keystore进行签名。当然也可以让debug签名和release签名共用一个,这样就可以debug版本可以直接安装release版本apk
app的build.gradle文件内,如下图

android { signingConfigs { config { storeFile file('../my_key') storePassword '123456' keyPassword '123456' keyAlias 'key0' } }buildTypes { release { minifyEnabled true proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' signingConfig signingConfigs.config//签名文件release和debug保存一致 } debug { minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' signingConfig signingConfigs.config//签名文件release和debug保存一致 } } }

release模式
在我们正式发布项目的时候是不能使用debug.keystore的。开发过程中我们也可以使用发布模式运行。