如何在Composable与Activity中获取同一ViewModel实例？

问题根源在于hiltViewModel()默认将ViewModel绑定到Compose导航栈的NavBackStackEntry，而Activity中by viewModels()绑定到Activity本身的ViewModelStoreOwner，两者的存储容器不同，导致生成不同的ViewModel实例。以下是具体解决步骤：

1. 确认Hilt基础配置 #

确保项目已正确配置Hilt：

• 给MainActivity添加@AndroidEntryPoint注解
• 给RegisterByNfcViewModel添加@HiltViewModel注解，且构造函数标注@Inject

2. Activity中获取ViewModel #

保持Activity中原有获取方式即可，此时ViewModel生命周期与Activity绑定：

@AndroidEntryPoint
class MainActivity : AppCompatActivity(), NfcAdapter.ReaderCallback {
    // 绑定到Activity的ViewModel实例
    private val viewModel: RegisterByNfcViewModel by viewModels()

    override fun onTagDiscovered(tag: Tag?) {
        tag?.let {
            // 将NFC标签数据传递给ViewModel处理入库等逻辑
            viewModel.processNfcTag(it)
        }
    }

    // 其他Activity相关代码...
}

3. Composable中获取同实例ViewModel #

在Composable中调用hiltViewModel时，显式指定ViewModelStoreOwner为当前Activity，就能拿到和Activity相同的实例：

@Composable
fun RegisterByNfcScreen() {
    // 从LocalContext获取当前Activity，作为ViewModelStoreOwner
    val activity = LocalContext.current as AppCompatActivity
    // 指定owner为Activity，确保与Activity中的ViewModel实例一致
    val viewModel = hiltViewModel<RegisterByNfcViewModel>(activity)

    // 观察ViewModel中的状态变化，处理UI更新或用户通知
    val nfcProcessingResult by viewModel.processingResult.collectAsState()
    LaunchedEffect(nfcProcessingResult) {
        nfcProcessingResult?.let { result ->
            when (result) {
                is NfcProcessingResult.Success -> {
                    // 通知用户入库成功，比如用Snackbar
                    Snackbar.make(/* 宿主View */, "标签已入库", Snackbar.LENGTH_SHORT).show()
                }
                is NfcProcessingResult.Failure -> {
                    Snackbar.make(/* 宿主View */, "入库失败：${result.message}", Snackbar.LENGTH_SHORT).show()
                }
            }
        }
    }

    // 其他Composable UI代码...
}

4. ViewModel核心逻辑示例 #

在ViewModel中定义处理NFC标签的方法，并通过Flow暴露状态给Composable监听：

@HiltViewModel
class RegisterByNfcViewModel @Inject constructor(
    private val tagRepository: TagRepository
) : ViewModel() {
    private val _processingResult = MutableStateFlow<NfcProcessingResult?>(null)
    val processingResult = _processingResult.asStateFlow()

    fun processNfcTag(tag: Tag) {
        viewModelScope.launch {
            try {
                // 执行入库操作
                val tagId = tagRepository.saveTag(tag)
                _processingResult.emit(NfcProcessingResult.Success(tagId))
            } catch (e: Exception) {
                _processingResult.emit(NfcProcessingResult.Failure(e.localizedMessage))
            }
        }
    }
}

// 定义处理结果的密封类
sealed class NfcProcessingResult {
    data class Success(val tagId: String) : NfcProcessingResult()
    data class Failure(val message: String?) : NfcProcessingResult()
}

关键注意点 #

• 当ViewModel绑定到Activity生命周期时，只要Activity未销毁，ViewModel就会保持存活，完全适配NFC回调的使用场景。
• 如果Composable是通过导航组件跳转的，不能使用默认的hiltViewModel()（它会绑定到当前导航页面的生命周期），必须显式指定Activity作为Owner才能共享实例。

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