APP瘦身大法--AndResGuard的使用

什么是AndResGuard

  AndResGuard是一个缩小APK大小的工具，它的原理类似Java Proguard，但是只针对资源。它会将原本冗长的资源路径变短，例如将res/drawable/wechat变为r/d/a。

为什么要使用AndResGuard

  在以往的开发中，我们通常只混淆了代码，资源文件却暴露在他人面前，res文件夹下所有文件名的可读性过强，如图：

image

我们可以看到res文件夹下的目录结构，比如我们想查看该app的布局文件，很轻松就能够找到layout文件夹：

image

  layout文件夹下，文件名的可读性也很高，我们可以看到有activity_add_friend.xml，可以知道是添加银行卡页面的布局。

  微信的开源库AndResGuard正好解决这种问题，对资源进行混淆，保护res资源文件的可读性，同时，可以减少APP的大小。经过AndResGuard处理后：

res文件夹名称变为r,该文件夹下的目录结构变成：

image

  此时，我们根本无法知道哪个文件夹是存放布局文件的，哪些文件夹是存放图片的，即使找到存放xml文件的文件夹，我们也难以知道这些xml是干嘛用的，如图：

image

  文件的名称毫无可读性，此时，想要找到添加银行卡界面的布局文件，就不再是件容易的事了。

接下来，我们对比下使用AndResGuard前后apk的大小：

image

可以看到，apk的大小从31.8M减少到29.6M，少了2.2M，很不错的瘦身大法。

AndResGuard的配置

项目根目录下build.gradle中，添加插件的依赖：

 dependencies {
        classpath 'com.tencent.mm:AndResGuard-gradle-plugin:1.2.10'
    }
    

app模块中build.gradle中，添加相关配置

  个人建议单独出一个gradle文件，在app目录下，创建and_res_guard.gradle文件，如图：

image

and_res_guard.gradle文件中的配置：

apply plugin: 'AndResGuard'

andResGuard {
    mappingFile = null
    use7zip = true
    useSign = true
    keepRoot = false
    compressFilePattern = [
            "*.png",
            "*.jpg",
            "*.jpeg",
            "*.gif",
            "resources.arsc"
    ]
    whiteList = [
            // your icon
            "R.drawable.icon",
            // for fabric
            "R.string.com.crashlytics.*",
            // for umeng update
            "R.string.tb_*",
            "R.layout.tb_*",
            "R.drawable.tb_*",
            "R.drawable.u1*",
            "R.drawable.u2*",
            "R.color.tb_*",
            // umeng share for sina
            "R.drawable.sina*",
            // for google-services.json
            "R.string.google_app_id",
            "R.string.gcm_defaultSenderId",
            "R.string.default_web_client_id",
            "R.string.ga_trackingId",
            "R.string.firebase_database_url",
            "R.string.google_api_key",
            "R.string.google_crash_reporting_api_key",

            //友盟
            "R.string.umeng*",
            "R.string.UM*",
            "R.layout.umeng*",
            "R.drawable.umeng*",
            "R.id.umeng*",
            "R.anim.umeng*",
            "R.color.umeng*",
            "R.style.*UM*",
            "R.style.umeng*",

            //融云
            "R.drawable.u*",
            "R.drawable.rc_*",
            "R.string.rc_*",
            "R.layout.rc_*",
            "R.color.rc_*",
            "R.id.rc_*",
            "R.style.rc_*",
            "R.dimen.rc_*",
            "R.array.rc_*"
    ]

    sevenzip {
        artifact = 'com.tencent.mm:SevenZip:1.2.10'
        //path = "/usr/local/bin/7za"
    }
}

  其中whiteList（白名单）中指定不需要进行混淆的资源路径规则，主要是一些第三方SDK，因为有些SDK的代码中引用到对应的资源文件，如果对其进行混淆，会导致找不到对应资源文件，出现crash，所以不能对其资源文件进行混淆。由于公司的项目中使用到了友盟和融云，所以将这两个SDK加入白名单，更多的白名单可以查看：

AndResGuard白名单

  由于我们并非是在app模块下的build.gradle中添加AndResGuard的配置，而是单独出and_res_guard.gradle，所以需要在app模块下的build.gradle文件中引用，在app模块下的build.gradle文件开头添加以下代码引用：

apply from: 'and_res_guard.gradle'

AndResGuard的使用

集成完AndResGuard后，在app的gradle的tasks中，多了一个叫做andresguard的task,如图：

image

如果想打debug包，则执行resguardDebug指令；

如果想打preview包，则执行resguardPreview指令；

如果想打release包，则执行resguardRelease指令。

  演示下打release包，我们双击执行resguardRelease指令，执行完毕后，我们可以在app目录下的/build/output/apk/release/AndResGuard_{apk_name}/ 文件夹中找到混淆后的Apk:

image

其中app-release_aligned_signed.apk为进行混淆并签名过的apk，双击查看该apk:

image image

可以看到res文件夹变为r，且里面的目录名称都已经是混淆过的。

  到这里为止AndResGuard的使用就已经介绍完毕，如果有不清楚的地方，可以参考我写的demo,demo代码地址：

https://github.com/chaychan/AndResGuardDemo

  对于AndResGuard中的配置有不清楚的地方，可以查看官方文档：

AndResGuard中文文档