Android Gradle必备使用技巧,未完待续,欢迎关注公众号flysnow_org,第一时间看后续技巧。

随着工程越来越大,功能越来越多,开发人员越来越多,代码越来越复杂,不可避免的会产生一些不在使用的资源,这类资源如果没有清理的话,会增加我们Apk的包大小,也会增加构建的时候。

要清理这些无用的资源,第一个办法是我们在开发的过程中,把不再使用的资源清理掉,这个靠开发人员的自觉以及对程序代码逻辑的了解成都,而且清理成本也比较大。

第二个办法是使用Android Lint,它会帮我们检测出哪些资源没有被使用,然后我们按照检测出来的列表清理即可,这种办法需要我们隔一段时间就要清理一次,不然就可能会有无用的资源遗留,做不到及时性。

以上两个方式还有一个不能解决的问题,他就是第三方库里的资源的问题。如果你引用的第三方库里也含有无用的资源,那么这两种办法都不能做到清理他们,因为他们被打包在第三方库里,没有办法做删除。

针对以上情况,Android Gradle为我们提供了在构建打包时自动清理掉未使用资源的方法,这个就是Resource Shrinking。他是一种在构建时,打包成Apk之前,会检测所有资源,看看是否被引用,如果没有,那么这些资源就不会被打包到Apk包中.

因为是在这个过程中(构建时),Android Gradle构建系统会拿到所有的资源,不管是你项目自己的,还是引用的第三方的,它都一视同仁的处理,所以这个时机点可以控制哪些资源可以被打包,所以能解决第三方不使用的资源的问题。

比如我们常用的Google Play Service,这个是一个比较大的库,它支持很多Google的服务,比如Google Drive,Google Sign In等等,如果你在你的应用中只使用了Google Drive这个服务,并没有使用到Google Sign In服务,那么在构建打包的时候,会自动的处理Google Sign In功能相关的无用资源图片。

Resource Shrinking要结合着Code Shrinking一起使用,什么是Code Shrinking呢?就是我们经常使用的ProGuard,也就是我们要启用minifyEnabled,是为了缩减代码的;

