使用融合库将多个 Android 库发布为一个库

在包含多个模块的项目中,在尝试保持清晰的项目结构的同时,向用户分发 Android 库可能并非易事。在许多情况下,需要发布的库数量比预期多得多。

与 Android Gradle 插件捆绑的 Fused Library 插件可帮助您将多个 Android 库模块打包到单个可发布的 Android 库中。这样,您就可以根据需要在 build 中对库的源代码和资源进行模块化处理,同时避免在分发后公开项目的结构。

以单个库的形式分发具有以下优势:

  • 简化了依赖项:将多个库依赖项替换为单个 AAR,为用户简化了项目设置和版本管理
  • 缩减了库大小:可能会改进代码缩减,从而缩减 AAR 的大小
  • 增强了安全性:可以更好地控制已发布库的内部实现细节

创建融合库

如需构建融合库,您必须创建新的 Android 模块、添加依赖项,然后发布融合库。

添加新的融合库模块

如需使用该插件,您必须向项目添加新的 Android 模块:

在此示例中,合并的库模块将被称为 myFusedLibrary

  1. 通过将 android.experimental.fusedLibrarySupport=true 添加到 gradle.properties 文件,启用融合库支持。
  2. include(":myFusedLibrary") 附加到 settings.gradle.kts 文件。
  3. gradle/libs.versions.toml 文件的 [plugins] 部分下添加 android-fusedlibrary = { id = "com.android.fused-library", version.ref = "agp" }
  4. 在顶级 build.gradle.kts 文件的“plugins”块中添加 alias(libs.plugins.android.fusedlibrary) apply false
  5. 如需创建 myFusedLibrary 模块,请创建一个名为 myFusedLibrary 的新目录(右键点击“我的应用”>“新建”>“目录”)。
  6. myFusedLibrary 模块中创建 build.gradle.kts 文件(右键点击 myFusedLibrary 模块 > 新建 > 文件)。
  7. 将以下内容粘贴到 myFusedLibrary/build.gradle.kts 文件中:

Kotlin

plugins {
    alias(libs.plugins.android.fusedlibrary)
    `maven-publish`
}

androidFusedLibrary {
    namespace = "com.example.myFusedLibrary"
    minSdk = 21
}

dependencies { }

Groovy

plugins {
    id 'fused-library'
}

androidFusedLibrary {
    namespace 'com.example.myFusedLibrary'
    minSdk 21
}

dependencies {

}

添加依赖项

融合库的核心功能是捆绑依赖项。该插件支持添加本地项目依赖项和外部库。如需指定要打包的依赖项,请使用 include 配置。传递依赖项不会打包。

例如:

Kotlin

dependencies {
    include(project(":image-rendering"))
    include("mycoolfonts:font-wingdings:5.0")
}

Groovy

dependencies {
    include project(':image-rendering')
    include 'mycoolfonts:font-wingdings:5.0'
}

发布融合库

在发布融合库之前,您应先熟悉如何发布 Android 库。发布融合型库与发布 Android 库类似,但在正确发布融合型库时,您必须考虑一些关键区别:

  • 必须将 Maven Publish 插件应用于应用了 Fused Library 插件的任何模块。
  • 该发布版本必须继承自 fusedLibraryComponent,因为这提供了编译融合库工件所需的依赖项。

以下是出版物配置示例:

Kotlin

plugins {
    alias(libs.plugins.android.fusedlibrary)
    `maven-publish`
}

androidFusedLibrary {  }

dependencies {  }

publishing {
    publications {
        register<MavenPublication>("release") {
             groupId = "my-company"
             artifactId = "my-fused-library"
             version = "1.0"
             from(components["fusedLibraryComponent"])
        }
    }
}

Groovy

plugins {
    id 'fused-library'
    id 'maven-publish'
}

androidFusedLibrary {  }

dependencies {  }

publishing {
    publications {
        release(MavenPublication) {
            groupId = "my-company"
            artifactId = "my-fused-library"
            version = "1.0"
            afterEvaluate {
            from components.fusedLibraryComponent
        }
    }
}

发布要进行测试的融合库

您应根据 Android 应用或 Android 库中的已发布合并库进行测试。建议的方法是将合并的库及其项目依赖项发布到本地 Maven 制品库。

如需将融合型库工件发布到本地代码库,请定义类似于以下内容的配置:

Kotlin

plugins {
    alias(libs.plugins.android.fusedlibrary)
    `maven-publish`
}

repositories {
    maven {
        name = "myLocalRepo"
        url = uri(layout.buildDirectory.dir("myLocalRepo"))
    }
}

Groovy

plugins {
    id 'fused-library'
    id 'maven-publish'
}

repositories {
    maven {
        name 'myLocalRepo'
        url layout.buildDirectory.dir('myLocalRepo')
    }
}

上传您的合并库

如需分发您的合并库,请参阅上传库

行为和保护措施

组合 Android 库存在复杂性,这可能会使插件难以推理优先级。例如,如果两个库具有相同的类路径,则会在合并库时导致构建失败。在不同库中选择同名资源时,资源合并会考虑指定的依赖项顺序。

  • 为了添加为依赖项,合并的库只能发布为 Android 库工件 AAR。
  • 不支持合并使用数据绑定的库。
  • 您无法在单个融合库中融合多个 build 类型和产品变种。为不同的变体创建单独的融合库。

为了平衡所需的配置量和易用性,该插件会在出现模糊冲突时使构建失败,或者在合并工件时使用启发词语。如需详细了解工件如何融合,请参阅下表:

类型 行为
具有相同类路径的库在合并时会导致构建失败。
Android资源 资源合并会在选择不同模块中具有相同名称的资源时考虑指定的依赖项顺序。
AAR 元数据 AAR 元数据版本的合并方式是,优先考虑每个依赖项库中的最高值。系统提供了一个 DSL 来替换这些值。

Kotlin

 androidFusedLibrary { aarMetadata { minCompileSdk = 21 minCompileSdkExtension = 1 } }
Java 资源 不允许多个库中存在路径相同的 Java 资源文件,否则会导致构建失败。

已知问题

融合库是一个新插件,我们正在解决一些已知问题,以实现所有用例。

  • 合并的 AAR 中未包含 lint.jar 文件
  • 向其他 .aar 文件添加文件依赖项
  • 不支持合并 RenderScript 和 Prefab 工件

了解融合库的依赖项

该合并库没有来源,并且实际上将 Android 库用作其唯一来源,因此了解各个来源非常重要。如需列出合并到生成工件中的依赖项以及构建工件所需的依赖项,请对合并的库运行 gradle :report 任务。这些任务会生成一个 JSON 报告,并将其保存在融合库的 build/reports 目录中。

如需了解与内部插件依赖项相关的更多信息,请运行 gradle :dependencies 任务以查看插件配置的状态。