用好Android组件化开发，让你编译“飞”起来

配置缓存：大幅缩短 Android 多模块项目的编译时间

在大型 Android 项目中，模块数量的不断增加会导致配置阶段编译耗时严重。这时，configuration-cache 便应运而生，它可以显著缩短编译时间，提高开发效率。

什么是 configuration-cache？

configuration-cache 是一种缓存机制，它将配置阶段的结果存储在磁盘上。在后续增量编译中，它会检查磁盘缓存，如果发现缓存结果可用，则直接使用缓存，避免重新执行耗时的配置阶段。

configuration-cache 的工作原理

configuration-cache 遵循以下步骤工作：

1. 配置阶段缓存： 在配置阶段，configuration-cache 将结果存储在磁盘上的指定位置。
2. 增量编译检查： 在增量编译时，configuration-cache 会首先检查磁盘上的缓存文件。
3. 缓存命中： 如果缓存文件中存在与当前增量编译相匹配的配置结果，configuration-cache 将直接使用缓存结果，跳过配置阶段。
4. 缓存未命中： 如果缓存文件中没有匹配的配置结果，configuration-cache 将执行配置阶段，并将结果存储在缓存文件中供下次使用。

configuration-cache 的优点

configuration-cache 提供了以下好处：

• 大幅缩短编译时间： 通过缓存配置阶段的结果，configuration-cache 可以将编译时间从数十秒缩短到几秒甚至更短。
• 提高开发效率： 更短的编译时间让开发者可以专注于编码，而无需等待漫长的编译过程。
• 减少资源消耗： 避免重新执行配置阶段可以节省 CPU 和内存资源，使计算机运行更加流畅。

configuration-cache 的缺点

configuration-cache 也有一些潜在缺点：

• 增加磁盘空间使用： 缓存配置结果会占用磁盘空间。
• 可能导致编译结果不一致： 如果在编译过程中修改了源代码，缓存中的配置结果可能不再准确，导致编译结果不一致。

如何使用 configuration-cache？

在 Android 项目中使用 configuration-cache，只需在 build.gradle 文件中添加以下代码：

android {
  ...
  buildFeatures {
    buildConfigCache = true
  }
  ...
}

添加上述代码后，configuration-cache 将自动启用。

注意事项

使用 configuration-cache 时，请注意以下几点：

• configuration-cache 仅适用于增量编译，在完全编译时无效。
• configuration-cache 仅适用于 Android Gradle Plugin 版本 3.6.0 及更高版本。
• 如果在编译过程中修改了源代码，缓存中的配置结果可能不再准确，导致编译结果不一致。

结论

configuration-cache 是 Android Gradle Plugin 中一项强大的功能，它可以显著缩短编译时间，提高开发效率。对于使用组件化多模块开发的大型 Android 项目，强烈建议使用 configuration-cache 以优化编译流程。

常见问题解答

1. configuration-cache 如何影响构建过程的其他阶段？

configuration-cache 仅缓存配置阶段的结果。构建过程的其他阶段，例如编译和链接，不受影响。

2. 使用 configuration-cache 有哪些最佳实践？

• 仅在组件化多模块项目中使用 configuration-cache。
• 确保在 clean 构建后重新启用 configuration-cache。
• 定期清除 configuration-cache，以避免磁盘空间占用过多。

3. 我如何禁用 configuration-cache？

要在 build.gradle 文件中禁用 configuration-cache，请将 buildConfigCache 设置为 false。

4. configuration-cache 可以加快完全编译吗？

不，configuration-cache 仅适用于增量编译。在完全编译时，configuration-cache 无效。

5. configuration-cache 是否会导致构建工件损坏？

只有当在编译过程中修改了源代码时，configuration-cache 才可能导致构建工件损坏。