Android ViewModel n'a pas de constructeur à zéro argument

Question

Je suis este pour en savoir plus sur LiveData et ViewModel. Dans la doc, la classe ViewModel a un constructeur comme tel,

public class UserModel extends ViewModel {
  private MutableLiveData<User> user;

  @Inject UserModel(MutableLiveData<User> user) {
    this.user = user;
  }

  public void init() {
    if (this.user != null) {
      return;
    }
    this.user = new MutableLiveData<>();
  }

  public MutableLiveData<User> getUser() {
    return user;
  }
}

Cependant, lorsque j'exécute le code, j'obtiens une exception :

final UserViewModelviewModel = ViewModelProviders.of(this).get(UserViewModel.class);

Causé par : java.lang.RuntimeException : Impossible de créer une instance de la classe UserViewModel Causé par : java.lang.InstantiationException : La classe java.lang.Class n'a pas de constructeur à zéro argument

Answer 1

Lors de l'initialisation des sous-classes de ViewModel en utilisant ViewModelProviders par défaut, il s'attend à ce que votre UserModel pour avoir un constructeur à zéro argument. Dans votre cas, votre constructeur a l'argument MutableLiveData<User> user .

Une façon de résoudre ce problème est d'avoir un constructeur par défaut sans arg pour votre UserModel .

Sinon, si vous souhaitez disposer d'un constructeur à argument non nul pour votre classe ViewModel, vous devrez peut-être créer un constructeur personnalisé ViewModelFactory pour initialiser votre instance ViewModel, qui implémente la classe ViewModelProvider.Factory interface.

Je n'ai pas encore essayé, mais voici un lien vers un excellent échantillon Google à ce sujet : github.com/googlesamples/Android-architecture-components . Plus précisément, regardez cette classe GithubViewModelFactory.java pour le code Java et cette classe GithubViewModelFactory.kt pour le code Kotlin correspondant.

Answer 2

ViewModelFactory qui nous fournira un ViewModel correct à partir de ViewModelModule

public class ViewModelFactory implements ViewModelProvider.Factory {
    private final Map<Class<? extends ViewModel>, Provider<ViewModel>> viewModels;

    @Inject
    public ViewModelFactory(Map<Class<? extends ViewModel>, Provider<ViewModel>> viewModels) {
        this.viewModels = viewModels;
    }

    @Override
    public <T extends ViewModel> T create(Class<T> modelClass) {
        Provider<ViewModel> viewModelProvider = viewModels.get(modelClass);

        if (viewModelProvider == null) {
            throw new IllegalArgumentException("model class " + modelClass + " not found");
        }

        return (T) viewModelProvider.get();
    }
}

ViewModelModule est responsable de la liaison de toutes les classes de ViewModel dans
Map<Class<? extends ViewModel>, Provider<ViewModel>> viewModels

@Module
public abstract class ViewModelModule {

    @Binds
    abstract ViewModelProvider.Factory bindViewModelFactory(ViewModelFactory viewModelFactory); 
    //You are able to declare ViewModelProvider.Factory dependency in another module. For example in ApplicationModule.

    @Binds
    @IntoMap
    @ViewModelKey(UserViewModel.class)
    abstract ViewModel userViewModel(UserViewModel userViewModel);

    //Others ViewModels
}

ViewModelKey est une annotation à utiliser comme clé dans la carte et se présente comme suit

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@MapKey
@interface ViewModelKey {
    Class<? extends ViewModel> value();
}

Vous êtes maintenant en mesure de créer le ViewModel et de satisfaire toutes les dépendances nécessaires à partir du graphe.

public class UserViewModel extends ViewModel {
    private UserFacade userFacade;

    @Inject
    public UserViewModel(UserFacade userFacade) { // UserFacade should be defined in one of dagger modules
        this.userFacade = userFacade;
    }
} 

Instanciation du ViewModel

public class MainActivity extends AppCompatActivity {

    @Inject
    ViewModelFactory viewModelFactory;
    UserViewModel userViewModel;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        ((App) getApplication()).getAppComponent().inject(this);

        userViewModel = ViewModelProviders.of(this, viewModelFactory).get(UserViewModel.class);

    }
}

Et ne pas forger pour ajouter ViewModelModule en modules liste

@Singleton
@Component(modules = {ApplicationModule.class, ViewModelModule.class})
public interface ApplicationComponent {
    //
}

Answer 3

J'ai écrit une bibliothèque qui devrait permettre d'atteindre cet objectif de manière plus simple et plus propre, sans avoir à recourir à des liens multiples ou à un modèle d'usine, tout en offrant la possibilité de paramétrer davantage l'interface utilisateur. ViewModel au moment de l'exécution : https://github.com/radutopor/ViewModelFactory

@ViewModelFactory
class UserViewModel(@Provided repository: Repository, userId: Int) : ViewModel() {

    val greeting = MutableLiveData<String>()

    init {
        val user = repository.getUser(userId)
        greeting.value = "Hello, $user.name"
    }    
}

Dans la vue :

class UserActivity : AppCompatActivity() {
    @Inject
    lateinit var userViewModelFactory2: UserViewModelFactory2

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_user)
        appComponent.inject(this)

        val userId = intent.getIntExtra("USER_ID", -1)
        val viewModel = ViewModelProviders.of(this, userViewModelFactory2.create(userId))
            .get(UserViewModel::class.java)

        viewModel.greeting.observe(this, Observer { greetingText ->
            greetingTextView.text = greetingText
        })
    }
}

Answer 4

Le problème peut être résolu en étendant UserModel de AndroidViewModel qui est un ViewModel conscient du contexte de l'application et qui requiert Application constructeur uniquement pour les paramètres. (documentation)

Ex- (en kotlin)

class MyVm(application: Application) : AndroidViewModel(application)

Cela fonctionne pour la version 2.0.0-alpha1 .

Answer 5

Si vous avez un paramètre dans le constructeur, alors :

DAGGER 2 public constructor for @inject dependency

@Inject
public UserViewModel(UserFacade userFacade)
{ 
    this.userFacade = userFacade;
}

Sinon, la dague 2 vous enverra l'erreur "ne peut pas instancier l'objet viewmodel".