Android中Fragment销毁时ViewModel未被销毁的问题排查

问题背景 #

在Fragment中通过以下代码创建ViewModel：

areaViewModel = ViewModelProvider(
    this, AreaViewModelFactory(AreaController.repository, currentPanelId, areaId)
)[AreaViewModel::class.java]

ViewModel与Factory实现如下：

class AreaViewModelFactory (private val repository: AreaRepository): ViewModelProvider.Factory {
    override fun <T : ViewModel> create(modelClass: Class<T>): T {
        if (modelClass.isAssignableFrom(AreaViewModel::class.java)) {
            @Suppress("UNCHECKED_CAST")
            return AreaViewModel(repository) as T
        }
        throw IllegalArgumentException("Unknown ViewModel class")
    }
}

class AreaViewModel@Inject constructor(private val repository: AreaRepository) : ViewModel(){

companion object {
    const val TAG: String = "AreaViewModel"
}

init {
    Log.i("AreaViewModel", "AreaViewModel created!")
}

private val _areaState = MutableStateFlow<Resource<Area>>(Resource.loading(null))
val areaState: StateFlow<Resource<Area>>
    get() = _areaState

fun getAreaById(panelId: Int, areaId: Int){
    _areaState.value = Resource.loading(null)
    viewModelScope.launch {
        repository.getAreaById(panelId, areaId) .catch { e ->
            _areaState.value = Resource.error(e.toString(), null)
        }
        .collect { it ->
            _areaState.value = Resource.success(it)
        }
    }
}

override fun onCleared() {
    Log.i("AreaViewModel", "AreaViewModel destroyed!")
    super.onCleared()
}
}

通过以下代码移除Fragment后，ViewModel的onCleared()未被触发：

private void removeControlFragment() {
    FragmentManager fragmentManager = getSupportFragmentManager();
    List<Fragment> fragmentList = fragmentManager.getFragments();
    for(int i = 0; i < fragmentList.size(); i++) {
        if (fragmentList.get(i) instanceof ControlFragment) {
            fragmentManager.beginTransaction().remove(fragmentList.get(i)).commit();
        }
    }
}

错误与缺失点分析 #

1. @Inject注解与手动Factory创建的冲突 #

AreaViewModel的构造函数添加了@Inject注解，说明你可能在使用依赖注入框架（如Hilt），但同时又通过自定义AreaViewModelFactory手动创建ViewModel实例。这种混合方式会破坏Jetpack ViewModel的生命周期管理机制：依赖注入框架和ViewModelProvider的生命周期管理逻辑冲突，导致系统无法正确感知ViewModel的销毁时机，从而不触发onCleared()。

修复方案：

• 如果使用Hilt，直接用@HiltViewModel注解标记AreaViewModel，并在Fragment中通过by viewModels()委托获取实例，无需自定义Factory。
• 如果不使用依赖注入框架，移除AreaViewModel构造函数上的@Inject注解，确保ViewModel仅通过自定义Factory创建。

2. FragmentManager管理不一致 #

如果你的ControlFragment是通过父Fragment的getChildFragmentManager()添加的，但移除时使用了Activity的getSupportFragmentManager()，这时候移除操作只是从Activity的FragmentManager中移除了引用，Fragment实际并未被完全销毁，ViewModel自然不会触发onCleared()。

修复方案：

• 确保添加和移除Fragment使用同一个FragmentManager：如果是添加到Activity，就用getSupportFragmentManager()；如果是添加到父Fragment，就用父Fragment的getChildFragmentManager()。

3. commit()异步执行导致的延迟 #

commit()是异步提交事务，Fragment不会立即被销毁，onCleared()的触发会有延迟。如果在调用移除方法后立刻检查日志，可能看不到输出。

修复方案：

• 改用commitNow()同步执行事务，确保Fragment立即被销毁：

fragmentManager.beginTransaction().remove(fragmentList.get(i)).commitNow();

• 或者观察Fragment的onDestroy()回调，确认Fragment销毁后再查看ViewModel的日志。

4. 自定义Factory的冗余参数 #

你的AreaViewModelFactory接收了currentPanelId和areaId参数，但在create()方法中完全没有使用这两个参数创建AreaViewModel，这属于代码冗余。如果后续ViewModel需要这两个参数，会导致逻辑错误，但不直接影响onCleared()触发。

修复方案：

• 如果ViewModel不需要这两个参数，移除Factory构造函数中的冗余参数；
• 如果需要，修改Factory的create()方法，传入参数创建ViewModel：

// 修改Factory构造函数
class AreaViewModelFactory (
    private val repository: AreaRepository,
    private val currentPanelId: Int,
    private val areaId: Int
): ViewModelProvider.Factory {
    override fun <T : ViewModel> create(modelClass: Class<T>): T {
        if (modelClass.isAssignableFrom(AreaViewModel::class.java)) {
            @Suppress("UNCHECKED_CAST")
            return AreaViewModel(repository, currentPanelId, areaId) as T
        }
        throw IllegalArgumentException("Unknown ViewModel class")
    }
}

// 修改ViewModel构造函数
class AreaViewModel(
    private val repository: AreaRepository,
    private val currentPanelId: Int,
    private val areaId: Int
) : ViewModel(){
    // ... 其余代码
}

内容的提问来源于stack exchange，提问作者Maya