Creazione di ViewModel con dipendenze Parte di Android Jetpack.
Seguendo le best practice dell'inserimento delle dipendenze, ViewModels può assumere le dipendenze come parametri nel costruttore. Si tratta principalmente di tipi provenienti dal livello dominio o dati. Poiché il framework fornisce i ViewModel, è necessario un meccanismo speciale per crearne le istanze. Questo meccanismo è l'interfaccia ViewModelProvider.Factory
. Solo le implementazioni di questa interfaccia possono creare nuove istanze di ViewModel nell'ambito corretto.
ViewModels con CreationExtra
Se una classe ViewModel riceve dipendenze nel suo costruttore, fornisci una fabbrica che implementi l'interfaccia ViewModelProvider.Factory
. Esegui l'override della funzione create(Class<T>, CreationExtras)
per fornire una nuova istanza del ViewModel.
CreationExtras
ti consente di accedere a informazioni pertinenti che aiutano a
fondare un ViewModel. Ecco un elenco di chiavi a cui è possibile accedere da altri servizi:
Chiave | Funzionalità |
---|---|
ViewModelProvider.NewInstanceFactory.VIEW_MODEL_KEY |
Fornisce l'accesso alla chiave personalizzata che hai trasmesso a ViewModelProvider.get() . |
ViewModelProvider.AndroidViewModelFactory.APPLICATION_KEY |
Fornisce l'accesso all'istanza della classe Application . |
SavedStateHandleSupport.DEFAULT_ARGS_KEY |
Fornisce l'accesso al pacchetto di argomenti da usare per creare SavedStateHandle . |
SavedStateHandleSupport.SAVED_STATE_REGISTRY_OWNER_KEY |
Fornisce l'accesso al SavedStateRegistryOwner che viene utilizzato per creare il ViewModel . |
SavedStateHandleSupport.VIEW_MODEL_STORE_OWNER_KEY |
Fornisce l'accesso al ViewModelStoreOwner che viene utilizzato per creare il ViewModel . |
Per creare una nuova istanza di SavedStateHandle
, utilizza la funzione CreationExtras.createSavedStateHandle()
.createsaveStateHandle()) e passala a ViewModel.
Di seguito è riportato un esempio di come fornire un'istanza di un ViewModel che utilizza un repository con ambito alla classe Application
e SavedStateHandle
come dipendenze:
Kotlin
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.CreationExtras
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 = object : ViewModelProvider.Factory {
@Suppress("UNCHECKED_CAST")
override fun <T : ViewModel> create(
modelClass: Class<T>,
extras: CreationExtras
): T {
// Get the Application object from extras
val application = checkNotNull(extras[APPLICATION_KEY])
// Create a SavedStateHandle for this ViewModel from extras
val savedStateHandle = extras.createSavedStateHandle()
return MyViewModel(
(application as MyApplication).myRepository,
savedStateHandle
) as T
}
}
}
}
Java
import static androidx.lifecycle.SavedStateHandleSupport.createSavedStateHandle;
import static androidx.lifecycle.ViewModelProvider.AndroidViewModelFactory.APPLICATION_KEY;
import androidx.lifecycle.SavedStateHandle;
import androidx.lifecycle.ViewModel;
import androidx.lifecycle.viewmodel.ViewModelInitializer;
public class MyViewModel extends ViewModel {
public MyViewModel(
MyRepository myRepository,
SavedStateHandle savedStateHandle
) { /* Init ViewModel here */ }
static final ViewModelInitializer<MyViewModel> initializer = new ViewModelInitializer<>(
MyViewModel.class,
creationExtras -> {
MyApplication app = (MyApplication) creationExtras.get(APPLICATION_KEY);
assert app != null;
SavedStateHandle savedStateHandle = createSavedStateHandle(creationExtras);
return new MyViewModel(app.getMyRepository(), savedStateHandle);
}
);
}
Quindi, puoi utilizzare questa fabbrica quando recuperi un'istanza di ViewModel:
Kotlin
import androidx.activity.viewModels
class MyActivity : AppCompatActivity() {
private val viewModel: MyViewModel by viewModels { MyViewModel.Factory }
// Rest of Activity code
}
Java
import androidx.appcompat.app.AppCompatActivity;
import androidx.lifecycle.ViewModelProvider;
public class MyActivity extends AppCompatActivity {
MyViewModel myViewModel = new ViewModelProvider(
this,
ViewModelProvider.Factory.from(MyViewModel.initializer)
).get(MyViewModel.class);
// Rest of Activity code
}
Jetpack Compose
import androidx.lifecycle.viewmodel.compose.viewModel
@Composable
fun MyScreen(
modifier: Modifier = Modifier,
viewModel: MyViewModel = viewModel(factory = MyViewModel.Factory)
) {
// ...
}
In alternativa, utilizza la DSL di fabbrica ViewModel per creare stabilimenti utilizzando un'API Kotlin più idiomatica:
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
)
}
}
}
}
Fattori per la versione ViewModel precedente alla 2.5.0
Se stai utilizzando una versione di ViewModel precedente alla 2.5.0, devi fornire le fattrici da un sottoinsieme di classi che estendono ViewModelProvider.Factory
e implementano la funzione create(Class<T>)
. A seconda delle dipendenze necessarie a ViewModel, deve essere estesa una classe diversa da:
AndroidViewModelFactory
se è necessaria la classeApplication
.AbstractSavedStateViewModelFactory
seSavedStateHandle
deve essere passato come dipendenza.
Se Application
o SavedStateHandle
non sono necessari, estendi semplicemente da ViewModelProvider.Factory
.
L'esempio seguente utilizza un elemento AbstractSavedStateViewModelFactory
per un
ViewModel che utilizza un repository e un tipo SavedStateHandle
come
dipendenza:
Kotlin
class MyViewModel(
private val myRepository: MyRepository,
private val savedStateHandle: SavedStateHandle
) : ViewModel() {
// ViewModel logic ...
// Define ViewModel factory in a companion object
companion object {
fun provideFactory(
myRepository: MyRepository,
owner: SavedStateRegistryOwner,
defaultArgs: Bundle? = null,
): AbstractSavedStateViewModelFactory =
object : AbstractSavedStateViewModelFactory(owner, defaultArgs) {
@Suppress("UNCHECKED_CAST")
override fun <T : ViewModel> create(
key: String,
modelClass: Class<T>,
handle: SavedStateHandle
): T {
return MyViewModel(myRepository, handle) as T
}
}
}
}
Java
import androidx.annotation.NonNull;
import androidx.lifecycle.AbstractSavedStateViewModelFactory;
import androidx.lifecycle.SavedStateHandle;
import androidx.lifecycle.ViewModel;
public class MyViewModel extends ViewModel {
public MyViewModel(
MyRepository myRepository,
SavedStateHandle savedStateHandle
) { /* Init ViewModel here */ }
}
public class MyViewModelFactory extends AbstractSavedStateViewModelFactory {
private final MyRepository myRepository;
public MyViewModelFactory(
MyRepository myRepository
) {
this.myRepository = myRepository;
}
@SuppressWarnings("unchecked")
@NonNull
@Override
protected <T extends ViewModel> T create(
@NonNull String key, @NonNull Class<T> modelClass, @NonNull SavedStateHandle handle
) {
return (T) new MyViewModel(myRepository, handle);
}
}
Quindi, puoi utilizzare il codice di fabbrica per recuperare il ViewModel:
Kotlin
import androidx.activity.viewModels
class MyActivity : AppCompatActivity() {
private val viewModel: MyViewModel by viewModels {
MyViewModel.provideFactory((application as MyApplication).myRepository, this)
}
// Rest of Activity code
}
Java
import androidx.appcompat.app.AppCompatActivity;
import androidx.lifecycle.ViewModelProvider;
public class MyActivity extends AppCompatActivity {
MyViewModel myViewModel = new ViewModelProvider(
this,
ViewModelProvider.Factory.from(MyViewModel.initializer)
).get(MyViewModel.class);
// Rest of Activity code
}
Jetpack Compose
import androidx.lifecycle.viewmodel.compose.viewModel
@Composable
fun MyScreen(
modifier: Modifier = Modifier,
viewModel: MyViewModel = viewModel(
factory = MyViewModel.provideFactory(
(LocalContext.current.applicationContext as MyApplication).myRepository,
owner = LocalSavedStateRegistryOwner.current
)
)
) {
// ...
}
Consigliato per te
- Nota: il testo del link viene visualizzato quando JavaScript è disattivato
- Modulo Stato salvato per ViewModel
- Salvare gli stati dell'interfaccia utente
- Panoramica di LiveData