使用物料清单

Compose 物料清单 (BOM) 允许您通过仅指定 BOM 的版本来管理所有 Compose 库版本。BOM 本身包含指向不同 Compose 库稳定版本的链接,以便它们能够良好地协同工作。在您的应用中使用 BOM 时,无需在 Compose 库依赖项本身添加任何版本。当您更新 BOM 版本时,您正在使用的所有库都会自动更新到其新版本。

Kotlin

dependencies {
    // Specify the Compose BOM with a version definition
    val composeBom = platform("androidx.compose:compose-bom:2024.10.01")
    implementation(composeBom)
    testImplementation(composeBom)
    androidTestImplementation(composeBom)

    // Specify Compose library dependencies without a version definition
    implementation("androidx.compose.foundation:foundation")
    // ..
    testImplementation("androidx.compose.ui:ui-test-junit4")
    // ..
    androidTestImplementation("androidx.compose.ui:ui-test")
}

Groovy

dependencies {
    // Specify the Compose BOM with a version definition
    Dependency composeBom = platform('androidx.compose:compose-bom:2024.10.01')
    implementation composeBom
    testImplementation composeBom
    androidTestImplementation composeBom

    // Specify Compose library dependencies without a version definition
    implementation 'androidx.compose.foundation:foundation'
    // ..
    testImplementation 'androidx.compose.ui:ui-test-junit4'
    // ..
    androidTestImplementation 'androidx.compose.ui:ui-test'
}

要了解哪些 Compose 库版本映射到特定 BOM 版本,请查看BOM 到库版本映射

为什么 BOM 中不包含 Compose Compiler 库?

Compose Kotlin 编译器扩展 (androidx.compose.compiler) 未链接到 Compose 库版本。相反,它链接到 Kotlin 编译器插件的版本,并以与 Compose 其余部分不同的节奏发布。

从 Kotlin 2.0 开始,Compose appcompiler 与 Kotlin 编译器一起管理,并使用与 Kotlin 编译器相同的版本。有关配置详细信息,请参阅Compose Compiler Gradle 插件

在 Kotlin 2.0 之前,您需要确保使用与您的 Kotlin 版本兼容的版本。您可以在Compose 到 Kotlin 兼容性映射中找到映射到每个插件版本的 Kotlin 版本,以及如何在Compose Compiler中进行配置。

如何使用与 BOM 中指定的不同的库版本?

build.gradle依赖项部分,保留 BOM 平台的导入。在库依赖项导入中,指定覆盖版本。例如,以下是如何声明依赖项,如果您想使用动画库的较新版本,无论 BOM 中指定哪个版本

Kotlin

dependencies {
    // Specify the Compose BOM with a version definition
    val composeBom = platform("androidx.compose:compose-bom:2024.10.01")
    implementation(composeBom)

    // Override the BOM version when needed
    implementation("androidx.compose.animation:animation:1.8.0-alpha05")

    // ..
}

Groovy

dependencies {
    // Specify the Compose BOM with a version definition
    Dependency composeBom = platform("androidx.compose:compose-bom:2024.10.01")
    implementation composeBom

    // Override the BOM version when needed
    implementation 'androidx.compose.animation:animation:1.8.0-alpha05'

    // ..
}

BOM 是否会自动将所有 Compose 库添加到我的应用?

不会。要实际在您的应用中添加和使用 Compose 库,您必须在模块(应用级)Gradle 文件(通常为 app/build.gradle)中将每个库声明为单独的依赖项行。

使用 BOM 可确保应用中任何 Compose 库的版本兼容,但 BOM 实际上不会将这些 Compose 库添加到您的应用中。

未来,Compose 库将独立版本化,这意味着版本号将开始以自己的速度递增。每个库的最新稳定版本都经过一起测试。但是,查找每个库的最新稳定版本可能很困难,而 BOM 可以帮助您自动使用这些最新版本。

我是否必须使用 BOM?

不。您仍然可以选择手动添加每个依赖项版本。但是,我们建议您使用 BOM,因为它将使您更容易同时使用所有最新的稳定版本。

BOM 是否与版本目录一起使用?

是的。您可以将 BOM 本身包含在版本目录中,并省略其他 Compose 库版本

[libraries]
androidx-compose-bom = { group = "androidx.compose", name = "compose-bom", version.ref = "androidxComposeBom" }
androidx-compose-foundation = { group = "androidx.compose.foundation", name = "foundation" }

不要忘记在模块的build.gradle中导入 BOM

Kotlin

dependencies {
    val composeBom = platform(libs.androidx.compose.bom)
    implementation(composeBom)
    androidTestImplementation(composeBom)

    // import Compose dependencies as usual
}

Groovy

dependencies {
    Dependency composeBom = platform(libs.androidx.compose.bom)
    implementation composeBom
    androidTestImplementation(composeBom)

    // import Compose dependencies as usual
}

如果我想试用 Compose 库的 alpha 或 beta 版本怎么办?

有三个可用的 Compose BOM。每个 BOM 都是 Compose 库最新可用版本的某个时间点的快照。

  • 稳定版 - 包含每个库的最新稳定版本
  • Beta 版 - 包含每个库的最新 Beta 版、候选发布版 (RC) 或稳定版本
  • Alpha 版 - 包含每个库的最新 Alpha 版、Beta 版、RC 版或稳定版本

Alpha 版和 Beta 版的 BOM 是通过在 BOM 工件名称中添加-alpha-beta来指定的。稳定版没有后缀。

Kotlin

dependencies {
    // Specify the Compose BOM with a version definition
    val composeBom = platform("androidx.compose:compose-bom-alpha:2024.10.01")
    //            or platform("androidx.compose:compose-bom-beta:2024.10.01")
    implementation(composeBom)
    // ..
}

Groovy

dependencies {
    // Specify the Compose BOM with a version definition
    Dependency composeBom = platform('androidx.compose:compose-bom-alpha:2024.10.01')
    //                   or platform('androidx.compose:compose-bom-beta:2024.10.01')
    implementation composeBom
    // ..
}

如何报告问题或提供有关 BOM 的反馈?

您可以在我们的问题跟踪器上提交问题。