如何在Android Jetpack Compose中访问MainActivity注册的ViewModel？

问题场景 #

你已经在MainActivity中创建了与Activity生命周期绑定的SessionViewModel实例：

class MainActivity : AppCompatActivity() {
    //...
    val sessionViewModel: SessionViewModel by viewModels<SessionViewModel>()
}

但在继承ViewModel的类或@Composable函数中，无法通过viewModels()方法获取这个实例，下面分别给出两种场景的解决方案：

在@Compose函数中获取 #

Compose中提供了viewModel()函数来获取ViewModel实例，只要指定对应的ViewModelStoreOwner（这里就是MainActivity）即可。在Activity的Compose层级里，LocalViewModelStoreOwner.current默认指向当前Activity，直接用它来获取：

@Composable
fun HomeScreen() {
    // 获取与MainActivity绑定的SessionViewModel
    val sessionViewModel = viewModel<SessionViewModel>(
        viewModelStoreOwner = LocalViewModelStoreOwner.current!!
    )

    // 后续可直接使用sessionViewModel的状态或方法
    Text(text = "当前会话状态：${sessionViewModel.sessionState.value}")
}

如果你的Compose函数嵌套较深，也可以直接通过LocalContext强转为MainActivity来获取实例，但这种方式耦合性更高，不推荐：

@Composable
fun ProfileScreen() {
    val mainActivity = LocalContext.current as MainActivity
    val sessionViewModel = mainActivity.sessionViewModel
}

在其他ViewModel中获取 #

ViewModel之间不建议直接持有引用，更推荐通过共享数据流或依赖注入的方式实现状态共享，以下是两种可行方案：

方案1：依赖注入获取（以Hilt为例）

如果使用Hilt依赖注入框架，可以在目标ViewModel的构造函数中注入SessionViewModel，Hilt会自动提供与MainActivity绑定的实例：

// 先为SessionViewModel添加@HiltViewModel注解
@HiltViewModel
class SessionViewModel @Inject constructor() : ViewModel() {
    // 你的ViewModel逻辑
}

// 其他ViewModel中直接注入SessionViewModel
class OrderViewModel @Inject constructor(
    private val sessionViewModel: SessionViewModel
) : ViewModel() {
    init {
        // 观察SessionViewModel的状态
        viewModelScope.launch {
            sessionViewModel.sessionState.collect { state ->
                // 处理会话状态变化
            }
        }
    }
}

方案2：通过ViewModelProvider手动获取

如果不使用依赖注入，可以在其他ViewModel中传入MainActivity的ViewModelStoreOwner，再通过ViewModelProvider获取实例：

class CartViewModel(
    private val activityViewModelStoreOwner: ViewModelStoreOwner
) : ViewModel() {
    private val sessionViewModel by lazy {
        ViewModelProvider(activityViewModelStoreOwner)[SessionViewModel::class.java]
    }

    // 使用sessionViewModel的逻辑
    fun checkSessionValidity() {
        val isValid = sessionViewModel.isSessionValid()
        // ...
    }
}

// 在MainActivity中创建CartViewModel时传入自身作为ViewModelStoreOwner
val cartViewModel = ViewModelProvider(this)[CartViewModel::class.java]

注意：这种方式需要确保传入的ViewModelStoreOwner是MainActivity实例，避免内存泄漏。

重要提示 #

• viewModels()是Activity/Fragment的专属扩展函数，所以在ViewModel或Compose中无法直接调用，Compose用viewModel()，ViewModel则通过依赖注入或ViewModelProvider获取。
• 优先选择共享数据流（比如StateFlow）的方式实现状态共享，避免ViewModel间的强耦合，提升代码的可维护性和可测试性。

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