如何在ViewPager2内嵌的子Fragment中保留ChildViewModel实例
问题原因
ViewPager2默认仅缓存当前显示页及左右各1个相邻页面,超出缓存范围的子Fragment会被销毁重建。你原先的两种用法都存在逻辑限制:
- 用
by viewModels()时,ViewModel作用域绑定当前子Fragment实例,Fragment销毁时对应的ViewModelStore会被清空,重建时自然会生成新的ViewModel实例 - 用父Fragment作为作用域时,默认所有子Fragment会用同一个默认key获取ViewModel,因此拿到的是同一个实例
解决方案
方案1:调整离屏缓存限制(适合子页面数量少的场景)
如果你的子Fragment总数量不超过5个,最简便的方式是直接将ViewPager2的离屏缓存数量设置为总页面数,让所有子Fragment不会被销毁,ViewModel自然会持续保留:
// 在RootFragment中初始化ViewPager2时设置 viewPager2.offscreenPageLimit = 你的页面总数量
该方案无需修改ViewModel的获取逻辑,缺点是页面数量多时会占用较高内存。
方案2:绑定父作用域+唯一Key(适合页面数量多的场景)
利用viewModels扩展函数的key参数,给每个子Fragment分配唯一的ViewModel存储key,既可以让ViewModel的生命周期和RootFragment绑定,又能保证每个子Fragment拿到独立的实例:
- 创建ChildFragment时,给每个实例传入唯一标识参数(比如页面位置、业务ID)
// 在RootFragment的PagerAdapter中创建ChildFragment时 fun createChildFragment(position: Int): ChildFragment { return ChildFragment().apply { arguments = Bundle().apply { putInt("page_position", position) } } }
- 子Fragment获取ViewModel时指定父作用域和唯一key
private val viewModel: ChildViewModel by viewModels( ownerProducer = { requireParentFragment() }, key = { "child_vm_${requireArguments().getInt("page_position")}" } )
注意事项
- 每个子Fragment的key必须全局唯一,避免多个页面拿到同一个ViewModel实例
- 如果存在动态删除子页面的场景,不需要对应ViewModel时可以手动调用
requireParentFragment().viewModelStore.remove(key)清除,避免内存泄漏;如果RootFragment整体销毁,所有绑定父作用域的ViewModel都会自动清理,无需额外处理
理解偏差说明
ViewModel的实例存储是基于作用域Owner+唯一Key的组合实现的,你之前的两种用法都只用到了作用域Owner的配置,没有利用Key参数做实例区分,所以无法满足「独立实例+生命周期长于子Fragment」的需求。
内容的提问来源于stack exchange,提问作者deanWombourne
相关产品推荐
相关产品推荐

