Android系统源码代码混淆

前言

刚好有个项目需要提供apk给客户，所以需要对该apk进行代码混淆。在此将遇到的坑记录下来，避免后续再踩。

代码混淆

代码混淆主要是增加“不法分子“对apk进行反编译后，阅读代码的难度。代码混淆并不是所有的代码都可以混淆，有些代码则是不能混淆的，如一些反射应用。

开启混淆

这里记录遇到的第一个坑，在apk的Android.mk文件中，增加如下语句：

LOCAL_PROGUARD_ENABLED := full //编译的时候，进行完全混淆
LOCAL_PROGUARD_FLAG_FILES := proguard.flags //使用自定义混淆规则

使用【mmm】编译apk，将apk里的classes.dex反编译出来后，发现混淆并没有生效，还可以看到代码。

LOCAL_PROGUARD_ENABLED := full

这一句，从字面上理解，是开启混淆。如果你以为这样编译出来的apk就已经被混淆了，结果会让你很困惑。将apk里的classes.dex反编译，会看到代码仍然是混淆之前的状态，甚至连文件大小都没有变化。这行语句加不加，效果是一样的。
事实上，系统编译时，如果LOCAL_PROGUARD_ENABLED没有设置，除非环境变量中显式地定义了DISABLE_PROGUARD为true，LOCAL_PROGUARD_ENABLED默认值就是full。 参考如下源码：

build/core/package_internal.mk
LOCAL_PROGUARD_ENABLED:=$(strip $(LOCAL_PROGUARD_ENABLED))
ifndef LOCAL_PROGUARD_ENABLED
ifneq ($(DISABLE_PROGUARD),true)
    LOCAL_PROGUARD_ENABLED :=full
endif
endif

那为什么混淆不起作用呢？

ProGuard是一个压缩、优化和混淆Java字节码文件的免费的工具，
它可以删除无用的类、字段、方法和属性。可以删除没用的注释，
最大限度地优化字节码文件。它还可以使用简短的无意义的名称来
重命名已经存在的类、字段、方法和属性。常常用于android开发用
于混淆最终的项目，增加项目被反编译的难度。

再看看如下代码：

build/core/java.mk
ifeq ($(filter obfuscation,$(LOCAL_PROGUARD_ENABLED)),)
# By default no obfuscation
proguard_flags += -dontobfuscate
endif  # No obfuscation
ifeq ($(filter optimization,$(LOCAL_PROGUARD_ENABLED)),)
# By default no optimization
proguard_flags += -dontoptimize
endif  # No optimization

由此可看，如若要开启混淆，则需要打开obfuscation，在Android.mk文件中增加：

LOCAL_PROGUARD_ENABLED := full obfuscation

这时候再编译，然后反编译classes.dex文件，就会看到类和方法大部分变成了a,b,c之类无意义的短变量，完成了混淆的功能。同时带来的好处是，apk的体积大约有20%的减小。

混淆后发现apk运行异常

混淆成功后，运行apk时，发现工厂测试测试项都处于灰色状态（无法点击），经查找发现，在一个解析工厂测试配置文件的类中，运行出错。出错原因如下：

 java.lang.NoSuchMethodException: <init> [class android.content.Context, interface android.util.AttributeSet]

提示找不到相关的方法。

网上搜索方法，通常都是说该类使用到了反射，不要对其进行混淆，在proguard.flags文件中增加：

-keep class cvte.mid.factory.ConfigParser { *; }

但其实并不能解决问题，还是会报如上的错。

查看报错的地方，增加关键词进行搜索：

<init>

后面增加：

-keepclasseswithmembers class * {
    public <init>(android.content.Context, android.util.AttributeSet);
    public <init>(android.content.Context, android.util.AttributeSet, int);
}

重新编译后，问题解决。原来在于类构造函数被混淆了，就会找不到该类。

<init>	匹配类中的所有构造函数

apk闪退

在某个测试项会出现闪退情况，具体log如下：

No pending exception expected: java.lang.NoSuchFieldError: no "Ljava/io/FileDescriptor;" field "mFd" in class "Lcom/serialport/SerialPort;" or its superclasses

这边结合关键词【field】和【代码混淆】，增加如下：

-keepclasseswithmembers class * {
    <fields>;
}

重新编译后，问题解决。

<field>	匹配类中的所有字段

混淆语法

