Compose Destinations 项目中共享带工厂的 ViewModel 实践

背景介绍

在 Android 开发中，使用 Jetpack Compose 进行导航时，Compose Destinations 是一个流行的导航库。在实际开发中，我们经常需要在多个屏幕间共享 ViewModel，特别是当 ViewModel 需要通过工厂模式初始化时，会遇到一些特殊场景。

核心问题

当我们需要在多个目的地（destination）之间共享 ViewModel，并且这个 ViewModel 需要通过工厂模式初始化（例如需要传入初始数据）时，传统的共享 ViewModel 方法可能不够用。初始数据通常来自第一个使用该 ViewModel 的屏幕的导航参数。

解决方案分析

基础方案

Compose Destinations 官方文档提供了在多个目的地间共享 ViewModel 的基本方法，但对于需要工厂模式初始化的场景，开发者需要自行扩展。

自定义 ViewModelStoreOwner

一种可行的解决方案是创建一个自定义的 ViewModelStoreOwner 包装器：

@JvmInline
value class NavGraphViewModelStoreOwner(val value: ViewModelStoreOwner) : ViewModelStoreOwner by value

然后在 NavHost 的依赖容器中注册：

dependenciesContainerBuilder = {
    dependency(NavGraphs.loggedIn) {
        NavGraphViewModelStoreOwner(remember(navBackStackEntry) {
            navController.getBackStackEntry(NavGraphs.loggedIn.route)
        })
    }
}

在目的地中使用

在需要共享 ViewModel 的屏幕中，可以这样使用：

@Destination
@Composable
fun SecondScreen(
    initialData: InitialData,
    navGraphViewModelStoreOwner: NavGraphViewModelStoreOwner
) {
    val viewModel = viewModel<SomeViewModel>(
        key = "somekey",
        viewModelStoreOwner = navGraphViewModelStoreOwner,
        factory = viewModelFactory {
            SomeViewModel(initialData = initialData)
        }
    )
}

后续屏幕可以直接访问同一个 ViewModel 实例，无需再次提供工厂。

更优方案

仓库所有者建议，如果所有屏幕都期望相同类型的参数，可以在依赖容器构建时直接创建 ViewModel：

destination(ProfileScreenDestination) {
    val args: ProfileScreenNavArgs = navArgs as ProfileScreenNavArgs
    dependency(viewModel<ProfileViewModel>())
}

未来版本将改进类型安全，无需强制转换：

destination(ProfileScreenDestination) {
    val args: ProfileScreenNavArgs = navArgs // 类型安全
    dependency(viewModel<ProfileViewModel>())
}

最佳实践建议

1. 评估需求：确定是否真的需要在多个屏幕间共享 ViewModel，避免不必要的共享
2. 参数一致性：确保所有使用共享 ViewModel 的屏幕都期望相同类型的初始数据
3. 类型安全：等待库更新以获得更好的类型安全支持
4. 生命周期管理：理解共享 ViewModel 的生命周期与导航图的关系

总结

在 Compose Destinations 中共享需要工厂初始化的 ViewModel 需要一些额外工作，但通过自定义 ViewModelStoreOwner 或在依赖容器中提前创建 ViewModel 都能实现这一需求。随着库的更新，这一过程将变得更加简洁和安全。开发者应根据具体场景选择最适合的方案，同时注意 ViewModel 的生命周期管理。