Android LiveData - how to reuse the same ViewModel on different activities?

Question

Example ViewModel:

public class NameViewModel extends ViewModel {     // Create a LiveData with a String     private MutableLiveData<String> mCurrentName;      public MutableLiveData<String> getCurrentName() {         if (mCurrentName == null) {             mCurrentName = new MutableLiveData<>();         }         return mCurrentName;     }  } 

Main activity:

mModel = ViewModelProviders.of(this).get(NameViewModel.class);  // Create the observer which updates the UI. final Observer<String> nameObserver = textView::setText;  // Observe the LiveData, passing in this activity as the LifecycleOwner and the observer. mModel.getCurrentName().observe(this, nameObserver); 

I want to call mModel.getCurrentName().setValue(anotherName); in second activity and make MainActivity receive changes. Is that possible?

Answer 1

When you call ViewModelProviders.of(this), you actually create/retain a ViewModelStore which is bound to this, so different Activities have different ViewModelStore and each ViewModelStore creates a different instance of a ViewModel using a given factory, so you can not have the same instance of a ViewModel in different ViewModelStores.

But you can achieve this by passing a single instance of a custom ViewModel factory which acts as a singleton factory, so it will always pass the same instance of your ViewModel among different activities.

For example:

public class SingletonNameViewModelFactory extends ViewModelProvider.NewInstanceFactory {       NameViewModel t;      public SingletonNameViewModelFactory() {       //  t = provideNameViewModelSomeHowUsingDependencyInjection     }      @Override     public NameViewModel create(Class<NameViewModel> modelClass) {         return t;     } } 

So what you need is to make SingletonNameViewModelFactory singleton (e.g. using Dagger) and use it like this:

mModel = ViewModelProviders.of(this,myFactory).get(NameViewModel.class); 

Note:

Preserving ViewModels among different scopes is an anti-pattern. It's highly recommended to preserve your data-layer objects (e.g. make your DataSource or Repository singleton) and retain your data between different scopes (Activities).

Read this article for details.

Answer 2

When getting the view model using the ViewModelProviders you are passing as lifecycle owner the MainActivity, this will give the view model for the that activity. In the second activity you will get a different instance of that ViewModel, this time for your second Activity. The second model will have a second live data.

What you can do is maintain the data in a different layer, like a repository, which may be a singleton and that way you can use the same view model.

public class NameViewModel extends ViewModel {     // Create a LiveData with a String     private MutableLiveData<String> mCurrentName;      public MutableLiveData<String> getCurrentName() {         if (mCurrentName == null) {             mCurrentName = DataRepository.getInstance().getCurrentName();         }         return mCurrentName;     } }  //SingleTon public class DataRepository           private MutableLiveData<String> mCurrentName;      public MutableLiveData<String> getCurrentName() {         if (mCurrentName == null) {             mCurrentName = new MutableLiveData<>();         }         return mCurrentName;     } //Singleton code ... }