navGraphViewModel的使用及其与hilt注解库的配合使用

最新推荐文章于 2024-07-28 19:28:13 发布

原创最新推荐文章于 2024-07-28 19:28:13 发布 · 2.9k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#gradle #kotlin #android jetpack #android-studio #android

安卓同时被 2 个专栏收录

6 篇文章

订阅专栏

kotlin

3 篇文章

订阅专栏

这篇博客探讨了如何在Android开发中利用navGraphViewModels在导航图内共享UI相关数据，并在退出时自动销毁。当遇到hilt注解库与navGraphViewModels结合使用时可能出现的问题，如构造函数含有@Inject注解的参数，作者提供了两种解决方案：一是通过@Module提供依赖；二是使用hiltNavGraphViewModels并引入额外库。这两种方法都能确保ViewModel的正确创建和依赖注入。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

navGraphViewModel的使用及其与hilt注解库的配合使用

navGraphViewModel的基本使用

开发文档中是这么描述的：

使用 ViewModel 在目标之间共享与 UI 相关的数据
导航后退堆栈不仅存储每个单独目标的 NavBackStackEntry，还存储包含单个目标的每个父导航图。这允许您检索范围限定为导航图的。导航图形范围提供了一种创建范围限定为导航图形的方法，使你能够在图形的目标之间共享与 UI 相关的数据。以这种方式创建的任何对象都有效，直到关联及其对象被清除，或者直到从后一堆栈中弹出导航图。

具体点来说就是我们可以使用navGraphViewModel来实现在某个嵌套导航图中使用同一个viewModel，并在退出这个嵌套图之后自动销毁viewModel，来实现在嵌套导航图内的fragment之前共享数据

在 fragment 中，可直接使用如下代码创建viewModel：

val viewModel by navGraphViewModels<MainViewModel>(R.id.home)

与hilt结合使用

直接使用上面的方法，如果你的viewModel（例子中的MainViewModel）的构造函数没有参数是可以正常编译并运行的，但是如果有用@Inject注入的参数，那么可能会出现编译会通过，但是在运行时会报错，提示无法创建该viewModel的实例。

这个问题出现的原因是hilt库不支持navGraphViewModels，这个库默认只支持viewModels() 和 activityViewModels()

那这种情况怎么处理呢

方法一：

将注入的参数直接用Module模块提供出来，module的例子如下：

@InstallIn(FragmentComponent::class)
@Module
object MainModule {
    @FragmentScoped
    @Provides
    fun providerMainRepository() = MainRepository()
}

这样就可以直接在fragment中使用navGraphViewModels 了

方法二：

用 hiltNavGraphViewModels 替换 navGraphVIewModels

首先我们需要引入另外一个库

    implementation('androidx.hilt:hilt-navigation-fragment:1.0.0')

之后直接使用如下语句获取viewModel

    val homeViewModel: HomeViewModel by hiltNavGraphViewModels(R.id.nav_home)

当然，必须的注解HiltViewModel 和 AndroidEntryPoint 别忘了。