Middle+
How to perform ViewModel injection using Dagger?
sobes.tech AI
Answer from AI
- Create a
ViewModelclass and annotate it with@Injectable. - Create a
ViewModelProvider.Factorythat knows how to instantiateViewModelinstances. This is usually done through mappingClass<? extends ViewModel>toProvider<? extends ViewModel>. - Define in a Dagger module how to create the
ViewModelProvider.Factory. Often,@Bindsis used to bind a specificViewModelto its@Provider. - In an Activity or Fragment, inject the
ViewModelProvider.Factoryand use it to obtain an instance ofViewModel.
// MyViewModel.java
public class MyViewModel extends ViewModel {
private final SomeDependency dependency;
@Inject
public MyViewModel(SomeDependency dependency) {
this.dependency = dependency;
}
// ... ViewModel methods
}
// ViewModelFactory.java
public class ViewModelFactory implements ViewModelProvider.Factory {
private final Map<Class<? extends ViewModel>, Provider<ViewModel>> creators;
@Inject
public ViewModelFactory(Map<Class<? extends ViewModel>, Provider<ViewModel>> creators) {
this.creators = creators;
}
@NonNull
@Override
public <T extends ViewModel> T create(@NonNull Class<T> modelClass) {
Provider<? extends ViewModel> creator = creators.get(modelClass);
if (creator == null) {
for (Map.Entry<Class<? extends ViewModel>, Provider<ViewModel>> entry : creators.entrySet()) {
if (modelClass.isAssignableFrom(entry.getKey())) {
creator = entry.getValue();
break;
}
}
}
if (creator == null) {
throw new IllegalArgumentException("unknown model class " + modelClass);
}
try {
return (T) creator.get();
} catch (Exception e) {
throw new RuntimeException(e);
}
}
}
// ViewModelModule.java
@Module
public abstract class ViewModelModule {
@Binds
abstract ViewModelProvider.Factory bindViewModelFactory(ViewModelFactory factory);
@Binds
@IntoMap
@ViewModelKey(MyViewModel.class)
abstract ViewModel bindMyViewModel(MyViewModel viewModel);
// Add other ViewModels here using @Binds and @ViewModelKey
}
// ViewModelKey.java
@MapKey
@Retention(RetentionPolicy.RUNTIME)
public @interface ViewModelKey {
Class<? extends ViewModel> value();
}
// MyActivity.java
public class MyActivity extends AppCompatActivity {
@Inject
ViewModelProvider.Factory viewModelFactory;
private MyViewModel myViewModel;
@Override
protected void onCreate(Bundle savedInstanceState) {
AndroidSupportInjection.inject(this); // If using dagger-android
super.onCreate(savedInstanceState);
// ...
myViewModel = new ViewModelProvider(this, viewModelFactory).get(MyViewModel.class);
// ...
}
}