缩减代码和资源（Shrink Your Code and Resources）

2023年4月5日 233次阅读 来源: 抹香君

原文链接：https://developer.android.com/studio/build/shrink-code.html

一、代码缩减和资源缩减概述

为尽可能缩减apk包的大小，我们应该在release版本中移除未使用的代码和资源。这篇文档描述如何在构建过程中指定保留和移除的代码与资源。
代码缩减（Code shrinking）利用ProGuard ，它可以检测和移除app中没有使用的类、字段、方法和属性，包括来自代码库的那些。ProGuard还可以优化class文件，删除未使用的代码指令，并使用短名称来混淆类字段和方法。
资源缩减（Resource shrinking）可利用Gradle配置，它可以移除app中未使用的资源，包括代码库中未使用的资源。它与代码缩减一起工作，使得一旦未使用的代码被移除，任何不再被引用的资源也可以被安全地移除。
本文档中的功能依赖于：

二、代码缩减（Shrink Your Code）

1.启用代码缩减

要使用ProGuard启用代码缩减，请将minifyEnabled true添加到build.gradle文件中的相应build type。
注意，代码缩减会减慢构建时间，因此，尽量避免在dbeug版本上使用它。不过重要的是，必须在在启用代码缩减的apk上进行测试，因为如果没有足够自定义要保留的代码，它可能会引入错误。
代码缩减gradle配置示例：

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

除了指定minifyEnabled属性，proguardFiles属性还定义了ProGuard规则：

  • getDefaultProguardFile（’proguard-android.txt’）从SDK tools /proguard /下的proguard-android.txt设置默认的ProGuard设置。
    （备注：为更好地代码缩减，可以利用位于相同位置的proguard-android-optimize.txt文件。 它包括相同的ProGuard规则，但在执行分析字节码级别等方面进一步优化，可以更好地减少apk大小，并帮助它运行更快。）
  • proguard-rules.pro中可以添加自定义ProGuard规则。默认情况下，此文件位于module的根目录（在build.gradle文件旁边）。

我们也可以为不同的Variant指定不同的ProGuard规则：

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

项目构建后，在/build/outputs/mapping/release/下会生成几个文件：

  • dump.txt：apk文件中所有类文件间的内部结构
  • mapping.txt：混淆前后代码间的映射
  • seeds.txt：未被混淆的类和成员
  • usage.txt：未使用的、被apk删除的代码

2.定义保留哪些代码

大多数情况下，默认的ProGuard配置文件（proguard-android.txt）就足够了，ProGuard删除所有未使用的代码。然而，有些情况下，ProGuard很难正确分析，它可能会删除您的应用程序实际需要的代码。比如：

  • 当仅在AndroidManifest.xml文件中引用的类
  • 当从JNI调用方法时
  • 当在字节码中操作代码时（如使用反射）
    为修复错误并强制ProGuard保留某些代码，需要在ProGuard配置文件中添加一个-keep标记，比如：

-keep public class MyClass

或者，您可以将@Keep注释添加到要保留的代码。请注意，此注释仅在使用注释支持库时可用。
使用-keep选项时，您应该考虑许多因素;有关自定义配置文件的更多信息，请阅读 ProGuard手册。

3.解析混淆后的堆栈跟踪（Stack trace）

ProGuard缩减代码后，读取堆栈跟踪是很困难的，因为方法名都被混淆处理了。幸运的是，ProGuard在构建过程中创建了mapping.txt作为混淆前后代码的映射。
由于mapping.txt在每次构建过程中会被重写，所以需要在每个版本对应的mapping.txt保存到对应的目录下。如果用户从旧版本app提交混淆的堆栈跟踪，我们就可以通过每个版本对应的mapping.txt，来调试问题。
当我们在应用商店发布app时，也可以将对应的mapping.txt提交上去，这样应用商店就可以将用户报告的问题中直接进行解析。
要将混淆的堆栈跟踪转换为可读的堆栈跟踪，请使用回溯脚本（Windows上为retrace.bat;Mac上为retrace.sh）。 它位于 / tools / proguard /目录中。该脚本采用mapping.txt文件和堆栈跟踪，产生一个新的、可读的堆栈跟踪。
使用retrace.bat的语法：

retrace.bat|retrace.sh [-verbose] mapping.txt []

例如：

retrace.bat -verbose mapping.txt obfuscated_trace.txt

三、资源缩减（Shrink Your Resources）

