Jetpack Navigation：关闭编辑对话框时如何更新ViewModel？

我正在开发一款简易SoundBoard应用，以熟悉Jetpack Compose和Navigation技术。目前遇到的问题是：应用主界面是展示SQLite数据库中所有声音的网格视图，用户可通过对话框编辑声音名称，但关闭编辑对话框后，尚未找到理想的方式刷新该网格。

当前定义的Destinations如下：

object Destinations {
    @Serializable
    object SoundGrid
    
    @Serializable
    class SoundEdit(val soundId: Int)
}

导航使用方式如下：

@Composable
fun SoundBoardApp(navController: NavHostController = rememberNavController()) {
    NavHost(navController = navController, startDestination = SoundGrid) {
        composable<SoundGrid> {
            SoundGrid(
                onNavigateToSoundEdit = {
                    navController.navigate(SoundEdit(it.id))
                })
        }

        dialog<SoundEdit> {
            SoundEditDialog(onClose = {
                navController.navigateUp()
            })
        }
    }
}

@Composable
fun SoundGrid(
    onNavigateToSoundEdit: (Sound) -> Unit,
    modifier: Modifier = Modifier,
    viewModel: SoundGridViewModel = koinViewModel(),
) { .. }

@Composable
fun SoundEditDialog(
    onClose: () -> Unit,
    viewModel: SoundEditViewModel = koinViewModel()
) { .. }

以下是几种符合Jetpack生态最佳实践的实现方式，按推荐程度排序：

方法1：Room数据库自动刷新（最优） #

如果使用Room作为SQLite封装层，直接利用Room的Flow返回类型，可实现数据库变化时自动同步UI，无需手动处理刷新逻辑。

1. 修改SoundDao，返回Flow类型的查询结果：

@Dao
interface SoundDao {
    @Query("SELECT * FROM sounds")
    fun getAllSounds(): Flow<List<Sound>>

    @Update
    suspend fun updateSound(sound: Sound)
}

2. Repository层传递Flow：

class SoundRepository(private val soundDao: SoundDao) {
    fun getAllSoundsFlow(): Flow<List<Sound>> = soundDao.getAllSounds()

    suspend fun updateSound(sound: Sound) = soundDao.updateSound(sound)
}

3. SoundGridViewModel直接暴露Flow：

class SoundGridViewModel(private val repo: SoundRepository) : ViewModel() {
    val sounds: Flow<List<Sound>> = repo.getAllSoundsFlow()
}

4. SoundGrid组件收集Flow自动刷新：

@Composable
fun SoundGrid(
    onNavigateToSoundEdit: (Sound) -> Unit,
    modifier: Modifier = Modifier,
    viewModel: SoundGridViewModel = koinViewModel(),
) {
    val sounds by viewModel.sounds.collectAsState(initial = emptyList())

    // 用sounds数据构建网格布局
    LazyVerticalGrid(columns = GridCells.Fixed(2)) {
        items(sounds) { sound ->
            SoundItem(sound, onEditClick = { onNavigateToSoundEdit(sound) })
        }
    }
}

当SoundEditViewModel调用updateSound修改数据库后，Room会自动发送新数据到Flow，SoundGrid的UI会自动刷新。

方法2：Navigation返回结果API #

适合不需要数据库自动监听的场景，通过导航组件传递刷新信号。

1. 修改导航逻辑，添加结果监听：

@Composable
fun SoundBoardApp(navController: NavHostController = rememberNavController()) {
    NavHost(navController = navController, startDestination = Destinations.SoundGrid) {
        composable<Destinations.SoundGrid> { backStackEntry ->
            // 监听从编辑页返回的刷新标记
            val needRefresh = backStackEntry.savedStateHandle.getLiveData<Boolean>("refresh")
            SoundGrid(
                onNavigateToSoundEdit = { navController.navigate(Destinations.SoundEdit(it.id)) },
                shouldRefresh = needRefresh.value == true
            )
        }

        dialog<Destinations.SoundEdit> { backStackEntry ->
            SoundEditDialog(onClose = {
                // 返回时设置刷新标记
                backStackEntry.savedStateHandle["refresh"] = true
                navController.navigateUp()
            })
        }
    }
}

2. SoundGrid中触发ViewModel刷新：

@Composable
fun SoundGrid(
    onNavigateToSoundEdit: (Sound) -> Unit,
    shouldRefresh: Boolean,
    modifier: Modifier = Modifier,
    viewModel: SoundGridViewModel = koinViewModel(),
) {
    // 当刷新标记触发时，重新加载数据
    LaunchedEffect(shouldRefresh) {
        if (shouldRefresh) {
            viewModel.refreshSounds()
            // 重置标记，避免重复刷新
            navController.currentBackStackEntry?.savedStateHandle?.remove<Boolean>("refresh")
        }
    }

    val sounds by viewModel.sounds.collectAsState(initial = emptyList())
    // 网格布局实现...
}

3. ViewModel添加刷新方法：

class SoundGridViewModel(private val repo: SoundRepository) : ViewModel() {
    private val _sounds = MutableStateFlow<List<Sound>>(emptyList())
    val sounds: StateFlow<List<Sound>> = _sounds

    init {
        loadSounds()
    }

    fun loadSounds() = viewModelScope.launch {
        _sounds.value = repo.getAllSounds()
    }

    fun refreshSounds() = loadSounds()
}

方法3：跨ViewModel共享事件流 #

适合复杂状态同步场景，通过Repository层的SharedFlow发送更新事件。

1. Repository添加更新事件流：

class SoundRepository(private val soundDao: SoundDao) {
    private val _soundUpdated = MutableSharedFlow<Unit>(replay = 0)
    val soundUpdated: SharedFlow<Unit> = _soundUpdated

    suspend fun getAllSounds() = soundDao.getAllSounds()
    suspend fun updateSound(sound: Sound) {
        soundDao.updateSound(sound)
        // 更新完成后发送事件
        _soundUpdated.emit(Unit)
    }
}

2. SoundGridViewModel监听事件自动刷新：

class SoundGridViewModel(private val repo: SoundRepository) : ViewModel() {
    private val _sounds = MutableStateFlow<List<Sound>>(emptyList())
    val sounds: StateFlow<List<Sound>> = _sounds

    init {
        loadSounds()
        listenForUpdates()
    }

    private fun listenForUpdates() = viewModelScope.launch {
        repo.soundUpdated.collect {
            loadSounds()
        }
    }

    fun loadSounds() = viewModelScope.launch {
        _sounds.value = repo.getAllSounds()
    }
}

当SoundEditViewModel调用updateSound后，事件流会触发SoundGridViewModel自动刷新数据。

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