如果使用自定义的混淆规则，则可以在Android.mk目录下增加一个proguard.flags文件，然后在Android.mk中引用：

LOCAL_PROGUARD_FLAG_FILES := proguard.flags

该文件的编写也是有语法的。

Proguard关键字：

Proguard关键字	描述
dontwarn	dontwarn是一个和keep可以说是形影不离,尤其是处理引入的library时.
keep	保留类和类中的成员，防止被混淆或移除
keepnames	保留类和类中的成员，防止被混淆，成员没有被引用会被移除
keepclassmembers	只保留类中的成员，防止被混淆或移除
keepclassmembernames	只保留类中的成员，防止被混淆，成员没有引用会被移除
keepclasseswithmembers	保留类和类中的成员，防止被混淆或移除，保留指明的成员
keepclasseswithmembernames	保留类和类中的成员，防止被混淆，保留指明的成员，成员没有引用会被移除

通配符：

关键字	描述
<filed>	匹配类中的所有字段
<method>	匹配类中的所有方法
<init>	匹配类中的所有构造函数
*	匹配任意长度字符，但不含包名分隔符(.)。比如说我们的完整类名是com.example.test.MyActivity，使用com.，或者com.exmaple.都是无法匹配的，因为无法匹配包名中的分隔符，正确的匹配方式是com.exmaple..，或者com.exmaple.test.，这些都是可以的。但如果你不写任何其它内容，只有一个*，那就表示匹配所有的东西。
**	匹配任意长度字符，并且包含包名分隔符(.)。比如proguard-android.txt中使用的-dontwarn android.support.**就可以匹配android.support包下的所有内容，包括任意长度的子包。
***	匹配任意参数类型。比如void set()就能匹配任意传入的参数类型，* get*()就能匹配任意返回值的类型。
…	匹配任意长度的任意类型参数。比如void test(…)就能匹配任意void test(String a)或者是void test(int a, String b)这些方法。

如果想要某个类或者方法不被混淆，则需要在此文件添加。具体添加规则可以百度，这里不赘述。

混淆模板

这里有个模板，可以参考使用：

#
#-------------------------------------------基本不用动区域----------------------------------------------
#
#
# -----------------------------基本 -----------------------------
#

# 指定代码的压缩级别 0 - 7(指定代码进行迭代优化的次数，在Android里面默认是5，这条指令也只有在可以优化时起作用。)
-optimizationpasses 5
# 混淆时不会产生形形色色的类名(混淆时不使用大小写混合类名)
-dontusemixedcaseclassnames
# 指定不去忽略非公共的库类(不跳过library中的非public的类)
-dontskipnonpubliclibraryclasses
# 指定不去忽略包可见的库类的成员
-dontskipnonpubliclibraryclassmembers
#不进行优化，建议使用此选项，
-dontoptimize
 # 不进行预校验,Android不需要,可加快混淆速度。
-dontpreverify
# 屏蔽警告
-ignorewarnings
# 指定混淆是采用的算法，后面的参数是一个过滤器
# 这个过滤器是谷歌推荐的算法，一般不做更改
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
# 保护代码中的Annotation不被混淆
-keepattributes *Annotation*
# 避免混淆泛型, 这在JSON实体映射时非常重要
-keepattributes Signature
# 抛出异常时保留代码行号
-keepattributes SourceFile,LineNumberTable
 #优化时允许访问并修改有修饰符的类和类的成员，这可以提高优化步骤的结果。
# 比如，当内联一个公共的getter方法时，这也可能需要外地公共访问。
# 虽然java二进制规范不需要这个，要不然有的虚拟机处理这些代码会有问题。当有优化和使用-repackageclasses时才适用。
#指示语：不能用这个指令处理库中的代码，因为有的类和类成员没有设计成public ,而在api中可能变成public
-allowaccessmodification
#当有优化和使用-repackageclasses时才适用。
-repackageclasses ''
 # 混淆时记录日志(打印混淆的详细信息)
 # 这句话能够使我们的项目混淆后产生映射文件
 # 包含有类名->混淆后类名的映射关系
-verbose

#
# ----------------------------- 默认保留 -----------------------------
#
#----------------------------------------------------
# 保持哪些类不被混淆
#继承activity,application,service,broadcastReceiver,contentprovider....不进行混淆
-keep public class * extends android.app.Activity
-keep public class * extends android.app.Application
-keep public class * extends android.support.multidex.MultiDexApplication
-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 class android.support.** {*;}## 保留support下的所有类及其内部类

