今天为什么写这篇文章是因为我又开始写安卓的东西了,在日后的工作中肯定会用到相关内容,记着几年前写过安卓但当时用到的混淆只是简单的按照网络上的配置弄的并没有深究到底是什么意思到底怎么用,今天静下心来取研究一下它到底是怎么配置的。
一、使用Android Studio是如何做代码混淆配置的
记着以往我们开发Android是使用Eclipse加ADT插件,但最近这两年Android Studio渐渐流行起来并且是官方出的IDE所有我们使用新的工具来学习。
1.首先我们看Android Studio创建的工程中如何配置混淆文件:
先看第一张图是指当前工程(模块)中找到build.gradle文件,然后第二张图是具体的混淆配置部分,混淆配置部分分为两部分
2.混淆文件的配置以及混淆的开启
- minifyEnabled true //这里是开启混淆
- proguardFiles getDefaultProguardFile(‘proguard-android.txt’), ‘proguard-rules.pro’ //这个是设置混淆配置文件,其中proguard-android.txt是系统默认混淆配置文件,这个文件存在于以下路径
> /Users/你的用户名/Library/Android/sdk/tools/proguard
当然我们不会直接使用这个默认配置,我们会按照自己的需求在proguard-rules.pro中做自定义配置,在第一张图我们能看到这个自定义混淆配置文件。
二、混淆规则
1、基本的混淆规则
我们经常在混淆配置文件看到如下配置
-keep class com.lmm.sdk.**
-keep class com.lmm.sdk.*
我们看到了两个配置后边一个是两个星一个是一个星那么这两个配置是什么意思呢,我们来解释一下
– 两个星表示将当前包下以及其子包下的所有类名都保持
– 一个星表示将当前包下所有类名保持
上边我们说了类名保持设置,那么类里边具体的方法和变量如何保持不变呢,那么就需要如下配置
-keep class com.lmm.sdk.** {*;}
上边这个配置是配置当前包下以及其子包的类名、方法和变量都进行了保持,那么如果只想设置当前包下所有类保持不变我们应该用一个星的写法如下
-keep class com.lmm.sdk.* {*;}
在以上的基础配置上我们还需要保持一些特定的类型不被混淆,我们在做项目的过程中经常会有一些继承或实现接口,也就是extend和implement,例如我们Activity
public class TestActivity extends AppCompatActivity {
private String TAG = "MySDK";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
}
那么为什么要对这些方面的类需要保持呢,因为我们对Activity和Service等功在使用的时候需要在AndroidManifest.xml配置过的,如果混淆那么就会造成运行失败或崩溃,所以需要保持。
# 保留我们使用的四大组件,自定义的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
2、那什么时候应该不被混淆呢,下面我们来列举一下
1.自定义控件一定保证不参与混淆否则会造成找不到对应的类而报错
2.枚举不能混淆这个不用过多解释
3.我们使用的第三方库不能混淆,一般三方库会给出对应的规则
4.运用了反射的类不能混淆
5.还有使用了Gson之类的工具的数据实体类不应该混淆,否则会造成解析数据出问题
6.用到WebView的JS调用的需要保证写的接口方法不混淆
7.Parcelable 的子类和 Creator 静态成员变量不混淆,否则会产生 Android.os.BadParcelableException 异常
说到这里我贴出一个基本的混淆的模板供参考
#############################################
#
# 对于一些基本指令的添加
#
#############################################
# 代码混淆压缩比,在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.ParcelableCreator *;
}
# 保留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);
}