Criar ViewModels com dependências   Parte do Android Jetpack.

Seguindo as práticas recomendadas de injeção de dependência, os ViewModels podem usar dependências como parâmetros no construtor. Elas são principalmente de tipos das camadas de domínio ou de dados. Como o framework fornece os ViewModels, é necessário um mecanismo especial para criar as instâncias deles. Esse mecanismo é a interface ViewModelProvider.Factory. Somente implementações dessa interface podem instanciar ViewModels no escopo correto.

ViewModels com CreationExtras

Se uma classe ViewModel receber dependências no construtor, forneça uma fábrica que implemente a interface ViewModelProvider.Factory. Substitua a função create(Class<T>, CreationExtras) para fornecer uma nova instância do ViewModel.

O elemento CreationExtras permite que você acesse informações relevantes que ajudam a instanciar um ViewModel. Confira uma lista de chaves que podem ser acessadas nos extras:

Chave Funcionalidade
ViewModelProvider.NewInstanceFactory.VIEW_MODEL_KEY Fornece acesso à chave personalizada transmitida para ViewModelProvider.get().
ViewModelProvider.AndroidViewModelFactory.APPLICATION_KEY Fornece acesso à instância da classe Application.
SavedStateHandleSupport.DEFAULT_ARGS_KEY Fornece acesso ao pacote de argumentos que você precisa usar para construir um SavedStateHandle.
SavedStateHandleSupport.SAVED_STATE_REGISTRY_OWNER_KEY Fornece acesso ao SavedStateRegistryOwner usado para construir o ViewModel.
SavedStateHandleSupport.VIEW_MODEL_STORE_OWNER_KEY Fornece acesso ao ViewModelStoreOwner usado para construir o ViewModel.

Para criar uma nova instância de SavedStateHandle, use a função CreationExtras.createSavedStateHandle() e transmita-a para o ViewModel.

CreationExtras com APPLICATION_KEY

Confira abaixo um exemplo de como fornecer uma instância de um ViewModel que usa um repositório com escopo para a classe Application e SavedStateHandle como dependências:

    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
                    )
                }
            }
        }
    }

Em seguida, use essa fábrica ao extrair uma instância do ViewModel:

import androidx.lifecycle.viewmodel.compose.viewModel

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

Transmitir parâmetros personalizados como CreationExtras

É possível transmitir dependências para seu ViewModel usando CreationExtras ao criar uma chave personalizada. Isso pode ser útil se o ViewModel depender de objetos que não estão acessíveis pela classe Application e APPLICATION_KEY. Por exemplo, quando seu ViewModel é criado em um módulo multiplataforma do Kotlin e, portanto, não tem acesso a dependências do Android.

Neste exemplo, o ViewModel define uma chave personalizada e a usa no 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,
                )
            }
        }
    }
}

Você pode instanciar um ViewModel com um CreationExtras.Key diretamente nos seus combináveis.

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,
    )
}

Outros recursos

Para saber mais sobre ViewModels e dependências, consulte os seguintes recursos adicionais:

Documentação

Visualiza conteúdo