Jetpack Compose中向ViewModel传递CompositionLocal值的优雅方式

核心思路 #

ViewModel的生命周期独立于Compose的Composition，不能直接在ViewModel内部获取CompositionLocal的值。正确的做法是从Compose侧拿到CompositionLocal中的storeURL，通过构造函数注入传递给ViewModel，这样既符合依赖注入原则，也能保证生命周期匹配。

具体实现步骤 #

1. 修改ViewModel构造函数，注入storeURL #

将storeURL作为ViewModel的构造参数传入，并保存为私有属性，这样init代码块就能直接使用：

class ReviewsViewModel(
    private val storeUrl: String,
    // 其他依赖（如Repository）可按需添加
) : ViewModel() {
    private val productsList = MutableStateFlow<List<Storefront.Product>?>(null)
    val reviews = MutableStateFlow<List<Review>?>(null)

    init {
        viewModelScope.launch {
            productsList.collectLatest { products ->
                loadReviews(products, storeUrl)
            }
        }
    }

    fun loadReviews(products: List<Storefront.Product>?, storeUrl: String) {
        viewModelScope.launch(Dispatchers.IO) {
            when (val result = getReviews(products, storeUrl)) {
                is Resource.Loading -> Unit
                is Resource.Success -> {
                    result.data?.let { reviews.value = it }
                }
                is Resource.Error -> Unit
            }
        }
    }
}

2. 在Compose中传递storeURL给ViewModel #

从CompositionLocal中获取storeURL，然后在创建ViewModel时通过工厂模式传入：

假设你的CompositionLocal定义如下：

val LocalStoreUrl = compositionLocalOf<String> { error("Store URL未提供") }

在Compose函数中创建ViewModel：

@Composable
fun ReviewsScreen() {
    val storeUrl = LocalStoreUrl.current
    // 通过自定义Factory传递storeURL给ViewModel
    val viewModel: ReviewsViewModel = viewModel(
        factory = object : ViewModelProvider.Factory {
            @Suppress("UNCHECKED_CAST")
            override fun <T : ViewModel> create(modelClass: Class<T>): T {
                return ReviewsViewModel(storeUrl) as T
            }
        }
    )

    // 后续可根据业务逻辑更新productsList的值
    // 例如：viewModel.updateProductsList(newProducts)
}

3. （可选）使用Hilt简化依赖注入 #

如果项目使用Hilt，可以通过@AssistedInject实现更优雅的注入：

ViewModel代码：

class ReviewsViewModel @AssistedInject constructor(
    @Assisted private val storeUrl: String,
    private val reviewsRepository: ReviewsRepository // 假设的Repository依赖
) : ViewModel() {
    private val productsList = MutableStateFlow<List<Storefront.Product>?>(null)
    val reviews = MutableStateFlow<List<Review>?>(null)

    init {
        viewModelScope.launch {
            productsList.collectLatest { products ->
                loadReviews(products, storeUrl)
            }
        }
    }

    fun loadReviews(products: List<Storefront.Product>?, storeUrl: String) {
        // 原逻辑不变
    }

    // 定义AssistedFactory用于创建ViewModel
    @AssistedFactory
    interface Factory {
        fun create(storeUrl: String): ReviewsViewModel
    }

    companion object {
        fun provideFactory(
            assistedFactory: Factory,
            storeUrl: String
        ): ViewModelProvider.Factory = object : ViewModelProvider.Factory {
            @Suppress("UNCHECKED_CAST")
            override fun <T : ViewModel> create(modelClass: Class<T>): T {
                return assistedFactory.create(storeUrl) as T
            }
        }
    }
}

Compose中使用：

@Composable
fun ReviewsScreen() {
    val storeUrl = LocalStoreUrl.current
    val viewModel: ReviewsViewModel = hiltViewModel(
        factory = ReviewsViewModel.provideFactory(
            assistedFactory = hiltViewModel(),
            storeUrl = storeUrl
        )
    )
}

为什么不能直接在ViewModel中获取CompositionLocal？ #

• CompositionLocal的生命周期绑定到Compose的Composition，而ViewModel的生命周期更长（可能在Composition销毁后仍存活），直接获取会导致生命周期不匹配，引发潜在的内存泄漏或状态异常。
• 不符合依赖注入的设计原则，ViewModel的依赖应该明确传入，而非隐式从外部环境获取，这样更利于测试和维护。

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