前言
最近项目开发中遇个Crash,
java.lang.AbstractMethodError: abstract method "void j.a.d.a.b.b.refresh()"
说refresh没有实现找不到,但是本地都是可以的,然后对照了下发现是混淆出了问题:在调用类里认为方法refresh()没有被混淆,而在真正的类(b)里,已经被混淆了,所以找不到报错了。所以来此整理下混淆相关东西
一、概念
作为Android开发,我们我们都知道我们的App上线后都有可能被反编译破解,所以我们发布前我们要对我们的代码进行混淆处理,将明文代码经过一些既定的策略转换为不相关的字符,有时间的可以推荐大家去官网整体看下Android developers,也可以从此文大致了解一下。
二、作用
将原来的明文代码经过一些既定的策略转换为随机不相关字符;
将原来长的类名,方法,变量等转化为随机不相关的字符,
通常都是单个字母,以减少字节码转换时间。
三、应用
直接用Android Studio来说明如何进行混淆,Android Studio自身集成Java语言的ProGuard作为压缩,优化和混淆工具,配合Gradle构建工具使用很简单,Gradle3.4之后改为与R8编辑器协同工作,但依然用ProGuard既有规则,所以只需要在工程应用目录的gradle文件中设置minifyEnabled为true即可。然后我们就可以到proguard.cfg文件中加入我们的混淆规则了。
android {
...
buildTypes {
release {
// 开启混淆
minifyEnabled true
//移除无用的文件
shrinkResources false
// 配置混淆文件位置
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard.cfg'
}
}
}
上面的配置混淆文件位置中“proguard-android.txt” 是系统通用的混淆规则,后面的proguard.cfg是我们自己定义的混淆规则。默认新建module时都会新建一个proguard-project文件但是基本为空的如下:
# To enable ProGuard in your project, edit project.properties
# to define the proguard.config property as described in that file.
#
# Add project specific ProGuard rules here.
# By default, the flags in this file are appended to flags specified
# in ${sdk.dir}/tools/proguard/proguard-android.txt
# You can edit the include path and order by changing the ProGuard
# include property in project.properties.
#
# For more details, see
# http://developer.android.com/guide/developing/tools/proguard.html
# Add any project specific keep options here:
# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
# public *;
#}
四、ProGuard作用
压缩(Shrinking):
默认开启,用以减小应用体积,移除未被使用的类和成员,并且会在优化动作执行之后再次执行(因为优化后可能会再次暴露一些未被使用的类和成员)。
-dontshrink 关闭压缩
优化(Optimization):
默认开启,在字节码级别执行优化,让应用运行的更快。
-dontoptimize 关闭优化
-optimizationpasses n 表示proguard对代码进行迭代优化的次数,Android一般为5
混淆(Obfuscation):
默认开启,增大反编译难度,类和类成员会被随机命名,除非用keep保护。
-dontobfuscate 关闭混淆
混淆后默认会在工程目录app/build/outputs/mapping/release下生成一个mapping.txt文件,这就是混淆规则可以看到具体的将xxx类变成了a/b/c/d/e...,我们可以根据这个文件把混淆后的代码反推回源本的代码,所以这个文件很重要,注意保护好。原则上,代码混淆后越乱越无规律越好,但有些地方我们是要避免混淆的,否则程序运行就会出错,所以就有了下面我们要教大家的,如何让自己的部分代码避免混淆从而防止出错。
五、基本规则
先看如下两个比较常用的命令,很多童鞋可能会比较迷惑以下两者的区别。
-keep class com.jianshu.test.* //1
-keep class com.jianshu.test.** //2
只带一个的1表示只保持该包下的第一层级类名,而子包下的类名还是会被混淆;两颗2表示把本包和所含子包下的类名都保持;用以上方法保持类后,你会发现类名虽然未混淆,但里面的具体方法和变量命名还是变了,这时如果既想保持类名,又想保持里面的内容不被混淆,我们就需要以下方法了:
-keep class com.jianshu.test. *{*;}
在此基础上,我们也可以使用Java的基本规则来保护特定类不被混淆,比如我们可以用extends,implements等这些Java规则。如下例子就避免所有继承Activity的类被混淆:
-keep public class * extends android.app.Activity
如果我们要保留一个类中的内部类不被混淆则需要用$符号,如下例子表示保持TestBean内部类ContentBean中的所有public内容不被混淆。
-keepclassmembers class xxx.xxx.TestBean$ContentBean{
public *;
}
再者,如果一个类中你不希望保持全部内容不被混淆,而只是希望保护类下的特定内容,就可以使用
; //匹配所有构造器
; //匹配所有域
; //匹配所有方法方法
你还可以在
-keep class xxx.xxx.TestBean {
public ;
}
表示所有的表示TestBean类下的所有public方法都不会被混淆,当然你还可以加入参数,比如以下表示用String作为入参的构造函数不会被混淆
-keep class xxx.xxx.TestBean {
public (String);
}
有时候你是不是还想着,我不需要保持类名,我只需要把该类下的特定方法保持不被混淆就好,那你就不能用keep方法了,keep方法会保持类名,而需要用keepclassmembers ,如此类名就不会被保持,为了便于对这些规则进行理解,官网给出了以下表格
保留 | 防止被移除或者被重命名 | 防止被重命名 |
---|---|---|
类和类成员 | -keep | -keepnames |
仅类成员 | -keepclassmembers | -keepclassmembernames |
如果拥有某成员,保留类和类成员 | -keepclasseswithmembers | -keepclasseswithmembernames |
移除是指在压缩(Shrinking)时是否会被删除。以上内容时混淆规则中需要重点掌握的,了解后,基本所有的混淆规则文件你应该都能看懂了。想有更深入了解规则可以去ProGuard配置例如去除警告等等配置,再配合以下几点注意事项,开启你为自己代码,实现混淆规则之旅吧。
六、常用
1,jni方法不可混淆,因为这个方法需要和native方法保持一致;
-keepclasseswithmembernames class * { # 保持 native 方法不被混淆
native ;
}
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);
}
拓展
发布一款应用除了设minifyEnabled为ture,你也应该设置zipAlignEnabled为true,像Google Play强制要求开发者上传的应用必须是经过zipAlign的,zipAlign可以让安装包中的资源按4字节对齐,这样可以减少应用在运行时的内存消耗。
最后
项目遇到的问题在此记录一下,感谢生活,感谢分享!
参考资料:
https://developer.android.com/studio/build/shrink-code#keep-code
大部分参照
https://www.jianshu.com/p/7436a1a32891
感谢前辈们的分享~