大家应该都听过代码混淆吧,如果大家有去反编译过别人的APK的话,应
该会看到好多包名和类名是a,b.c….之类的的吧,这里就提到了一个概念:
混淆。
那就让我们了解下这个东西吧
作用:为了防止自己的劳动成果被别人窃取,混淆代码能有效防止被反编译
缺省情况下,proguard 会混淆所有代码,但是下面几种情况是不能改变java 元素的名称,否则就会这样就会导致程序出错。
一, 我们用到反射的地方。
二, 我们代码依赖于系统的接口,比如被系统代码调用的回调方法,这种情况最复杂。
三, 是我们的java 元素名称是在配置文件中配置好的。
所以使用proguard时,我们需要有个配置文件告诉proguard 那些java 元素是不能混淆的。
proguard 配置
最常用的配置选项
-dontwarn 缺省proguard 会检查每一个引用是否正确,但是第三方库里面往往有些不会用到的类,没有正确引用。如果不配置的话,系统就会报错。
-keep 指定的类和类成员被保留作为 入口 。
-keepclassmembers 指定的类成员被保留。
-keepclasseswithmembers 指定的类和类成员被保留,假如指定的类成员存在的话。
proguard 问题和风险
代码混淆后虽然有混淆优化的好处,但是它往往也会带来如下的几点问题
1,混淆错误,用到第三方库的时候,必须告诉 proguard 不要检查,否则proguard 会报错。
2,运行错误,当code 不能混淆的时候,我们必须要正确配置,否则程序会运行出错,这种情况问题最多。
3,调试苦难,出错了,错误堆栈是混淆后的代码 ,自己也看不懂。
为了防止混淆出问题,你需要熟悉你所有的code ,系统的架构 ,以及系
统和你code的集成的接口,并细心分析。 同时你必须需要一轮全面的测
试。 所以混淆也还是有一定风险的。 为了避免风险,你可以只是混淆部
分关键的代码,但是这样你的混淆的效果也会有所降低。
常见的不能混淆的androidCode
Android 程序 ,下面这样代码混淆的时候要注意保留。
Android系统组件,系统组件有固定的方法被系统调用。
被Android Resource 文件引用到的。名字已经固定,也不能混淆,比如自定义的View 。
Android Parcelable ,需要使用android 序列化的。
其他Anroid 官方建议 不混淆的,如
android.app.backup.BackupAgentHelper
android.preference.Preference
com.android.vending.licensing.ILicensingService
Java序列化方法,系统序列化需要固定的方法。
枚举 ,系统需要处理枚举的固定方法。
本地方法,不能修改本地方法名
annotations 注释
数据库驱动
有些resource 文件
用到反射的地方
如何实施
现在的系统已经配置为混淆时候会保留
Android系统组件
自定义View
Android Parcelable
Android R 文件
Android Parcelable
枚举
各个开发人员必须检查自己的code 是否用到反射 ,和其他不能混淆的地方。告诉我来修改配置文件(已经保留的就不需要了)
目前系统不检查的第三方库为
-dontwarn android.support.**
-dontwarn com.tencent.**
-dontwarn org.dom4j.**
-dontwarn org.slf4j.**
-dontwarn org.http.mutipart.**
-dontwarn org.apache.**
-dontwarn org.apache.log4j.**
-dontwarn org.apache.commons.logging.**
-dontwarn org.apache.commons.codec.binary.**
-dontwarn weibo4android.**
proguard 参数
-include {filename} 从给定的文件中读取配置参数
-basedirectory {directoryname} 指定基础目录为以后相对的档案名称
-injars {class_path} 指定要处理的应用程序jar,war,ear和目录
-outjars {class_path} 指定处理完后要输出的jar,war,ear和目录的名称
-libraryjars {classpath} 指定要处理的应用程序jar,war,ear和目录所需要的程序库文件
-dontskipnonpubliclibraryclasses 指定不去忽略非公共的库类。
-dontskipnonpubliclibraryclassmembers 指定不去忽略包可见的库类的成员。
保留选项
-keep {Modifier} {class_specification} 保护指定的类文件和类的成员
-keepclassmembers {modifier} {class_specification} 保护指定类的成员,如果此类受到保护他们会保护的更好
-keepclasseswithmembers {class_specification} 保护指定的类和类的成员,但条件是所有指定的类和类成员是要存在。
-keepnames {class_specification} 保护指定的类和类的成员的名称(如果他们不会压缩步骤中删除)
-keepclassmembernames {class_specification} 保护指定的类的成员的名称(如果他们不会压缩步骤中删除)
-keepclasseswithmembernames {class_specification} 保护指定的类和类的成员的名称,如果所有指定的类成员出席(在压缩步骤之后)
-printseeds {filename} 列出类和类的成员-keep选项的清单,标准输出到给定的文件
压缩
-dontshrink 不压缩输入的类文件
-printusage {filename}
-whyareyoukeeping {class_specification}
优化
-dontoptimize 不优化输入的类文件
-assumenosideeffects {class_specification} 优化时假设指定的方法,没有任何副作用
-allowaccessmodification 优化时允许访问并修改有修饰符的类和类的成员
混淆
-dontobfuscate 不混淆输入的类文件
-printmapping {filename}
-applymapping {filename} 重用映射增加混淆
-obfuscationdictionary {filename} 使用给定文件中的关键字作为要混淆方法的名称
-overloadaggressively 混淆时应用侵入式重载
-useuniqueclassmembernames 确定统一的混淆类的成员名称来增加混淆
-flattenpackagehierarchy {package_name} 重新包装所有重命名的包并放在给定的单一包中
-repackageclass {package_name} 重新包装所有重命名的类文件中放在给定的单一包中
-dontusemixedcaseclassnames 混淆时不会产生形形色色的类名
-keepattributes {attribute_name,…} 保护给定的可选属性,例如LineNumberTable, LocalVariableTable, SourceFile, Deprecated, Synthetic, Signature, and InnerClasses.
-renamesourcefileattribute {string} 设置源文件中给定的字符串常量
使用 gson 需要的配置
当Gson用到了泛型就会有报错,这个真给郁闷了半天,提示“Missing type parameter”。
另外我又用到了JsonObject,提交的Object里面的members居然被改成了a。所以上面给的东西还不够,还要加上
//用到自己拼接的JsonObject
-keep class com.google.gson.JsonObject { *; }
个人建议减少这些依赖包混淆带来的麻烦,干脆都全部保留不混淆。例如
-keep class com.badlogic.* { ; }
-keep class * implements com.badlogic.gdx.utils.Json*
-keep class com.google.* { ; }
一下讲了这么多理论,相信大家也烦了,好吧,我们现在就开干吧,如果中途有哪里不懂,就翻到上面看看,或者直接提问都可以的。
步骤:
1.找到项目根目录下的project.properties文件,
将“#proguard.config=${sdk.dir}/tools/proguard/proguard-
android.txt:proguard-project.txt”这行前的“#”删除即可;
2.修改混淆配置文件:找到项目根目录下的proguard-project.txt文件,修
改其中代码,这部分是最关键;
3.保存相关文件供以后出错时使用:主要有导出的apk文件、项目根目录下
的proguard目录下的文件(主要的是mapping.txt)和项目源码;
4.项目运行过程出错处理:根据错误信息和第3步中保存的mapping定位错
误位置。
实例:
1.将proguard-project.txt
的“#proguard.config=${sdk.dir}/tools/proguard/proguard-
android.txt:proguard-project.txt”这行前的“#”删除,最后导出即可
实现对代码的混淆,即使我们没有去编写proguard-project.txt中的内容。
下面是测试代码:
public class MainActivity extends Activity {
private String mName;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
mName = "dd";
getString(mName);
setName(mName);
showDialog();
// testError();
}
public String getString(String name) {
return name;
}
public void setName(String name) {
System.out.println("I'm" + name);
}
private void showDialog() {
new Handler().postDelayed(new Runnable() {
@Override
public void run() {
ScoreAlertDialog.showDialog(MainActivity.this);
}
}, 2000);
}
public static class ScoreAlertDialog {
public static void showDialog(final Activity activity) {
if (activity.isFinishing()) {
return;
}
try {
AlertDialog.Builder builder = new AlertDialog.Builder(activity);
builder.setTitle("标题");
builder.setNegativeButton("确定", null);
builder.setPositiveButton("取消", new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
try {
Toast.makeText(activity, "欢迎", Toast.LENGTH_LONG).show();
} catch (Exception e) {
e.printStackTrace();
}
}
});
builder.show();
} catch (Exception e) {
e.printStackTrace();
}
}
}
private void testError() {
try {
int error = 1 / 0;
} catch (Exception e) {
e.printStackTrace();
}
}
}
2.打包反编译之后:
分析上面的代码我们会发现,自定义的方法名都被替换成无特殊意义的短
字母,而activity的onCreate()方法却没变;最后一个testError()方法由于
我们没有调用也被剔除掉了。这些就是默认的混淆处理策略。看到这里,
感觉混淆还是小case的哈~~
如果是一个外来人或者是其他反编译出你的APK来看,是不是一脸蒙逼,
当然包括自己也是,那有没有办法可以看到怎么混淆的呢,答案是肯定的。
这些内容讲了如何操作,参照官方文档,基本都会掌握。剩下的也是最难
的就是proguard-project.txt文件的编写。对于这部分,两种处理策略:自
己编写和使用别人写好的。先说如何使用别人写好的,我们引用的第三方
库无论开源还是闭源如有特殊情况我们都可以在他的User Guide中找到混
淆代码的配置,如我们引用了大名鼎鼎的guillep PullToRefresh,我们可
以在他的文档中找到如下的代码:
-optimizationpasses 5 -dontusemixedcaseclassnames -dontskipnonpubliclibraryclasses -dontpreverify -verbose -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
-keepclasseswithmembernames class * { native ;
}
-keepclasseswithmembernames class * { public (android.content.Context, android.util.AttributeSet);
}
-keepclasseswithmembernames class * { public (android.content.Context, android.util.AttributeSet, int);
}
-keepclassmembers enum * { public static **[] values();
public static ** valueOf(java.lang.String);
}
-keep class * implements android.os.Parcelable { public static final android.os.Parcelable$Creator *;
}
有了这部分代码我们就可以直接copy插入我们的项目中即可。这种方式还
是copy式的。那下面我们举个小例子看看如何自己写代码控制是否混淆。
还是用上面的例子,我们在这个项目的proguard-project.txt文件中
(之前为空)加入如下几行(proguard-project.txt中“#”代表注释):
-keep public class com.example.hunxiao.MainActivity {
java.lang.String getString(java.lang.String);
}
和之前的对比,我们发现其中的getString方法没有被混淆。没错,上面
proguard-project.txt的意思就是保持MainActivity的getString()方法不
要被混淆。大家也可以试试上述混淆代码中被注释的两行分别是什么效
果。
讲到这里已经开始涉及ProGuard的核心部分了,剩下的就是研读
ProGuard的文档,掌握的他的语法并使用之。还想掌握其他的就看看上面
提到的一些语法吧。
最后说明下:
第三方jar包中如果有.so文件,不用去理会,引
入的第三方jar文件不要混淆,否则可能会报异常