Compose Destinations 中 BottomSheet 导航的迁移指南

背景介绍

在 Android 开发中，Compose Destinations 是一个流行的导航库，它简化了 Jetpack Compose 中的导航逻辑。随着 Compose 1.7 版本的发布，BottomSheet 导航的实现方式发生了变化，从原来的 Accompanist 迁移到了官方的 Material 组件中。

问题现象

开发者在使用 Compose Destinations 时可能会遇到以下错误：

java.lang.IllegalStateException: Could not find Navigator with name "BottomSheetNavigator". You must call NavController.addNavigator() for each navigation type.

这个错误表明导航控制器无法找到 BottomSheet 导航器，通常是因为版本不匹配或依赖配置不正确导致的。

解决方案

1. 更新依赖版本

首先需要确保使用的是兼容的版本组合：

• Compose UI 版本至少需要 1.7.0-beta
• Compose Destinations 版本需要 1.11.5-beta 或更高

2. 正确配置依赖

在 build.gradle 文件中应该这样配置：

// Compose 基础依赖
def compose_version = "1.7.0-beta06"
implementation "androidx.compose.ui:ui:$compose_version"
implementation "androidx.compose.material:material:$compose_version"
implementation "androidx.compose.foundation:foundation:$compose_version"

// Compose Destinations
def compose_destinations_version = "1.11.5-beta"
implementation "io.github.raamcosta.compose-destinations:animations-core:$compose_destinations_version"
ksp "io.github.raamcosta.compose-destinations:ksp:$compose_destinations_version"

3. 使用正确的 BottomSheet 组件

新的 Material 组件提供了专门的 BottomSheet 导航支持：

androidx.compose.material.navigation.ModalBottomSheetLayout(
    bottomSheetNavigator = bottomSheetNavigator,
    modifier = Modifier,
    // 其他参数...
) {
    // 内容
}

迁移注意事项

1. 不要直接依赖 navigation-material：Compose Destinations 会提供必要的导航 Material 依赖作为传递依赖，直接添加可能会导致冲突。

2. API 变化：新的 BottomSheet 导航 API 与 Accompanist 版本有所不同，需要调整参数传递方式。

3. 状态管理：新的实现使用了不同的状态管理机制，需要重新学习如何处理 BottomSheet 的显示/隐藏状态。

最佳实践

1. 始终使用最新稳定版的 Compose 和 Compose Destinations。

2. 在迁移时，先在一个简单的示例项目中测试新的导航方式，确保理解其工作原理。

3. 考虑创建一个封装组件，将 BottomSheet 导航的具体实现细节隐藏起来，使业务代码不受未来 API 变化的影响。

总结

从 Accompanist 迁移到官方的 Material BottomSheet 导航是一个积极的改变，虽然短期内可能需要一些调整，但长期来看能获得更好的兼容性和维护性。通过正确配置依赖版本和使用新的 API，开发者可以顺利实现 BottomSheet 导航功能。