Jetpack Compose 将参数传递给 viewModel

Question

如何在

viewModel

中向

Jetpack Compose

传递参数？

这是我的可组合项

    @Composable
    fun UsersList() {
      val myViewModel: MyViewModel = viewModel("db2name") // pass param like this
    }

这是

viewModel

    class MyViewModel(private val dbname) : ViewModel() {
        private val users: MutableLiveData<List<User>> by lazy {
            MutableLiveData<List<User>>().also {
                loadUsers()
            }
        }
    
        fun getUsers(): LiveData<List<User>> {
            return users
        }
    
        private fun loadUsers() {
            // Do an asynchronous operation to fetch users.
        }
    }

Answer 1

您需要创建一个工厂来将动态参数传递给 ViewModel，如下所示：

class MyViewModelFactory(private val dbname: String) :
    ViewModelProvider.NewInstanceFactory() {
    override fun <T : ViewModel?> create(modelClass: Class<T>): T = MyViewModel(dbname) as T
}

然后在可组合函数中使用你的工厂：

@Composable
fun UsersList() {
    val myViewModel: MyViewModel =
        viewModel(factory = MyViewModelFactory("db2name")) // pass param like this
}

现在您可以访问 ViewModel 中的 dbname 参数：

class MyViewModel(private val dbname:String) : ViewModel() {
    // ...rest of the viewModel logics here
}

Answer 2

如果您使用 Hilt，您可以在

SavedStateHandle

中免费获得此视图模型。

将参数传递给调用视图模型的可组合项，并从保存的状态句柄中在视图模型上使用相同的名称检索它。

像这样：

在 NavHost 上：

NavHost(
(...)
    composable(
            route = [route string like this $[route]/{$[argument name]}],
            arguments = listOf(
                navArgument([argument name]) { type = NavType.[type: Int/String/Boolean/etc.] }
            )
        ) {
            [Your composable]()
        }
    )
)

查看模型：

class ViewModel @Inject constructor(savedStateHandle: SavedStateHandle) {

    private val argument = checkNotNull(savedStateHandle.get<[type]>([argument name]))
}

无需视图模型工厂，你的论点就会神奇地出现。

Answer 3

其他解决方案有效，但您必须为每个 ViewModel 创建一个工厂，这似乎有点过分了。

比较通用的解决方案是这样的：

inline fun <VM : ViewModel> viewModelFactory(crossinline f: () -> VM) =
    object : ViewModelProvider.Factory {
        override fun <T : ViewModel> create(aClass: Class<T>):T = f() as T
    }

并像这样使用它：

@Composable
fun MainScreen() {
    val viewModel: MyViewModel = viewModel(factory = viewModelFactory {
        MyViewModel("Test Name")
    })
}

对于这样的 ViewModel：

class MyViewModel(
  val name: String
):ViewModel() {}

Answer 4

通常没有需要这样做的常见情况。在 android MVVM 视图模型中，通过依赖注入从存储库获取数据。

这里是推荐的android架构的官方文档：https://developer.android.com/jetpack/guide#recommended-app-arch

Answer 5

这里有一些用于实现相同功能的 Jetpack Compose/Kotlin 特定语法：

ui/设置/SettingsViewModel.kt

class SettingsViewModel(
    private val settingsRepository: SettingsRepository
) : ViewModel() {
    /* Your implementation */
}

class SettingsViewModelFactory(
    private val settingsRepository: SettingsRepository
) : ViewModelProvider.Factory {

    override fun <T : ViewModel> create( modelClass: Class<T> ): T {
        if( modelClass.isAssignableFrom( SettingsViewModel::class.java ) ) {
            @Suppress( "UNCHECKED_CAST" )
            return SettingsViewModel( settingsRepository ) as T
        }
        throw IllegalArgumentException( "Unknown ViewModel Class" )
    }    

}

然后：

MainActivity.kt

/* dataStore by preferencesDataStore */

class MainActivity : ComponentActivity() {
    private lateinit var settingsRepository: SettingsRepository
    
    // Here we instantiate our ViewModel leveraging delegates and
    // a trailing lambda
    private val settingsViewModel by viewModels<SettingsViewModel> {
        SettingsViewModelFactory(
            settingsRepository
        )
    }

    /* onCreate -> setContent -> etc */
}

Answer 6

正如@Secret Keeper提到的，你需要创建工厂。

如果您的 ViewModel 有依赖项，则 viewModel() 需要一个可选的 ViewModelProvider.Factory 作为参数。

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

要创建视图模型，您将传递可选参数。在您的可组合项中，您可以执行类似的操作。

val viewModel: MyViewModel = viewModel(
factory = MyViewModelFactory(
    dbname = "myDbName"
)