Android修炼系列（27）：fat-aar 下的aar 合并的坑

2024-01-27 19:03:16

前言

在 Android 项目开发中，我们经常需要使用第三方库或模块来实现特定的功能。这些库或模块通常以 aar（Android Archive）的形式提供。当我们的项目需要同时使用多个 aar 时，就需要将这些 aar 合并成一个 fat-aar 对外提供。这样可以避免项目中出现大量的 aar 文件，导致项目结构混乱和编译速度下降。

fat-aar 的 aar 合并过程看似简单，但实际上却暗藏着一些坑。如果不注意这些坑，可能会导致项目编译失败、运行异常等问题。本文将详细介绍 fat-aar 下 aar 合并的常见坑，并提供相应的解决方案，帮助开发者避免这些问题。

坑 1：资源冲突

当合并多个 aar 时，可能会出现资源冲突的问题。例如，多个 aar 中可能存在相同的资源文件，如布局文件、图片资源等。这种情况下，aar 合并工具会以最后一个合并的 aar 中的资源为准，覆盖之前合并的 aar 中的同名资源。

解决方案：

为了避免资源冲突，开发者可以采用以下几种方法：

使用资源前缀： 为每个 aar 中的资源添加一个唯一的资源前缀。例如，aarA中的资源使用前缀"aarA_”，而aarB中的资源使用前缀“aarB_"。这样可以确保不同 aar 中的同名资源不会冲突。
使用资源过滤： 使用 aar 合并工具提供的资源过滤功能，将不需要的资源排除在外。例如，可以使用<resources>标签过滤掉不需要的布局文件或图片资源。
使用aar 合并工具的资源重命名功能： 有些 aar 合并工具提供了资源重命名功能。开发者可以使用该功能为不同 aar 中的同名资源重命名，从而避免冲突。

坑 2：清单文件合并冲突

aar 的清单文件（AndroidManifest.xml）中定义了组件、权限、意图过滤器等信息。当合并多个 aar 时，可能会出现清单文件合并冲突的问题。例如，多个 aar 中可能存在相同的组件或相同的意图过滤器，这会导致项目编译失败。

解决方案：

为了避免清单文件合并冲突，开发者可以采用以下几种方法：

使用aar 合并工具的清单文件合并策略： aar 合并工具通常提供多种清单文件合并策略，例如“覆盖策略”、“合并策略”等。开发者可以选择合适的策略进行清单文件合并。
手动合并清单文件： 开发者可以手动将多个 aar 的清单文件合并成一个新的清单文件。在合并过程中，需要特别注意组件、权限、意图过滤器等信息的合并，避免出现冲突。
使用第三方工具辅助清单文件合并： 有些第三方工具可以辅助清单文件合并，例如“MergeManifest 工具”。这些工具可以自动合并多个清单文件，并解决冲突问题。

坑 3：依赖冲突

当合并多个 aar 时，可能会出现依赖冲突的问题。例如，多个 aar 可能依赖相同的第三方库，但版本不同。这种情况下，aar 合并工具会选择最新版本的第三方库，并删除其他版本的第三方库。如果项目中其他模块依赖了旧版本的第三方库，则可能会导致项目编译失败。

解决方案：

为了避免依赖冲突，开发者可以采用以下几种方法：

使用统一的第三方库版本： 要求所有 aar 都使用统一的第三方库版本。这样可以避免依赖冲突问题。
使用依赖管理工具： 使用依赖管理工具，如Gradle 的依赖树视图或第三方依赖管理工具。这些工具可以帮助开发者查看项目的依赖关系，并发现潜在的依赖冲突。
手动修改aar 的依赖关系： 开发者可以手动修改 aar 的依赖关系，将冲突的依赖项排除在外。这种方法比较复杂，需要开发者对 aar 的依赖关系有深入的了解。

坑 4：命名空间冲突

当合并多个 aar 时，可能会出现命名空间冲突的问题。例如，多个 aar 中可能存在相同的包名或类名。这种情况下，aar 合并工具会自动为冲突的元素生成新的包名或类名。如果生成的包名或类名与项目中其他元素冲突，则可能会导致项目编译失败或运行异常。

解决方案：

为了避免命名空间冲突，开发者可以采用以下几种方法：

使用 aar 合并工具的命名空间重命名功能： aar 合并工具通常提供命名空间重命名功能。开发者可以使用该功能为冲突的元素重命名，从而避免冲突。
手动重命名 aar 中的包名或类名： 开发者可以手动重命名 aar 中的包名或类名，使其与项目中其他元素不冲突。这种方法比较复杂，需要开发者对 aar 的内部结构有深入的了解。
使用第三方工具辅助命名空间重命名： 有些第三方工具可以辅助命名空间重命名，例如“MergeAar 工具”。这些工具可以自动重命名冲突的元素，并解决命名空间冲突问题。