Android ProGuard：代码混淆压缩

写这篇文章的目的

一直以来，在项目中需要进行代码混淆时每次都要去翻文档，很麻烦。也没有像写代码那样记得那么多。既然要查来查去，就不如自己捋一捋这个知识点了，被人写的终究还是别人的。所以自己去翻看了很多文章和官方文档，总结下就把这篇文章写下来了。以后方便查找和修改，也加深这个知识的理解。

前言

Android 开发中，打包避免不了各种优化，开启混淆可以很好就是其中一种优化方式。为了使你打包的 apk 尽可能小，应该在打包 apk 的时候开启代码压缩功能移除没有被使用的代码和资源。但是这和混淆有什么关系？

代码压缩混淆：ProGuard 可以从你打包的应用程序检测和删除未使用的类、字段、方法和属性，当然也会包括libraries里的，这样对64K引用限制很有帮助的。ProGuard 也会优化字节码，把类、字段、属性和方法用短的名称表示-混淆（官方文档上也说了还有删除未使用的代码指令，这个有时间再研究下了）。
资源压缩：(Resource shrinking) 配合 Gradle 使用，可以安全移除没有使用的打包时应用程序没有使用到的资源，包括代码库中的资源。

一、代码混淆压缩配置

那么混淆 (ProGuard) 改怎么用？

android {
  buildTypes {
  release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'),
                    'proguard-rules.pro'
        }
    }
}

上面这段代码很眼熟啊，就是项目 build.gradle 文件里的一段代码，不过项目创建时默认 minifyEnabled 的值是 false，需要开发者手动改为 true，或者点击这样：

选中项目例如app-按F4-进入 Project Structure -右边选择 Build Type -选择 release -把Minify Enable 设置为true

看下两个分别打包出来的效果：自己感受下，可以看到前后apk大小和代码的变化

空项目混淆前后不比较（左为混淆）

如果留意 gradle 控制台的换，会有:proguard:xxxx的信息。代码就这么被混淆和压缩了，本来很多有意义的单词都被一些字母代替了。

每次build完之后，ProGuard 都会输出一些文件在项目模块 /build/outputs/mapping/release/下：

dump.txt ：描述 APK 中所有类文件的内部结构
mapping.txt ：提供原始和混淆后类、方法、字段名的映射对照
seeds.txt ：列出未混淆的类和成员
usage.txt ：列出从 APK 中移除的代码

关于mapping.txt使用的场景也是比较多的，比如使用bugly等平台可能需要上传mapping或者用Android Studio查看 apk 的 classes.dex 时，有需要的话可以使用Load ProGuard mappings...加载mapping.txt，这样可以看到混淆前的代码样子

注意：如果在debug模式下设置minifyEnabled true,而且需要使用Instant Run增量构建的时候，ProGuard只会删除不使用的代码，不会混淆代码。不过这个情况也是在debug下使用的吧，一般在debug模式下不开启混淆的，因为项目build的时间就很长了，再开个混淆那就更长了。如果你真的要这么debug的话：用useProguard false 即可。这样代码也会被混淆。
这个需求我暂时没有遇到过，只是在debug下有开启过混淆，但是没有用Instant Run。
代码如下：