-keep public class com.google.vending.licensing.ILicensingService
-keep public class com.android.vending.licensing.ILicensingService
#表示不混淆上面声明的类，最后这两个类我们基本也用不上，是接入Google原生的一些服务时使用的。
#----------------------------------------------------

# 保留继承的
-keep public class * extends android.support.v4.**
-keep public class * extends android.support.v7.**
-keep public class * extends android.support.annotation.**


#表示不混淆任何包含native方法的类的类名以及native方法名，这个和我们刚才验证的结果是一致
-keepclasseswithmembernames class * {
    native <methods>;
}


#这个主要是在layout 中写的onclick方法android:onclick="onClick"，不进行混淆
#表示不混淆Activity中参数是View的方法，因为有这样一种用法，在XML中配置android:onClick=”buttonClick”属性，
#当用户点击该按钮时就会调用Activity中的buttonClick(View view)方法，如果这个方法被混淆的话就找不到了
-keepclassmembers class * extends android.app.Activity{
    public void *(android.view.View);
}

#表示不混淆枚举中的values()和valueOf()方法，枚举我用的非常少，这个就不评论了
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

#表示不混淆任何一个View中的setXxx()和getXxx()方法，
#因为属性动画需要有相应的setter和getter的方法实现，混淆了就无法工作了。
-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);
}
-keepclasseswithmembers class * {
    public <init>(android.content.Context, android.util.AttributeSet);
    public <init>(android.content.Context, android.util.AttributeSet, int);
}

#表示不混淆Parcelable实现类中的CREATOR字段，
#毫无疑问，CREATOR字段是绝对不能改变的，包括大小写都不能变，不然整个Parcelable工作机制都会失败。
-keep class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator *;
}
# 这指定了继承Serizalizable的类的如下成员不被移除混淆
-keepclassmembers class * implements java.io.Serializable {
    static final long serialVersionUID;
    private static final java.io.ObjectStreamField[] serialPersistentFields;
    private void writeObject(java.io.ObjectOutputStream);
    private void readObject(java.io.ObjectInputStream);
    java.lang.Object writeReplace();
    java.lang.Object readResolve();
}
# 保留R下面的资源
#-keep class **.R$* {
# *;
#}
#不混淆资源类下static的
-keepclassmembers class **.R$* {
    public static <fields>;
}

# 对于带有回调函数的onXXEvent、**On*Listener的，不能被混淆
-keepclassmembers class * {
    void *(**On*Event);
    void *(**On*Listener);
}

# 保留我们自定义控件（继承自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);
}

#
#----------------------------- 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);
}
#在app中与HTML5的JavaScript的交互进行特殊处理
#我们需要确保这些js要调用的原生方法不能够被混淆，于是我们需要做如下处理：
-keepclassmembers class com.ljd.example.JSInterface {
    <methods>;
}

#
#---------------------------------实体类---------------------------------
#--------(实体Model不能混淆，否则找不到对应的属性获取不到值)-----
#
-dontwarn com.suchengkeji.android.confusiondemo.md.**
#对含有反射类的处理
-keep class com.suchengkeji.android.confusiondemo.md.** { *; }
#
# ----------------------------- 其他的 -----------------------------
#
# 删除代码中Log相关的代码
-assumenosideeffects class android.util.Log {
    public static boolean isLoggable(java.lang.String, int);
    public static int v(...);
    public static int i(...);
    public static int w(...);
    public static int d(...);
    public static int e(...);
}

# 保持测试相关的代码
-dontnote junit.framework.**
-dontnote junit.runner.**
-dontwarn android.test.**
-dontwarn android.support.test.**
-dontwarn org.junit.**


#
# ----------------------------- 第三方 -----------------------------
#
-dontwarn com.orhanobut.logger.**
-keep class com.orhanobut.logger.**{*;}
-keep interface com.orhanobut.logger.**{*;}

-dontwarn com.google.gson.**
-keep class com.google.gson.**{*;}
-keep interface com.google.gson.**{*;}
#

参考

1.https://blog.csdn.net/zhonglunshun/article/details/77720500
2.https://www.jianshu.com/p/b5b2a5dfaaf4
3.https://www.jianshu.com/p/7e0a6faeb882