1.启用资源缩减

资源缩减必须与代码缩减相结合。代码缩减移除所有未使用的代码后，资源缩减器可以识别应用程序仍在使用哪些资源。 未被使用的资源，将会被资源缩减器移除。
为使用资源缩减，需要在gradle文件中设置shrinkResources属性，例如：

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

注意，资源缩减不会移除value文件下的资源（比如strings, dimensions, styles, and colors），aapt不允许gradle这样做。

2.指定保留哪些资源

对于一些你希望保留或移除的资源，可以创建一个xml文件，以resource为标签，通过tools:keep和tools:discard指定要保留和要移除的资源，多个资源之间以逗号分隔。例如：

tools:keep="@layout/l_used*_c,@layout/l_used_a,@layout/l_used_b*"
tools:discard="@layout/unused2" />

将此文件保存在项目资源中，比如res/raw/keep.xml，构建时不会将该文件打包到apk中。
指定要移除的资源，比起来直接删除掉，似乎有些傻。但是，对于构建多个Variant，却是很有用的。我们可以为不同的变体指定不同的keep.xml。

3.启用严格引用检查

通常，资源缩减器能够判断出指定资源是否被使用。但是，如果你的代码调用了Resources.getIdentifier()（或者你的库中的任何一个，比如AppCompat库），这意味着你的代码是基于动态生成的字符串查找资源名称。这样操作时，资源缩小器默认情况下会防御性地运行，并将匹配名称格式的所有资源标记为可能已使用而不会去移除。
例如，以下代码会将所有带有img_前缀的资源标记为已使用。

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

资源缩小器还查看代码中的所有字符串常量以及各种res / raw /资源，以类似于file：///android_res/drawable//ic_plus_anim_016.png的格式查找资源url。如果它发现类似这样的字符串或其他，也不会移除它们。
这些是默认情况下启用的安全缩减模式的示例。但是，当不关注#“better safe than sorry”#时，可以指定资源缩减器仅保留其确定使用的资源。为此，请在keep.xml文件中将shrinkMode设置为strict，如下所示：

tools:shrinkMode=”strict” />

如果您启用了严格缩减模式，并且您的代码还引用了具有动态生成的字符串的资源，那么您必须使通过tools:keep手动保留这些资源。

4.移除带有选择性的资源

资源缩减器只会移除没有在代码中被引用的资源，这也意味着，它不会移除那些为不同设备配置的带有选择性质的资源。必要的情况下，可以利用resConfigs属性移除这些资源。
例如，如果您使用的库包含语言资源，则apk会包含这些库中的所有翻译语言字符串。如果您只想保留指定的语言，可以使用resConfig属性进行指定，并将删除未指定语言的任何资源。
以下代码段显示了如何将语言资源仅限英语和法语：

android {
  defaultConfig {
  ... ...
    resConfigs“en”，“fr”
  }
}

同样，您可以自定义要在apk中包含哪些屏幕密度或ABI资源，并为不同设备构建不同的apk。

5.合并重复的资源

这里的合并英文为merge，带有解决冲突的意思。
默认情况下，gradle会合并相同名称的资源，例如可能在不同资源文件夹中具有相同名称的drawable。 此行为不受shrinkResources属性控制，不能禁用，因为必须避免在多个资源与代码查找的名称匹配时出现错误。
仅当两个或多个文件共享相同的资源名称时，才会进行资源合并。gradle选择哪个文件被认为是重复项中的最佳选择（基于下面描述的优先级顺序），并且仅将那个资源传递给aapt以在apk中分发。
gradle在以下位置查找重复的资源：

  • main resources，与主源集相关，一般位于src / main / res /。
  • 变体覆盖，从the build type和build flavors。
  • 库项目依赖项。
    gradle在以下优先级顺序中合并重复资源：

Dependencies→Main→Build flavor→Build type

例如，如果重复资源出现在main resources和build flavor,gradle会选择build flavor中的。

6.资源合并描述文件

当缩减资源时，Gradle Console会显示从应用程序包中删除的资源的摘要。例如：

:android:shrinkDebugResources
Removed unused resources: Binary resource data reduced from 2570KB to 1711KB: Removed 33%
:android:validateDebugSigning

gradle还会在/build/outputs/mapping/release/创建一个文件resources.txt，来描述哪些资源被引用和被移除。

    原文作者：抹香君
    原文地址: https://www.jianshu.com/p/46560895b42c
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