转载:https://www.jianshu.com/p/7436a1a32891
https://blog.csdn.net/olevin/article/details/52876821
简介
作为Android开发者,如果你不想开源你的应用,那么在应用发布前,就需要对代码进行混淆处理,从而让我们代码即使被反编译,也难以阅读。混淆概念虽然容易,但很多初学者也只是网上搜一些成型的混淆规则粘贴进自己项目,并没有对混淆有个深入的理解。本篇文章的目的就是让一个初学者在看完后,能在不进行任何帮助的情况下,独立写出适合自己代码的混淆规则。
说在前面
这里我们直接用Android Studio
来说明如何进行混淆,Android Studio
自身集成Java语言的ProGuard作为压缩,优化和混淆工具,配合Gradle构建工具使用很简单,只需要在工程应用目录的gradle文件中设置minifyEnabled为true即可。然后我们就可以到proguard-rules.pro
文件中加入我们的混淆规则了。
android {
...
buildTypes {
release {
minifyEnabled true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
}
以上示例代码表示对release版本就行混淆处理。下面我们先来简介下ProGuard的三大作用,并简要说明下它们常用的命令。
ProGuard作用
压缩(Shrinking):默认开启,用以减小应用体积,移除未被使用的类和成员,并且会在优化动作执行之后再次执行(因为优化后可能会再次暴露一些未被使用的类和成员)。
-dontshrink 关闭压缩
优化(Optimization):默认开启,在字节码级别执行优化,让应用运行的更快。
-dontoptimize 关闭优化
-optimizationpasses n 表示proguard对代码进行迭代优化的次数,Android一般为5
混淆(Obfuscation):默认开启,增大反编译难度,类和类成员会被随机命名,除非用keep保护。
-dontobfuscate 关闭混淆
混淆后默认会在工程目录app/build/outputs/mapping/release
下生成一个mapping.txt
文件,这就是混淆规则,我们可以根据这个文件把混淆后的代码反推回源本的代码,所以这个文件很重要,注意保护好。原则上,代码混淆后越乱越无规律越好,但有些地方我们是要避免混淆的,否则程序运行就会出错,所以就有了下面我们要教大家的,如何让自己的部分代码避免混淆从而防止出错。
基本规则
先看如下两个比较常用的命令,很多童鞋可能会比较迷惑以下两者的区别。
-keep class cn.hadcn.test.**
-keep class cn.hadcn.test.*
一颗星表示只是保持该包下的类名,而子包下的类名还是会被混淆;两颗星表示把本包和所含子包下的类名都保持;用以上方法保持类后,你会发现类名虽然未混淆,但里面的具体方法和变量命名还是变了,这时如果既想保持类名,又想保持里面的内容不被混淆,我们就需要以下方法了
-keep class cn.hadcn.test.* {*;}
在此基础上,我们也可以使用Java的基本规则来保护特定类不被混淆,比如我们可以用extend
,implement
等这些Java规则。如下例子就避免所有继承Activity的类被混淆
-keep public class * extends android.app.Activity
如果我们要保留一个类中的内部类不被混淆则需要用$
符号,如下例子表示保持ScriptFragment内部类JavaScriptInterface中的所有public内容不被混淆。
-keepclassmembers class cc.ninty.chat.ui.fragment.ScriptFragment$JavaScriptInterface {
public *;
}
再者,如果一个类中你不希望保持全部内容不被混淆,而只是希望保护类下的特定内容,就可以使用
<init>; //匹配所有构造器
<fields>; //匹配所有域
<methods>; //匹配所有方法方法
你还可以在<fields>
或<methods>
前面加上private
、public
、native
等来进一步指定不被混淆的内容,如
-keep class cn.hadcn.test.One {
public <methods>;
}
表示One
类下的所有public
方法都不会被混淆,当然你还可以加入参数,比如以下表示用JSONObject作为入参的构造函数不会被混淆
-keep class cn.hadcn.test.One {
public <init>(org.json.JSONObject);
}
有时候你是不是还想着,我不需要保持类名,我只需要把该类下的特定方法保持不被混淆就好,那你就不能用keep方法了,keep方法会保持类名,而需要用keepclassmembers
,如此类名就不会被保持,为了便于对这些规则进行理解,官网给出了以下表格
保留 | 防止被移除或者被重命名 | 防止被重命名 |
---|---|---|
类和类成员 | -keep | -keepnames |
仅类成员 | -keepclassmembers | -keepclassmembernames |
如果拥有某成员,保留类和类成员 | -keepclasseswithmembers | -keepclasseswithmembernames |
移除是指在压缩(Shrinking)时是否会被删除。以上内容时混淆规则中需要重点掌握的,了解后,基本所有的混淆规则文件你应该都能看懂了。再配合以下几点注意事项,开启你为自己代码,实现混淆规则之旅吧。
注意事项
1,jni方法不可混淆,因为这个方法需要和native方法保持一致;
-keepclasseswithmembernames class * { # 保持native方法不被混淆
native <methods>;
}
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异常;
-keep class * implements Android.os.Parcelable { # 保持Parcelable不被混淆
public static final Android.os.Parcelable$Creator *;
}
8,使用enum类型时需要注意避免以下两个方法混淆,因为enum类的特殊性,以下两个方法会被反射调用,见第二条规则。
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
混淆模板及常用第三方混淆
[python] view plain copy
- #############################################
- #
- # 对于一些基本指令的添加
- #
- #############################################
- # 代码混淆压缩比,在0~7之间,默认为5,一般不做修改
- -optimizationpasses 5
- # 混合时不使用大小写混合,混合后的类名为小写
- -dontusemixedcaseclassnames
- # 指定不去忽略非公共库的类
- -dontskipnonpubliclibraryclasses
- # 这句话能够使我们的项目混淆后产生映射文件
- # 包含有类名->混淆后类名的映射关系
- -verbose
- # 指定不去忽略非公共库的类成员
- -dontskipnonpubliclibraryclassmembers
- # 不做预校验,preverify是proguard的四个步骤之一,Android不需要preverify,去掉这一步能够加快混淆速度。
- -dontpreverify
- # 保留Annotation不混淆
- -keepattributes *Annotation*,InnerClasses
- # 避免混淆泛型
- -keepattributes Signature
- # 抛出异常时保留代码行号
- -keepattributes SourceFile,LineNumberTable
- # 指定混淆是采用的算法,后面的参数是一个过滤器
- # 这个过滤器是谷歌推荐的算法,一般不做更改
- -optimizations !code/simplification/cast,!field/*,!class/merging/*
- #############################################
- #
- # Android开发中一些需要保留的公共部分
- #
- #############################################
- # 保留我们使用的四大组件,自定义的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);
- }
- # 移除Log类打印各个等级日志的代码,打正式包的时候可以做为禁log使用,这里可以作为禁止log打印的功能使用
- # 记得proguard-android.txt中一定不要加-dontoptimize才起作用
- # 另外的一种实现方案是通过BuildConfig.DEBUG的变量来控制
- #-assumenosideeffects class android.util.Log {
- # public static int v(...);
- # public static int i(...);
- # public static int w(...);
- # public static int d(...);
- # public static int e(...);
- #}
- #############################################
- #
- # 项目中特殊处理部分
- #
- #############################################
- #-----------处理反射类---------------
- #-----------处理js交互---------------
- #-----------处理实体类---------------
- # 在开发的时候我们可以将所有的实体类放在一个包内,这样我们写一次混淆就行了。
- #-keep public class com.ljd.example.entity.** {
- # public void set*(***);
- # public *** get*();
- # public *** is*();
- #}
- #-----------处理第三方依赖库---------
下面介绍常用第三方混淆配置:
[python] view plain copy
- # AndroidEventBus
- -keep class org.simple.** { *; }
- -keep interface org.simple.** { *; }
- -keepclassmembers class * {
- @org.simple.eventbus.Subscriber <methods>;
- }
- # 百度地图(jar包换成自己的版本,记得签名要匹配)
- -libraryjars libs/baidumapapi_v2_1_3.jar
- -keep class com.baidu.** {*;}
- -keep class vi.com.** {*;}
- -keep class com.sinovoice.** {*;}
- -keep class pvi.com.** {*;}
- -dontwarn com.baidu.**
- -dontwarn vi.com.**
- -dontwarn pvi.com.**
- # Bugly
- -dontwarn com.tencent.bugly.**
- -keep class com.tencent.bugly.** {*;}
- # ButterKnife
- -keep class butterknife.** { *; }
- -dontwarn butterknife.internal.**
- -keep class **$$ViewBinder { *; }
- -keepclasseswithmembernames class * {
- @butterknife.* <fields>;
- }
- -keepclasseswithmembernames class * {
- @butterknife.* <methods>;
- }
- # EventBus
- -keepattributes *Annotation*
- -keepclassmembers class ** {
- @org.greenrobot.eventbus.Subscribe <methods>;
- }
- -keep enum org.greenrobot.eventbus.ThreadMode { *; }
- -keep class com.facebook.** {*;}
- -keep interface com.facebook.** {*;}
- -keep enum com.facebook.** {*;}
- # FastJson
- -dontwarn com.alibaba.fastjson.**
- -keep class com.alibaba.fastjson.** { *; }
- -keepattributes Signature
- -keepattributes *Annotation*
- # Fresco
- -keep class com.facebook.fresco.** {*;}
- -keep interface com.facebook.fresco.** {*;}
- -keep enum com.facebook.fresco.** {*;}
- # 高德相关依赖
- # 集合包:3D地图3.3.2 导航1.8.0 定位2.5.0
- -dontwarn com.amap.api.**
- -dontwarn com.autonavi.**
- -keep class com.amap.api.**{*;}
- -keep class com.autonavi.**{*;}
- # 地图服务
- -dontwarn com.amap.api.services.**
- -keep class com.map.api.services.** {*;}
- # 3D地图
- -dontwarn com.amap.api.mapcore.**
- -dontwarn com.amap.api.maps.**
- -dontwarn com.autonavi.amap.mapcore.**
- -keep class com.amap.api.mapcore.**{*;}
- -keep class com.amap.api.maps.**{*;}
- -keep class com.autonavi.amap.mapcore.**{*;}
- # 定位
- -dontwarn com.amap.api.location.**
- -dontwarn com.aps.**
- -keep class com.amap.api.location.**{*;}
- -keep class com.aps.**{*;}
- # 导航
- -dontwarn com.amap.api.navi.**
- -dontwarn com.autonavi.**
- -keep class com.amap.api.navi.** {*;}
- -keep class com.autonavi.** {*;}
- # Glide
- -keep public class * implements com.bumptech.glide.module.GlideModule
- -keep public enum com.bumptech.glide.load.resource.bitmap.ImageHeaderParser$** {
- **[] $VALUES;
- public *;
- }
- # Gson
- -keepattributes Signature-keepattributes *Annotation*
- -keep class sun.misc.Unsafe { *; }
- -keep class com.google.gson.stream.** { *; }
- # 使用Gson时需要配置Gson的解析对象及变量都不混淆。不然Gson会找不到变量。
- # 将下面替换成自己的实体类
- -keep class com.example.bean.** { *; }
- # Jackson
- -dontwarn org.codehaus.jackson.**
- -dontwarn com.fasterxml.jackson.databind.**
- -keep class org.codehaus.jackson.** { *;}
- -keep class com.fasterxml.jackson.** { *; }
- # 极光推送
- -dontoptimize
- -dontpreverify
- -dontwarn cn.jpush.**
- -keep class cn.jpush.** { *; }
- # OkHttp
- -keep class com.squareup.okhttp.** { *; }
- -keep interface com.squareup.okhttp.** { *; }
- -dontwarn com.squareup.okhttp.**
- # OkHttp3
- -dontwarn com.squareup.okhttp3.**
- -keep class com.squareup.okhttp3.** { *;}
- -dontwarn okio.**
- # Okio
- -dontwarn com.squareup.**
- -dontwarn okio.**
- -keep public class org.codehaus.* { *; }
- -keep public class java.nio.* { *; }
- # OrmLite
- -keepattributes *DatabaseField*
- -keepattributes *DatabaseTable*
- -keepattributes *SerializedName*
- -keep class com.j256.**
- -keepclassmembers class com.j256.** { *; }
- -keep enum com.j256.**
- -keepclassmembers enum com.j256.** { *; }
- -keep interface com.j256.**
- -keepclassmembers interface com.j256.** { *; }
- # Realm
- -keep class io.realm.annotations.RealmModule
- -keep @io.realm.annotations.RealmModule class *
- -keep class io.realm.internal.Keep
- -keep @io.realm.internal.Keep class * { *; }
- -dontwarn javax.**
- -dontwarn io.realm.**
- # Retrofit
- -dontwarn retrofit2.**
- -keep class retrofit2.** { *; }
- -keepattributes Signature
- -keepattributes Exceptions
- # Retrolambda
- -dontwarn java.lang.invoke.*
- # RxJava RxAndroid
- -dontwarn sun.misc.**
- -keepclassmembers class rx.internal.util.unsafe.*ArrayQueue*Field* {
- long producerIndex;
- long consumerIndex;
- }
- -keepclassmembers class rx.internal.util.unsafe.BaseLinkedQueueProducerNodeRef {
- rx.internal.util.atomic.LinkedQueueNode producerNode;
- }
- -keepclassmembers class rx.internal.util.unsafe.BaseLinkedQueueConsumerNodeRef {
- rx.internal.util.atomic.LinkedQueueNode consumerNode;
- }
- # Universal-Image-Loader-v1.9.5
- -libraryjars libs/universal-image-loader-1.9.5-SNAPSHOT-with-sources.jar
- -dontwarn com.nostra13.universalimageloader.**
- -keep class com.nostra13.universalimageloader.** { *; }
- # 微信支付
- -dontwarn com.tencent.mm.**
- -dontwarn com.tencent.wxop.stat.**
- -keep class com.tencent.mm.** {*;}
- -keep class com.tencent.wxop.stat.**{*;}
- # 信鸽
- -keep public class * extends android.app.Service
- -keep public class * extends android.content.BroadcastReceiver
- -keep class com.tencent.android.tpush.** {* ;}
- -keep class com.tencent.mid.** {* ;}
- -keepattributes *Annotation*
- # 新浪微博
- -keep class com.sina.weibo.sdk.* { *; }
- -keep class android.support.v4.* { *; }
- -keep class com.tencent.* { *; }
- -keep class com.baidu.* { *; }
- -keep class lombok.ast.ecj.* { *; }
- -dontwarn android.support.v4.**
- -dontwarn com.tencent.**s
- -dontwarn com.baidu.**
- # 讯飞语音
- -dontwarn com.iflytek.**
- -keep class com.iflytek.** {*;}
- # xUtils3.0
- -keepattributes Signature,Annotation
- -keep public class org.xutils.** {
- public protected *;
- }
- -keep public interface org.xutils.** {
- public protected *;
- }
- -keepclassmembers class * extends org.xutils.** {
- public protected *;
- }
- -keepclassmembers @org.xutils.db.annotation.* class * {;}
- -keepclassmembers @org.xutils.http.annotation. class * {*;}
- -keepclassmembers class * {
- @org.xutils.view.annotation.Event ;
- }
- # 银联
- -dontwarn com.unionpay.**
- -keep class com.unionpay.** { *; }
- # 友盟统计分析
- -keepclassmembers class * { public <init>(org.json.JSONObject); }
- -keepclassmembers enum com.umeng.analytics.** {
- public static **[] values();
- public static ** valueOf(java.lang.String);
- }
- # 友盟自动更新
- -keepclassmembers class * { public <init>(org.json.JSONObject); }
- -keep public class cn.irains.parking.cloud.pub.R$*{ public static final int *; }
- -keep public class * extends com.umeng.**
- -keep class com.umeng.** { *; }
- # 支付宝钱包
- -dontwarn com.alipay.**
- -dontwarn HttpUtils.HttpFetcher
- -dontwarn com.ta.utdid2.**
- -dontwarn com.ut.device.**
- -keep class com.alipay.android.app.IAlixPay{*;}
- -keep class com.alipay.android.app.IAlixPay$Stub{*;}
- -keep class com.alipay.android.app.IRemoteServiceCallback{*;}
- -keep class com.alipay.android.app.IRemoteServiceCallback$Stub{*;}
- -keep class com.alipay.sdk.app.PayTask{ public *;}
- -keep class com.alipay.sdk.app.AuthTask{ public *;}
- -keep class com.alipay.mobilesecuritysdk.*
- -keep class com.ut.*