GET代码混淆(ProGuard)

由于本人能力有限,文中若有错误之处,欢迎指正。
转载请注明出处:http://www.jianshu.com/p/7371952ae006

不会代码混淆的程序员不是合格的Android工程师。一般在商业项目中,一个 App 上线之前重要的一环就是实现代码保护,当然,手段有很多,今天主要介绍的是代码混淆(ProGuard)

ProGuard简介

ProGuard是一个压缩、优化和混淆Java字节码文件的免费的工具。它同时提供了命令行和图形界面。Android SDK中已经对其提供了支持。

ProGuard作用

  1. 压缩:删除无用资源
  2. 优化:精简,优化字节码
  3. 混淆:以简短无意义的名称重命名类、字段等,增加反编译的难度
  4. 预校验:为字节码添加预校验信息(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 folder

ProGuard配置

Android SDK中已经给我们提供了一些默认的常规配置,如下图:

proguard-android.txt

我们可以通过在module下面的proguard-rules.pro文件中,对混淆配置进行扩展,以适用自己的项目。

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/*

有很多博客中推荐加上这些配置,这里我是不推荐大家使用的。具体原因如下:

proguard-android.txt

Android SDKproguard-android.txt文件可知,Android默认给我们提供的混淆配置也是关闭了优化的,如果想开启优化,SDK中还提供了 proguard-android-optimize.txt文件,如下:

proguard-android-optimize.txt

通过这个文件的注释可知:优化可能会造成一些潜在风险,不能保证在所有版本的Dalvik上都正常运行。官方推荐我们如果开启优化的话,一定要进行严格的测试。
所以,我也建议大家不开启优化即可。如果非要开启优化,一定要使用proguard-android-optimize.txt 文件中官方提供的算法,并保证充分的测试

关于第三方库的ProGuard

一般开源的第三方库/SDK都提供了混淆配置。我们直接复制到自己的项目中即可。
如果没有提供的话,可参考以下做法,不对第三方库进行混淆(反正也是开源或已经混淆过的):

  1. 打开 AS 中,找到所有依赖的library
library
  1. 找到需要目标第三方库/SDK


    library
  2. 按以下规则添加混淆配置,keep住所以包名下的代码即可

-dontwarn com.readystatesoftware.systembartint.**
-keep class com.readystatesoftware.systembartint.** { *;}

# Eclipse时代需要添加以下配置,AS时代Gradle中已经默认添加,所以不需重复配置,否则会报错!!!
# -libraryjars libs/xxxx.jar

另外,也有前人帮我们总结了一些常用的三方库/SDK的混淆配置:
android-proguard-snippets
android-proguard-cn

混淆之后的效果

效果1
效果2

堆栈信息还原

如果我们开启混淆功能,那么每次打包之后,都会生成一个mapping.txt文件。该文件记录了混淆前后对应的关系。默认位于build--outputs--mapping下,如下图:

mapping.txt

Android SDK提供的混淆工具位于:<SDK_HOME>/tools/proguard/bin,如下图:

bin

可以看到:这个文件夹下都是一些批处理文件,最终运行的其实是一些可执行jar文件。对应于<SDK_HOME>/tools/proguard/lib目录下,如下图:

lib

我们可以运行proguardgui,点击ReTrace选项,如下图:

proguardgui

使用友盟统计,bugly 管理 mapping 文件

统计平台中一般会包含错误分析功能,我们可以上传mapping文件到平台上,那么我们看到的错误报告就直接是还原好的堆栈信息,有利于快速定位错误代码。以友盟统计为例:

mapping

其它代码保护的解决方案

  1. apk 加固
    有很多厂商提供免费的 apk 加固服务,有兴趣的自行了解。

  2. AndResGuard
    微信资源混淆解决方案。传送门:AndResGuard

混淆配置语法学习

ProGuard官网
ProGuard学习笔记

赶紧GET起来吧_
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,835评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,598评论 1 295
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,569评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,159评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,533评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,710评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,923评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,674评论 0 203
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,421评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,622评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,115评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,428评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,114评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,097评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,875评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,753评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,649评论 2 271

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,570评论 25 707
  • 什么是代码混淆 代码混淆就是将代码中的各种元素,如变量,方法,类和包的名字改写成无意义的名字,增加项目反编译后被读...
    蜗牛家族史阅读 4,973评论 1 4
  • 声明 这篇文章更多的是做一个整理,内容来自于ProGuard官方文档以及各种博客等,相关文章的链接在参考目录里,感...
    夷陵小祖阅读 3,598评论 0 23
  • 本文为原创,转载请注明出处:http://www.jianshu.com/p/1b76e4c10495 说在前面的...
    SupLuo阅读 10,052评论 0 62
  • 开发方面 1.生产环境开发完毕后合并到测试环境 2.测试环境同步正式环境 3.与客户端测试进行功能测试和压力测试 ...
    木头与琉璃阅读 1,784评论 0 0