ViewModel 數(shù)據(jù)的首次加載時機？
在 MVVM 中, ViewModel 的重要職責是解耦 View 與 Model体谒。
- View 向 ViewModel 發(fā)出指令填抬，請求數(shù)據(jù)
- View 通過 DataBinding 或 LiveData 等訂閱 ViewModel 的數(shù)據(jù)變化
關于訂閱 ViewModel 的時機窘问，大家一般放在 onViewCreated 辆童，這是沒有問題的。但是一個常犯的錯誤是將 ViewModel 中首次的數(shù)據(jù)加載也放到 onViewCreated 中進行：
//DetailTaskViewModel.kt
class DetailTaskViewModel : ViewModel() {
private val _task = MutableLiveData<Task>()
val task: LiveData<Task> = _task
fun fetchTaskData(taskId: Int) {
viewModelScope.launch {
_task.value = withContext(Dispatchers.IO){
TaskRepository.getTask(taskId)
}
}
}
}
//DetailTaskFragment.kt
class DetailTaskFragment : Fragment(R.layout.fragment_detailed_task){
private val viewModel : DetailTaskViewModel by viewModels()
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
//訂閱 ViewModel
viewMode.uiState.observe(viewLifecycleOwner) {
//update ui
}
//請求數(shù)據(jù)
viewModel.fetchTaskData(requireArguments().getInt(TASK_ID))
}
}
如上惠赫，如果 ViewModel 在 onViewCreated 中請求數(shù)據(jù)胸遇，當 View 因為橫豎屏等原因重建時會再次請求，而我們知道 ViewModel 的生命周期長于 View汉形，數(shù)據(jù)可以跨越 View 的生命周期存在，所以沒有必要隨著 View 的重建反復請求倍阐。
正確的加載時機
ViewModel 的初次數(shù)據(jù)加載推薦放到 init{} 中進行概疆，這樣可以保證 ViewModelScope 中只加載一次
//TasksViewModel.kt
class TasksViewModel: ViewModel() {
private val _tasks = MutableLiveData<List<Task>>()
val tasks: LiveData<List<Task>> = _uiState
init {
viewModelScope.launch {
_tasks.value = withContext(Dispatchers.IO){
TasksRepository.fetchTasks()
}
}
}
}
LiveData KTX Builder
此外 lifecycle-livedata-ktx 提供的 LiveData KTX Builder 可以在創(chuàng)建 LiveData 的同時進行數(shù)據(jù)請求，無需創(chuàng)建 MutableLiveData峰搪，寫法更簡潔:
implementation "androidx.lifecycle:lifecycle-livedata-ktx:$latest_version"
val tasks: LiveData<Result> = liveData {
emit(Result.loading())
try {
emit(Result.success(repo.fetchData()))
} catch(ioException: Exception) {
emit(Result.error(ioException))
}
}
Note: 此種 KTX Builder 只適用于數(shù)據(jù)僅加載一次的情況岔冀，如果后續(xù)有用戶動態(tài)觸發(fā)的數(shù)據(jù)請求，則還需要借助
MutableLiveData來實現(xiàn)概耻。
設置 ViewModel 的初始化參數(shù)
如果在 ViewModel 構造函數(shù)中請求數(shù)據(jù)使套，當需要參數(shù)時該如何傳入呢罐呼？ 比如我們最開頭例子中需要傳入一個 TaskId。
1. 構造參數(shù)
最容易想到的方法是通過構造參數(shù)傳入侦高。
class DetailTaskViewModel(private val taskId: Int) : ViewModel() {
//...
init {
viewModelScope.launch {
_tasks.value = TasksRepository.fetchTask(taskId)
}
}
}
需要注意不能直接調(diào)用 ViewModel 的構造函數(shù)構造嫉柴，這樣無法將 ViewModel 存入 ViewModelStore。
此時需要定義一個 ViewModelProvider.Factory：
class TaskViewModelFactory(val taskId: Int) : ViewModelProvider.Factory {
override fun <T : ViewModel?> create(modelClass: Class<T>): T =
modelClass.getConstructor(Int::class.java)
.newInstance(taskId)
}
然后在 Fragment 中奉呛，用此 Factory 創(chuàng)建 ViewModel
class DetailTaskFragment : Fragment(R.layout.fragment_detailed_task){
private val viewModel : DetailTaskViewModel by viewModels {
TaskViewModelFactory(requireArguments().getInt(TASK_ID))
}
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
//...
}
}
2. 使用 SavedStateHandler
Fragment 1.2.0 或者 Activity 1.1.0 起, 可以使用 SavedStateHandle 作為 ViewModel 的參數(shù)计螺。 SavedStateHandle 可以幫助 ViewModel 實現(xiàn)數(shù)據(jù)持久化，同時可以傳遞 Fragment 的 arguments 給 ViewModel瞧壮。
關于如何使用 SavedStateHandle 對數(shù)據(jù)進行持久化登馒，由于不是本文重點不做介紹，這里只展示如何通過 SavedStateHandle 獲取 arguments
implementation "androidx.lifecycle:lifecycle-viewmodel-savestate:$latest_version"
SavedStateHandle 版本的 ViewModel 定義如下：
class TaskViewModel(savedStateHandle: SavedStateHandle) : ViewModel() {
//...
init {
viewModelScope.launch {
_tasks.value = TasksRepository.fetchTask(
savedStateHandle.get<Int>(TASK_ID)
)
}
}
}
Fragment 中創(chuàng)建 ViewModel 如下：
class DetailTaskFragment : Fragment(R.layout.fragment_detailed_task){
private val viewModel: TaskViewModel by viewModels {
SavedStateViewModelFactory(
requireActivity().application,
requireActivity(),
arguments// 將arguments作為默認參數(shù)傳遞給 SavedStateHandler
)
}
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
//...
}
}
其中咆槽，SavedStateViewModelFactory 是關鍵陈轿，它會在構造 ViewModel 的時候，傳入 SavedStateHandler
3. 自定義擴展方法
前兩種方法的模板代碼較多秦忿，這里推薦一個自定義的擴展方法viewModelByFactory麦射，可以進一步簡化代碼
typealias CreateViewModel = (handle: SavedStateHandle) -> ViewModel
inline fun <reified VM : ViewModel> Fragment.viewModelByFactory(
defaultArgs: Bundle? = null,
noinline create: CreateViewModel = {
val constructor = findMatchingConstructor(VM::class.java, arrayOf(SavedStateHandle::class.java))
constructor!!.newInstance(it)
}
): Lazy<VM> {
return viewModels {
createViewModelFactoryFactory(this, defaultArgs, create)
}
}
inline fun <reified VM : ViewModel> Fragment.activityViewModelByFactory(
defaultArgs: Bundle? = null,
noinline create: CreateViewModel
): Lazy<VM> {
return activityViewModels {
createViewModelFactoryFactory(this, defaultArgs, create)
}
}
fun createViewModelFactoryFactory(
owner: SavedStateRegistryOwner,
defaultArgs: Bundle?,
create: CreateViewModel
): ViewModelProvider.Factory {
return object : AbstractSavedStateViewModelFactory(owner, defaultArgs) {
override fun <T : ViewModel?> create(key: String, modelClass: Class<T>, handle: SavedStateHandle): T {
@Suppress("UNCHECKED_CAST")
return create(handle) as? T
?: throw IllegalArgumentException("Unknown viewmodel class!")
}
}
}
@PublishedApi
internal fun <T> findMatchingConstructor(
modelClass: Class<T>,
signature: Array<Class<*>>
): Constructor<T>? {
for (constructor in modelClass.constructors) {
val parameterTypes = constructor.parameterTypes
if (Arrays.equals(signature, parameterTypes)) {
return constructor as Constructor<T>
}
}
return null
}
使用時的效果如下：
class DetailTaskFragment : Fragment(R.layout.fragment_detailed_task){
private val viewModel by viewModelByFactory(arguments)
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
//...
}
}
除了 SavedStateHandler 以外如果還希望增加更多參數(shù)，還可以自定義 CreateViewModel
4. 依賴注入
最后看一下如何使用依賴注入傳參小渊。以 Hilt 為例法褥，Hilt 天然支持 ViewModel 的依賴注入，本質(zhì)上也是基于 SavedStateHandler 實現(xiàn)的
@HiltViewModel
class DetailedTaskViewModel @Inject constructor(
private val savedStateHandle: SavedStateHandle
) : ViewModel() {
//...
}
添加 @HiltViewModel 注解酬屉，并使用 @Inject 注解構造函數(shù)半等。 除了 SavedStateHandle以外，也可以注入其他更多參數(shù)
ViewModel 的使用處呐萨， 別忘添加 @AndroidEntryPoint
@AndroidEntryPoint
class DetailedTaskFragment : Fragment(R.layout.fragment_detailed_task){
private val viewModel : DetailedTaskViewModel by viewModels()
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
//...
}
}
前三種方式或多或少都要使用 ViewModelProvider.Factory 來構造 ViewModel, 而 Hilt 避免了 Factory 的使用杀饵，在寫法上最為簡單。
