为什么需要代码混淆呢?原因很简单,Android APK很容易被反编译,代码就会看到,因此我们需要在编译过程中对代码进行一定的程度的混淆。混淆增加了APK被反编译后代码可读性的难度,一定程度上起到了保护的作用。
混淆的过程大致如下:
1. minifyEnabled 设置为true
新建一个项目,Android Studio默认关闭代码混淆开关,在build.gradle文件中,如下所示的minifyEnabled开关,因此如果需要进行代码混淆,需将false改为true,然后在文件proguard-rules.pro中添加混淆规则。
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
其中,proguard-android.txt文件是本地sdk/tools/proguard文件夹下的默认文件,proguard-rules.pro文件是用来编写混淆代码的。
2. 在proguard-rules中编写混淆代码
常用混淆规则如下:
-dontskipnonpubliclibraryclasses # 不忽略非公共的库类
-optimizationpasses 5 # 指定代码的压缩级别
-dontusemixedcaseclassnames # 是否使用大小写混合
-dontpreverify # 混淆时是否做预校验
-verbose # 混淆时是否记录日志
-keepattributes *Annotation* # 保持注解
-ignorewarning # 忽略警告
-dontoptimize # 优化不优化输入的类文件
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/* # 混淆时所采用的算法
#保持哪些类不被混淆
-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 com.android.vending.licensing.ILicensingService
#保持webview类不被混淆
-keepclassmembers class fqcn.of.javascript.interface.for.webview {
public *;
}
#生成日志数据,gradle build时在本项目根目录输出
-dump class_files.txt #apk包内所有class的内部结构
-printseeds seeds.txt #未混淆的类和成员
-printusage unused.txt #打印未被使用的代码
-printmapping mapping.txt #混淆前后的映射
-keep public class * extends android.support.** #如果有引用v4或者v7包,需添加
-libraryjars libs/xxx.jar #混淆第三方jar包,其中xxx为jar包名
-keep class com.xxx.**{*;} #不混淆某个包内的所有文件
-dontwarn com.xxx** #忽略某个包的警告
-keepattributes Signature #不混淆泛型
-keepnames class * implements java.io.Serializable #不混淆Serializable
-keepclassmembers class **.R$* { #不混淆资源类
public static <fields>;
}
-keepclasseswithmembernames class * { # 保持 native 方法不被混淆
native <methods>;
}
-keepclasseswithmembers class * { # 保持自定义控件类不被混淆
public <init>(android.content.Context, android.util.AttributeSet);
}
-keepclasseswithmembers class * { # 保持自定义控件类不被混淆
public <init>(android.content.Context, android.util.AttributeSet, int);
}
-keepclassmembers class * extends android.app.Activity { # 保持自定义控件类不被混淆
public void *(android.view.View);
}
-keepclassmembers enum * { # 保持枚举 enum 类不被混淆
public static **[] values();
public static ** valueOf(java.lang.String);
}
-keep class * implements android.os.Parcelable { # 保持 Parcelable 不被混淆
public static final android.os.Parcelable$Creator *;
}
*第三方库的混淆原则*
通常关于第三方包的混淆代码,一般在其github主页上或者simple或者官方接入文档中会有提示。我们将这些配置加入到我们的proguard-rules.pro中去就可以了.
需要注意如下所示的问题:
#通过 Android Studio进行混淆代码时,默认已经将lib目录中的 jar都已经添加到打包脚本中,所以不需要再次手动添加,否则会出现“ Java.io.IOException: The same input jar is specified twice” 错误。所以注释掉
#-libraryjars libs/android.support.v4.jar
#-libraryjars libs/BaiduLBS_Android.jar
#-libraryjars libs/commons-httpclient-3.1.jar
#-libraryjars libs/jackson-annotations-2.1.4.jar
#-libraryjars libs/jackson-core-2.1.4.jar
#-libraryjars libs/jackson-databind-2.1.4.jar
#-libraryjars libs/xUtils-2.6.14.jar
*Attention*
在实际使用过程中,我们会发现当前apk/sdk中的有些方法和类,是要供外部使用的,而此时混淆了名称,外部调用就会报错了,那么怎么解决这个问题?此时就需要在proguard-rules.pro文件中去配置不需要混淆的类、方法和变量等。
例如,我们在内部定义了某一个类,该类会被外部调用者所实例化,并调用其中的方法,我们可以这样做。
#保持被外部调用的类不被混淆
-keep class com.xxx.bean.**{*;} #保持该路径下所有的类都不被混淆
-keep class com.xxx.crash.CrashHandler{*;}
-keep class com.sitech.cmarredpck.config.Constants{*;}
其它的混淆配置
#保留所有具有公有访问权限的类和其公共成员不被混淆(可以代替上面所有的keep语句,彻底将误删的概率降到最低)
-keepclasseswithmembers
class *{
public *;
}
#删除Log代码
-assumenosideeffects
class android.util.Log
{
public static ***
e(...);
public static ***
w(...);
public static ***
wtf(...);
public static ***
d(...);
public static ***
v(...);
}