android {
    buildTypes {
        debug {
            minifyEnabled true
            useProguard false
            proguardFiles getDefaultProguardFile('proguard-android.txt'),
                    'proguard-rules.pro'
        }
       ...
}

二、移除没有被使用的资源

android {
    ...
    buildTypes {
        release {
            shrinkResources true
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'),
                    'proguard-rules.pro'
        }
    }
}

加了一句shrinkResources true。可是在用 Android studio 打开 apk 的时候你还是发现有那个文件的存在，不过是之前的那个文件被替换成了 1x1(67B) 大小的图片了。

三、自定义代码保留规则

并不是所有代码都需要被混淆的，一般默认的 ProGuardFile \tools\proguard\proguard-android.txt下已经默认做好了一些设置，哪些些代码不能被混淆的，但是在实际开发中可能还不够，还需要开发者自定义一些混淆规则。在这里我有个小建议：如果需要添加第三方库到你的 app，那么同时顺便也找下这个库的混淆规则，并把它加入到你的项目里。混淆规则一般遵循以下几点：

AndroidManifest.xml 中使用到的类，比如四大组件
JNI 调用的方法
运行时操作的代码，比如反射
枚举....

自定义混淆的方法：

1. 使用注解 @Keep
以下代码的效果是类和成员都会保留。只想保留成员可以在成员上使用@keep

@Keep
public class User {

    private String userName;

    public String getUserName() {
        return userName;
    }

}

哪些类、方法、属性、字段需要保留的，不被混淆的，用@Keep可以了，就是这么简单，这个几乎没怎么用。

2. 在 proguard-rules.pro 中定义
这个文件在项目的根目录下。
这个是用得比 @Keep 用都多，比如添加第三库的时候，一般会提供相应的混淆规则，这些规则需要加入到混淆文件中。

四、常用命令说明

-keep ：保留指定的类和成员(字段、方法)。
-keepclassmembers：保留指定的类成员，如果成员所在的类也保留下来的话。也就是说类没有保留，那么成员也不存在了或者说这个命令不能影响类。
-keepclasseswithmembers：保留指定的类和成员，前提条件是所指定类中要有的指定的类成员。比如： User 类中没有 name，但是你指定保留 name，那么这个命令是不生效的。
-keepnames：-keep,allowshrinking 的简写，指定保留指定类和成员，如果代码压缩阶段类或成员没有被删除。
-keepclassmembernames：-keepclassmembers,allowshrinking 的简写，保留指定的成员，如果代码压缩阶段成员没有被删除。
-keepclasseswithmembernames：-keepclasseswithmembers,allowshrinking 的简写，保留指定类和成员，如果代码压缩后压缩没有被删除。比如：User 类中没有 name，但是你指定保留 name，那么这个命令是不生效的（User 该混淆混淆）。
-dontwarn：指定不警告未解决的引用和其他重要问题。
-keepattributes：-keepattributes SourceFile,LineNumberTable 和 -renamesourcefileattribute SourceFile 配合使用。分别是保存用于调试堆栈跟踪的行号信息和隐藏原始的源文件名。在项目的 ProGuard 文件取消注释就可以用了。-keepattributes其他属性

说明：allowshrinking 表示允许被删除。类似的修饰符还有其他的

保留项	不会被移除(压缩)、混淆(重命名)	会被移除(压缩)、混淆(重命名)
类、成员	`-keep`	`-keepnames`
成员	`-keepclassmembers`	`-keepclassmembernames`
类、成员(如果有指定成员)	`-keepclasseswithmembers`	`-keepclasseswithmembernames`

使用规则

[命令] [类规范]{
      [成员];
}

注意：需要不需要保留成员，可以不用{[成员];}

【类规范】：限定条件，通过限定条件定位到符合条件的类。写起了和java语法差不多，不过可以带有通配符

[注解] [修饰符] 类定义符 类名 [extends | implements 类名]

中括号里的是可选项，分割线|提供选择，具体如下：

注解：@xxx
修饰符：public | private | final | abstract | ... ，前加 ! 表示非xxx
类定义符：interface | class | enum，interface | enum 前加 ! 表示非interface | enum ，注解用class表示
类名：全类名
extends | implements 类名：限定前面的类继承或实现某个类
$：内部类
通配符：? - 任何单个字符；* - 不包括包分隔符的其他任何部分；** - 任何部分

【成员】：类成员的限定条件，通过限定条件匹配到符合条件的成员。写起了也是和java差不多，可以用通配符，每句结束有;。

{
    [@annotationtype] [[!]public|private|protected|static|volatile|transient ...]  |
                                                                      (fieldtype fieldname);
    [@annotationtype] [[!]public|private|protected|static|synchronized|native|abstract|strictfp ...]  |
                                                                                           (argumenttype,...) |
                                                                                           classname(argumenttype,...) |
                                                                                           (returntype methodname(argumenttype,...));
    [@annotationtype] [[!]public|private|protected|static ... ] *;
    ...
}

简单的就是：
{
    [注解] [修饰符]  | 类型 字段名;
    [注解] [修饰符]  | 方法 | (参数类型,...) | classname(参数类型,...) |  返回值类型 方法名(参数,...);
    [注解] [修饰符] *;
    ...
}

注解：@xxx
修饰符：成员修饰符，前面加!表示非xxx
*：任何方法或字段
：任何构造器，构造器也可以用类名或者全类名来指定
：任何字段
：任何方法
字段名：字段名，可以和通配符使用
方法名：方法名，可以和通配符使用
类型：全类名，基本数据类型除外
参数类型：全类名，基本数据类型除外
返回值类型：全类名，基本数据类型除外
通配符：%-任何基本数据类型；?-任何单个字符；*-不包括包分隔符的其他任何部分；**-任何部分；***-任何类型(数组等)；...-任意长度任意类型参数

五、使用举例

忽略某个内容的警告信息

-dontwarn javax.annotation.**

不混淆某个类及成员

-keep public class com.xin.proguard.nonuse.Keep{
    *;
}

不混淆某个包下的所有类及成员

-keep public class com.xin.proguard.nonuse.**{
    *;
}

不混淆有类名有Bean的类及其成员

-keep class **Bean**{
    *;
}

不混淆某个接口的实现

-keep class * implements com.bumptech.glide.module.GlideModule

不混淆某个类的子类

-keep class * extends com.bumptech.glide.module.AppGlideModule

不混淆某个成员

-keepclassmembers class android.support.design.internal.BottomNavigationMenuView{
    private boolean mShiftingMode;
}

不混淆某个类的指定方法

-keepclassmembers class com.xin.proguard.nonuse.User{
    public void setUserName(java.lang.String);
}

移除Log打印
先确认 build.gradle 配置如下，原因是配置 -dontoptimize 情况下无法移除log打印。

buildTypes {
        release {
            shrinkResources true
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
        
    }

-assumenosideeffects class android.util.Log{
    public static *** v(...);
    public static *** i(...);
    public static *** d(...);
    public static *** w(...);
    public static *** e(...);
}

大胆的建议：如果很明确某个包或者某个类改怎么处理的话，用-keepnames比-keep好。

六、自定义资源保留规则

使用前请确定在项目 build.gradle 中配置了 shrinkResources true。自定义资源保留规则需要在项目的 xml 文件中定义：根节点，需要保留资源用 tools:keep，需要移除资源用 tools:discard；两个资源之间可以用 , 分隔、* 可以用作通配符。

可能有人会问：如果我把同一个资源同时作为 tools:keep 和 tools:discard 的值，这咋整？告诉你，这个资源会被移除。当然，谁会这么傻逼做这样的事呢，哈哈哈。不要问我是怎么知道的。说多都是泪，我就是那个傻逼

严格模式：tools:shrinkMode="strict"。tools:shrinkMode 默认值是safe，默认情况如果在代码中使用Resources.getIdentifier()，混淆器会把所有匹配的资源都标记为已使用的，且不可删除。

比如：下面的代码会导致所有以img_为前缀的资源都会被标记为“已使用”

String name = String.format("img_%1d", angle + 1);
res = getResources().getIdentifier(name, "drawable", getPackageName());

例如：在res/raw/下创建keep.xml。keep.xml内容如下
在res/其它文件夹下创建其他名称的xml文件也行

如果开启了严格模式，而且也在代码中动态获取资源，那么就要使用tools:keep属性保留指定的资源。否则使用代码获取的资源不能正常使用。

项目构建的时候不会把 keep.xml 打包到 apk 里。不是 apk 里没有 keep.xml 文件，而是
keep.xml 里只剩个空壳。

删除可替代资源
资源压缩可以删除未使用的代码和资源，同样也可以删除一些可替代的资源。比如国际化中一些语言资源string.xml、values-xx，布局资源layout-xx等。当你不需要全部语言时，根据实际需要把指定的语言打包到apk里，那么资源压缩器就可以帮到你了。你可以在项目的gradle文件配置resConfig(resConfigs)属性，只保留显示声明的，未声明的将被删除。

例如以下代码展示只是用语言资源为中文：

android {
    defaultConfig {
        ...
        resConfig "zh"
    }
}

如果是多个资源那就把 resConfig 改为 resConfigs 多了个 s 即可，当然，只声明一个资源时也可以用 resConfigs 。例如，只保留英语、法语、竖屏布局资源：

android {
    defaultConfig {
        ...
        resConfigs "en", "fr", "port"
    }
}

屏幕密度资源配置请参考这里configure-split

关于 Android 混淆和资源压缩就到此结束了，很久没写东西了，写得不要请见谅，有不妥之处欢迎指出。感谢阅读。

(End)

参考链接

Shrink Your Code and Resources
ProGuard Version 4.7
www.guardsquare.com
写给Android开发者的混淆使用手册