我们上面已经讲了,自动清理未使用的资源的原理很简单,就是判断有没有用到这些资源,如果你的代码还在使用,那么自然不会被清理,所以要和代码清理结合使用,先清理掉无用的代码,这样这些无用的代码引用的资源才能被清理掉。那么我们如何配置使用呢,看下面的示例,如下Gradle配置来启用Resource Shrinking:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
android {
    compileSdkVersion 23
    buildToolsVersion "23.0.1"

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

启用Resource Shrinking是通过调用BuildType的shrinkResources来设置的,只要给这个方法传递一个true的参数,就可以启用,默认情况下是不启用的。

1
2
3
4
5
6
7
8
/**
 * Whether shrinking of unused resources is enabled.
 *
 * Default is false;
 */
public void shrinkResources(boolean flag) {
    this.shrinkResources = flag;
}

当我们开启了shrinkResources后,打包构建的时候,Android Gradle就会自动的处理未使用的资源,不把他们打包到生成的Apk中,我们可以在我们构建输出的日志中看到处理结果,以我们当前的示例代码为例,我们运行./gradlew :app:assembleRelease 就可以看到如下日志:

1
2
3
4
:app:transformClassesWithDexForRelease
:app:transformClassesWithShrinkResForRelease
Removed unused resources: Binary resource data reduced from 159KB to 29KB: Removed 81%
Note: If necessary, you can disable resource shrinking by adding

从159KB减少到29KB,减少了81%,效果非常显著,当然这是因为我演示的,现实中可能不会减少这么多,但是减少一点是一点。

以前是一个汇总的日志输出,如果你想看详细日志,想知道哪些资源被自动清理了,可以使用–info标记,显示详细的Gradle信息,然后把和自动清理资源的日志过滤出来即可。我们可以通过如下命令实现:

1
./gradlew clean :app:assembleRelease --info | grep "unused resource"

运行后我们可以通过日志输出看到具体的哪些资源被清理了:

1
2
Skipped unused resource res/drawable/unused.jpg: 133399 bytes (replaced with small dummy file of size 0 bytes)
Removed unused resources: Binary resource data reduced from 159KB to 29KB: Removed 81%

自动清理未使用的资源这个功能虽好,但是有时候会误删,为什么呢,因为我们在代码编写的时候可能会使用反射去引用资源文件,尤其很多你引用的第三方库会这么做,这时候Android Gradle就区分不出来了,可能会误认为这些资源没有被使用。针对这中情况,Android Gradle为我们提供了keep方法来让我们配置哪些资源不被清理。

keep方法使用非常简单,我们要新建一个xml文件来配置,这个文件是 res/raw/keep.xml,然后通过tools:keep属性来配置,这个tools:keep接受一个以逗号(,)分割的配置资源列表,并且支持星号(*)通配符。

有没有觉得它和我们用ProGuard的配置文件是一样的,我们在ProGuard配置文件里配置保存一些不被混淆的类也是这么做的。此外,对于res/raw/keep.xml这个文件我们不用担心,Android Gradle构建系统最终打包的时候会清理它,不会把它打包进Apk中的,除非你在代码中通过R.raw.keep引用了它。

以下是res/raw/keep.xml示例,引用自Android Tech Docs

1
2
3
<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@layout/l_used*_c,@layout/l_used_a,@layout/l_used_b*"/>

keep.xml还有一个属性是 tools:shrinkMode,用于配置自动清理资源的模式,默认是safe,是安全的,这种情况下,Android Gradle可以识别代码中类似于如下示例的引用

1
getResources().getIdentifier("unused","drawable",getPackageName());

这类代码也被构建系统认为是使用了资源文件,不会被清理。如果把清理模式改为strict,那么就没有办法识别了,这个资源会被认为没有被引用,也会被清理掉。

除了shrinkResources之外,Android Gradle还为我们 提供了一个resConfigs,它属于ProductFlavor的一个方法,可以让我们配置哪些类型的资源才被打包到Apk中,比如只有中文的,只有hdpi格式的图片等等,这是非常重要的,比如我们引用的第三方库,特别是Support Library 和 Google Play Services这两个主要的大库,因为国际化的问题,他们都支持了几十种语言,但是对于我们的App来说,我们并不需要这么多,比如我们只用中文的语言就可以了,其他的都不需要;比如我们支持hdpi格式的图片就好了,其他的都不需要,这时候我们就可以通过resConfigs方法来配置:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
android {
    compileSdkVersion 23
    buildToolsVersion "23.0.1"

    defaultConfig {
        applicationId "org.flysnow.app"
        minSdkVersion 14
        targetSdkVersion 23
        versionCode 1
        versionName '1.0.0'
        resConfigs 'zh'
    }
}

这样我们就只保留了zh资源,其他非zh资源都不会被打包到Apk文件中。

其实这个resConfig的配置有3中办法,一般常用的是resConfigs这个方法,因为可以同时指定多个配置,你也可以使用resConfig(后面没有s)来指定一个配置,它一次只能添加一个,如果要添加多个,要么调用多次,要么使用resConfigs方法。我们看下他们的方法原型,了解他们的方法原理:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
/**
 * Adds a resource configuration filter.
 *
 * <p>If a qualifier value is passed, then all other resources using a qualifier of the same type
 * but of different value will be ignored from the final packaging of the APK.
 *
 * <p>For instance, specifying 'hdpi', will ignore all resources using mdpi, xhdpi, etc...
 */
public void resConfig(@NonNull String config) {
    addResourceConfiguration(config);
}
  
/**
 * Adds several resource configuration filters.
 *
 * <p>If a qualifier value is passed, then all other resources using a qualifier of the same type
 * but of different value will be ignored from the final packaging of the APK.
 *
 * <p>For instance, specifying 'hdpi', will ignore all resources using mdpi, xhdpi, etc...
 */
public void resConfigs(@NonNull String... config) {
    addResourceConfigurations(config);
}
  
/**
 * Adds several resource configuration filters.
 *
 * <p>If a qualifier value is passed, then all other resources using a qualifier of the same type
 * but of different value will be ignored from the final packaging of the APK.
 *
 * <p>For instance, specifying 'hdpi', will ignore all resources using mdpi, xhdpi, etc...
 */
public void resConfigs(@NonNull Collection<String> config) {
    addResourceConfigurations(config);
}

resConfig的使用非常广泛,它的参数就是我们在Android开发时的资源限定符,不止于我们上面描述的语言和密度,还包括Api Level,分辨率等等,具体的可以参考Android Doc文档。

以上自动清理资源只是在打包的时候,不打包到Apk中,实际上并没有删除我们工程中的资源,如果我们在使用的时候发现有大量的无用资源被清理,那么我们自己最好还是把这些资源文件从我们的工程中删除吧,这样也好维护一些。

Android Gradle必备使用技巧,未完待续,欢迎关注公众号flysnow_org,第一时间看后续技巧。

扫码关注