由于本人能力有限,文中若有错误之处,欢迎指正。
转载请注明出处:http://www.jianshu.com/p/7371952ae006
不会代码混淆的程序员不是合格的Android
工程师。一般在商业项目中,一个 App
上线之前重要的一环就是实现代码保护,当然,手段有很多,今天主要介绍的是代码混淆(ProGuard)
。
ProGuard简介
ProGuard是一个压缩、优化和混淆Java字节码文件的免费的工具。它同时提供了命令行和图形界面。Android SDK中已经对其提供了支持。
ProGuard作用
- 压缩:删除无用资源
- 优化:精简,优化字节码
- 混淆:以简短无意义的名称重命名类、字段等,增加反编译的难度
- 预校验:为字节码添加预校验信息(Android平台上不需要这项功能)
ProGuard使用
由于Android SDK
中已经集成了该工具,所以可以直接开启混淆即可。
buildTypes {
release {
minifyEnabled true
zipAlignEnabled true
shrinkResources true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
minifyEnabled: 混淆开关,默认为 false
zipAlignEnabled : zipAlign
优化,默认为 true
。一般我们打包之后先得到xxx-unaligned.apk
,开启这个之后才得到最终的xxx-aligned.apk
。
shrinkResources :移除无用resources
文件(需要保证minifyEnabled
开启)
proguardFiles: 混淆配置文件。可添加多个,因为Gradle
会在构建的时候对文件进行合并操作。
proguard-rules.pro:对应module
下的proguard-rules.pro
文件。
getDefaultProguardFile:这个函数指向的路径是<SDK_HOME>/tools/proguard
文件夹,如下图:
ProGuard配置
Android SDK
中已经给我们提供了一些默认的常规配置,如下图:
我们可以通过在module
下面的proguard-rules.pro
文件中,对混淆配置进行扩展,以适用自己的项目。
下面总结出一个模板,里面包含常用的混淆配置含义,按需添加即可:
# -allowaccessmodification
# -optimizationpasses 5
# -optimizations !code/simplification/arithmetic,!code/simplification/cast,!field/*,!class/merging/*
# 不进行优化。优化可能会造成一些潜在风险,不能保证在所有版本的Dalvik上都正常运行
-dontoptimize
# 混合时不使用大小写混合,混合后的类名为小写
-dontusemixedcaseclassnames
# 不跳过library中的非public的类
-dontskipnonpubliclibraryclasses
# 不跳过library中的非public的类成员
-dontskipnonpubliclibraryclassmembers
# 在处理时打印冗长的信息
-verbose
# 不做预校验,preverify是proguard的四个步骤之一,Android平台不需要preverify,去掉这一步能够加快混淆速度
-dontpreverify
# 保留异常表,以便编译器知道哪些异常可能被抛出
# 保留InnerClasses,否则外部无法引用内部类
# 保留Signature,否则无法访问泛型
-keepattributes Exceptions,SourceFile,LineNumberTable,EnclosingMethod,Signature,*Annotation*,InnerClasses,Deprecated
################################## 需要保留的公共部分 ##################################
# 保留四大组件,自定义的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
# 保留support包下的所有类及其内部类
-keep class android.support.** {*;}
# 保留继承的
-keep public class * extends android.support.v4.**
-keep public class * extends android.support.v7.**
-keep public class * extends android.support.annotation.**
# 保留R下面的资源
-keep class **.R$* {*;}
# 保留本地native方法不被混淆
-keepclasseswithmembernames class * {
native <methods>;
}
# 保留在Activity中的方法参数是view的方法,
# 这样以来我们在layout中写的onClick就不会被影响
-keepclassmembers class * extends android.app.Activity{
public void *(android.view.View);
}
# 保留枚举类不被混淆
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
# 保留我们自定义控件(继承自View)不被混淆
-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);
}
# 保留Parcelable序列化类不被混淆
-keep class * implements android.os.Parcelable {
public static final android.os.Parcelable$Creator *;
}
# 保留Serializable序列化的类不被混淆
-keepclassmembers class * implements java.io.Serializable {
static final long serialVersionUID;
private static final java.io.ObjectStreamField[] serialPersistentFields;
!static !transient <fields>;
!private <fields>;
!private <methods>;
private void writeObject(java.io.ObjectOutputStream);
private void readObject(java.io.ObjectInputStream);
java.lang.Object writeReplace();
java.lang.Object readResolve();
}
# 对于带有回调函数的onXXEvent、**On*Listener的,不能被混淆
-keepclassmembers class * {
void *(**On*Event);
void *(**On*Listener);
}
#-----------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);
}
#-----------处理js交互---------------
#-----------处理反射类---------------
#-----------处理实体类---------------
# 在开发的时候我们可以将所有的实体类放在一个包内,这样我们写一次混淆就行了。
-keep public class com.upd.proguard.bean.** {
public void set*(***);
public *** get*();
public *** is*();
}
#-----------处理第三方依赖库---------
当然,很多博客中也都有类似的模板供大家参考。这里在注释的地方给出了配置的含义。需要特别注意的是开头几个被注释掉的混淆配置,可根据需要选择配置:
# 是否允许放宽类、类成员的访问限定符
# -allowaccessmodification
# 优化的步骤数,默认1步,如果发现没有可优化的,后续步骤自动省略
# -optimizationpasses 5
# 指定混淆是采用的算法
# -optimizations !code/simplification/arithmetic,!code/simplification/cast,!field/*,!class/merging/*
有很多博客中推荐加上这些配置,这里我是不推荐大家使用的。具体原因如下:
由Android SDK
的 proguard-android.txt
文件可知,Android
默认给我们提供的混淆配置也是关闭了优化的,如果想开启优化,SDK
中还提供了 proguard-android-optimize.txt
文件,如下:
通过这个文件的注释可知:优化可能会造成一些潜在风险,不能保证在所有版本的Dalvik
上都正常运行。官方推荐我们如果开启优化的话,一定要进行严格的测试。
所以,我也建议大家不开启优化即可。如果非要开启优化,一定要使用proguard-android-optimize.txt
文件中官方提供的算法,并保证充分的测试。
关于第三方库的ProGuard
一般开源的第三方库/SDK都提供了混淆配置。我们直接复制到自己的项目中即可。
如果没有提供的话,可参考以下做法,不对第三方库进行混淆(反正也是开源或已经混淆过的):
- 打开 AS 中,找到所有依赖的
library
-
找到需要目标第三方库/SDK
按以下规则添加混淆配置,
keep
住所以包名下的代码即可
-dontwarn com.readystatesoftware.systembartint.**
-keep class com.readystatesoftware.systembartint.** { *;}
# Eclipse时代需要添加以下配置,AS时代Gradle中已经默认添加,所以不需重复配置,否则会报错!!!
# -libraryjars libs/xxxx.jar
另外,也有前人帮我们总结了一些常用的三方库/SDK的混淆配置:
android-proguard-snippets
android-proguard-cn
混淆之后的效果
堆栈信息还原
如果我们开启混淆功能,那么每次打包之后,都会生成一个mapping.txt
文件。该文件记录了混淆前后对应的关系。默认位于build--outputs--mapping
下,如下图:
Android SDK
提供的混淆工具位于:<SDK_HOME>/tools/proguard/bin
,如下图:
可以看到:这个文件夹下都是一些批处理文件,最终运行的其实是一些可执行jar文件。对应于<SDK_HOME>/tools/proguard/lib
目录下,如下图:
我们可以运行proguardgui
,点击ReTrace
选项,如下图:
使用友盟统计,bugly 管理 mapping 文件
统计平台中一般会包含错误分析功能,我们可以上传mapping
文件到平台上,那么我们看到的错误报告就直接是还原好的堆栈信息,有利于快速定位错误代码。以友盟统计为例:
其它代码保护的解决方案
apk 加固
有很多厂商提供免费的 apk 加固服务,有兴趣的自行了解。AndResGuard
微信资源混淆解决方案。传送门:AndResGuard