Membuat ViewModel dengan dependensi   Bagian dari Android Jetpack.

Mengikuti praktik terbaik injeksi dependensi, ViewModel dapat mengambil dependensi sebagai parameter dalam konstruktornya. Sebagian besar jenis ini berasal dari lapisan domain atau data. Karena framework ini menyediakan ViewModel, mekanisme khusus diperlukan untuk membuat instance darinya. Mekanisme tersebut adalah antarmuka ViewModelProvider.Factory. Hanya penerapan antarmuka ini yang dapat membuat instance ViewModel dalam cakupan yang tepat.

ViewModel dengan CreationExtras

Jika class ViewModel menerima dependensi dalam konstruktornya, sediakan factory yang mengimplementasikan antarmuka ViewModelProvider.Factory. Ganti fungsi create(Class<T>, CreationExtras) untuk memberikan instance ViewModel baru.

CreationExtras memungkinkan Anda mengakses informasi relevan yang membantu membuat instance ViewModel. Berikut adalah daftar kunci yang dapat diakses dari tambahan:

Kunci Fungsi
ViewModelProvider.NewInstanceFactory.VIEW_MODEL_KEY Menyediakan akses ke kunci kustom yang Anda teruskan ke ViewModelProvider.get().
ViewModelProvider.AndroidViewModelFactory.APPLICATION_KEY Menyediakan akses ke instance class Application.
SavedStateHandleSupport.DEFAULT_ARGS_KEY Memberikan akses ke Paket argumen yang harus Anda gunakan untuk membuat SavedStateHandle.
SavedStateHandleSupport.SAVED_STATE_REGISTRY_OWNER_KEY Memberikan akses ke SavedStateRegistryOwner yang sedang digunakan untuk membuat ViewModel.
SavedStateHandleSupport.VIEW_MODEL_STORE_OWNER_KEY Memberikan akses ke ViewModelStoreOwner yang sedang digunakan untuk membuat ViewModel.

Untuk membuat instance SavedStateHandle baru, gunakan fungsi CreationExtras.createSavedStateHandle() dan teruskan ke ViewModel.

CreationExtras dengan APPLICATION_KEY

Berikut adalah contoh cara menyediakan instance ViewModel yang mengambil repositori tercakup ke class Application dan SavedStateHandle sebagai dependensi:

    import androidx.lifecycle.SavedStateHandle
    import androidx.lifecycle.ViewModel
    import androidx.lifecycle.ViewModelProvider
    import androidx.lifecycle.ViewModelProvider.AndroidViewModelFactory.Companion.APPLICATION_KEY
    import androidx.lifecycle.createSavedStateHandle
    import androidx.lifecycle.viewmodel.initializer
    import androidx.lifecycle.viewmodel.viewModelFactory

    class MyViewModel(
        private val myRepository: MyRepository,
        private val savedStateHandle: SavedStateHandle
    ) : ViewModel() {

        // ViewModel logic
        // ...

        // Define ViewModel factory in a companion object
        companion object {

            val Factory: ViewModelProvider.Factory = viewModelFactory {
                initializer {
                    val savedStateHandle = createSavedStateHandle()
                    val myRepository = (this[APPLICATION_KEY] as MyApplication).myRepository
                    MyViewModel(
                        myRepository = myRepository,
                        savedStateHandle = savedStateHandle
                    )
                }
            }
        }
    }

Kemudian, Anda dapat menggunakan factory ini saat mengambil instance ViewModel:

import androidx.lifecycle.viewmodel.compose.viewModel

@Composable
fun MyScreen(
    modifier: Modifier = Modifier,
    viewModel: MyViewModel = viewModel(factory = MyViewModel.Factory)
) {
    // ...
}

Meneruskan parameter kustom sebagai CreationExtras

Anda dapat meneruskan dependensi ke ViewModel melalui CreationExtras dengan membuat kunci kustom. Hal ini dapat berguna jika ViewModel Anda bergantung pada objek yang tidak dapat diakses melalui class Application dan APPLICATION_KEY. Contohnya adalah saat ViewModel Anda dibuat di dalam modul Multiplatform Kotlin sehingga tidak memiliki akses ke dependensi Android.

Dalam contoh ini, ViewModel menentukan kunci kustom dan menggunakannya di ViewModelProvider.Factory.

import androidx.lifecycle.ViewModel
import androidx.lifecycle.ViewModelProvider
import androidx.lifecycle.viewModelScope
import androidx.lifecycle.viewmodel.CreationExtras
import androidx.lifecycle.viewmodel.initializer
import androidx.lifecycle.viewmodel.viewModelFactory

class MyViewModel(
    private val myRepository: MyRepository,
) : ViewModel() {
    // ViewModel logic

    // Define ViewModel factory in a companion object
    companion object {

        // Define a custom key using the factory function
        val MY_REPOSITORY_KEY = CreationExtras.Key<MyRepository>()

        val Factory: ViewModelProvider.Factory = viewModelFactory {
            initializer {
                // Get the dependency in your factory
                val myRepository = this[MY_REPOSITORY_KEY] as MyRepository
                MyViewModel(
                    myRepository = myRepository,
                )
            }
        }
    }
}

Anda dapat membuat instance ViewModel dengan CreationExtras.Key langsung di composable Anda.

import androidx.lifecycle.viewmodel.MutableCreationExtras
import androidx.lifecycle.viewmodel.compose.viewModel
// ...
@Composable
fun MyApp(myRepository: MyRepository) {
    val extras = MutableCreationExtras().apply {
        set(MyViewModel.MY_REPOSITORY_KEY, myRepository)
    }
    val viewModel: MyViewModel = viewModel(
        factory = MyViewModel.Factory,
        extras = extras,
    )
}

Referensi lainnya

Untuk mempelajari ViewModel dan dependensi lebih lanjut, lihat referensi tambahan berikut:

Dokumentasi

Melihat konten