如何将视图模型范围限定为父片段？

Question

所以我正在使用新的导航组件（具有单一活动原则）并使用共享视图模型在每个片段之间进行通信，但是，我已经到了有时需要清除视图模型但我可以找不到清理它的好地方。但是，我认为与其自己尝试清除它，不如让框架为我做这件事，但这并不是因为视图模型是共享的并限定于活动，但我认为我可以将它们限定为一个父片段，我画了一张图来说明我正在尝试做的事情。 所以当我从“Child 1 Child a”导航回来时，我只想清除 2 个视图模型，目前视图模型永远不会被清除，试图通过在片段中调用“this”来获取当前视图模型，而在孩子中调用 getParentFragment 不起作用，谁能提供一个例子？

编辑

看起来我已经在做类似的事情，但在我的情况下它不起作用，所以我将添加一些代码，这是我如何访问父片段中的第一个视图模型

model = ViewModelProviders.of(this).get(RequestViewModel.class);

然后在子片段中，我正在这样做

requestViewModel = ViewModelProviders.of(getParentFragment()).get(RequestViewModel.class);

但它不会在它们之间保留数据，它们都附有观察者

Answer 1

在您的应用中使用Fragment-ktx libr，您可以获得如下视图模型 在您的应用程序中-> build.gradle

 implementation 'androidx.fragment:fragment-ktx:1.1.0'

// 获取 ParentFragment 中的 ViewModel 为

 private val viewModel: DemoViewModel by viewModels()

// 在 ChildFragment 中获取与

相同的 ViewModel 实例

 private val viewModel: DemoViewModel by viewModels(
    ownerProducer = { requireParentFragment() }
)

Answer 2

好的，所以在父级中使用它

model = ViewModelProviders.of(this).get(RequestViewModel.class);

这在孩子身上

requestViewModel = ViewModelProviders.of(getParentFragment()).get(RequestViewModel.class);

给了我不同的哈希码但相同的 ID，这似乎是因为导航组件，如果我将它们都更改为 getParentFragment 那么它可以工作，所以我认为该组件正在替换片段而不是在此处添加它们，非常感谢致@WadeWilson 和@JeelVankhede

Answer 3

因此，根据 @martin 的 proposed solution 得出，即使在 Parent Fragment 中添加一个/多个片段作为 子， 导航组件为两个片段提供相同的片段管理器。

这意味着即使片段被添加为父子层次结构，它们也会共享来自导航组件的相同片段管理器（可能是这个库中的错误？） & 所以ViewModels 不是由于在子片段内部使用ViewModelProvider 的getParentFragment() 实例时出现这种困境，所以共享。

---

因此，共享ViewModels 的一种快速解决方案是从片段管理器获取父片段的实例，使用下面的行来获取父片段和子片段：

ViewModelProviders.of(getParentFragment()).get(SharedViewModel.class); // using this in both parent amd child fragment would do the trick !

Answer 4

如果您使用的是导航组件 (https://developer.android.com/guide/navigation)， 您需要通过这种方式获取 viewModel：

在你的应用中实现 fragment-ktx -> build.gradle:

implementation 'androidx.fragment:fragment-ktx:1.2.5

在父片段中：

private val viewModel by viewModels<ParentFragmentViewModel>()

在子片段中

private val viewModel by viewModels<ParentFragmentViewModel>({requireGrandParentFragment()})

requireGrandParentFragment() 是 Fragment 的自定义扩展：

fun Fragment.requireGrandParentFragment() = this.requireParentFragment().requireParentFragment()

之所以需要上两层才能访问 parentFragment 的 viewModel 是因为导航组件上 childFragment 的第一个父级是 NavHostFragment 和 NavHostFragment 的父级> 是 viewModel 所在的 parentFragment。

如果你没有使用 Navigation 组件，你可以在 childFragment 中这样访问它：

private val viewModel by viewModels<ParentFragmentViewModel>({requireParentFragment()})

Answer 5

Google 现在让我们能够将 ViewModel 限定为导航图。如果您已经在使用导航组件，则可以使用它。 （个人意见，如果你还没有使用导航组件，你应该转向导航组件，因为它很容易使用。从一个试图自己管理后台堆栈的人那里拿走它）

您可以在导航图和right-click->move to nested graph->new graph内选择所有需要组合在一起的片段

现在这会将选定的片段移动到主导航图中的嵌套图，如下所示：

<navigation app:startDestination="@id/homeFragment" ...>
    <fragment android:id="@+id/homeFragment" .../>
    <fragment android:id="@+id/productListFragment" .../>
    <fragment android:id="@+id/productFragment" .../>
    <fragment android:id="@+id/bargainFragment" .../>
    
    <navigation 
        android:id="@+id/checkout_graph" 
        app:startDestination="@id/cartFragment">

        <fragment android:id="@+id/orderSummaryFragment".../>
        <fragment android:id="@+id/addressFragment" .../>
        <fragment android:id="@+id/paymentFragment" .../>
        <fragment android:id="@+id/cartFragment" .../>

    </navigation>
    
</navigation>

现在，当您初始化 ViewModel 时，在 Fragments 中执行此操作

val viewModel: CheckoutViewModel by navGraphViewModels(R.id.checkout_graph)

如果您需要传递视图模型工厂（可能是用于注入视图模型），您可以这样做：

val viewModel: CheckoutViewModel by navGraphViewModels(R.id.checkout_graph) { viewModelFactory }

确保它是R.id.graph 而不是R.navigation.graph

由于某种原因，创建导航图并使用include 将其嵌套在主导航图中对我不起作用。应该是bug吧。

来源：https://medium.com/androiddevelopers/viewmodels-with-saved-state-jetpack-navigation-data-binding-and-coroutines-df476b78144e

感谢Manually clearing an Android ViewModel? 为我指明了正确的方向。

Answer 6

我在所有解决方案中都尝试过同样的问题，但在我的场景中不起作用使用 requireParentFragment() 在子片段中返回 NavHostFragment 使用其他解决方案解决它

private val viewModel: childViewModel by viewModels(
            ownerProducer = { requireParentFragment().childFragmentManager.primaryNavigationFragment!! }
    )

在父片段中使用这个

private val viewModel: MyOrdersVM by viewModels()

Answer 7

使用 Kotlin 和延迟初始化的版本 (AKA by viewModels)

在父 Fragment 中（例如 ViewPager2）

private val viewModel: MyViewModel by viewModels({ this }) {
    TODO("MyViewModelFactory instance")
}

在子 Fragment 中（例如 ViewPager2 中的页面）

private val viewModel: MyViewModel by viewModels({ requireParentFragment() })

Answer 8

我做错了向DialogFragment 提供了不正确的片段管理器。 所以在我的情况下它是这样工作的：

class MyDialog : DialogFragment() {

    private val viewModel: MyViewModel by viewModels({ requireParentFragment() })

并在我的fragment 中初始化对话框：

private fun showDialog(){
    MyDialog().show(childFragmentManager, "AddFriendToGroupDialog")
}

我正在使用implementation 'androidx.fragment:fragment-ktx:1.3.0' 和导航图。

Answer 9

我也有这个问题。为子片段创建了一个新的 ViewModel。 问题是 getParentFragment() 返回的是 NavHostFragment 而不是所需的片段。

我们需要在子片段中获取真正的父对象。

如果我们这样做requireParentFragment().requireParentFragment()，那么我们就会得到真正的父级。

解决方案：（用于子更新）

Fragment parent = requireParentFragment().requireParentFragment();
viewModel = new ViewModelProvider(parent).get(RequestViewModel.class);

Found a solution here