Android架构组件—ViewModel原理

在get()方法中可以看到是通过mFactory的类型来创建ViewModel的。而Factory的类型是由ViewModelStoreOwner决定的，这是ViewModelProvider的构造方法中的逻辑。其中有两种Factory，一种是SavedStateViewModelFactory，另一种是NewInstanceFactory。接下来我们直接看两种方式的区别。

SavedStateViewModelFactory创建ViewModel

public T create(@NonNull String key, @NonNull Class modelClass) {

boolean isAndroidViewModel = AndroidViewModel.class.isAssignableFrom(modelClass);

Constructor constructor;

…

SavedStateHandleController controller = SavedStateHandleController.create(

mSavedStateRegistry, mLifecycle, key, mDefaultArgs);

try {

T viewmodel;

if (isAndroidViewModel) {

viewmodel = constructor.newInstance(mApplication, controller.getHandle());

} else {

viewmodel = constructor.newInstance(controller.getHandle());

}

viewmodel.setTagIfAbsent(TAG_SAVED_STATE_HANDLE_CONTROLLER, controller);

return viewmodel;

}

…

}

在代码中可以看到，ViewModel有分为AndroidViewModel跟ViewModel，它们的区别是AndroidViewModel创建时会加入Application参数。

NewInstanceFactory创建ViewModel

public T create(@NonNull Class modelClass) {

//noinspection TryWithIdenticalCatches

try {

return modelClass.newInstance();

} catch (InstantiationException e) {

throw new RuntimeException("Cannot create an instance of " + modelClass, e);

} catch (IllegalAccessException e) {

throw new RuntimeException("Cannot create an instance of " + modelClass, e);

}

}

NewInstanceFactory创建过程相对简单，通过Class的newInstance()方法直接创建ViewModel实例。

ViewModel的销毁

这里还要分开两处说，一个是在Activity中的销毁过程，一个是在Fragment中销毁过程。

首先我们把目光放到ViewModel类来看下ViewModel销毁时都做了什么。

protected void onCleared() {}

final void clear() {

mCleared = true;

if (mBagOfTags != null) {

synchronized (mBagOfTags) {

for (Object value : mBagOfTags.values()) {

// see comment for the similar call in setTagIfAbsent

closeWithRuntimeException(value);

}

}

}

onCleared();

}

可以看到ViewModel中有clear()方法和onCleared()方法。通过跟踪方法的调用可以知道ViewModel的销毁过程。最终在ViewModelStore类中找到了clear()方法。

public final void clear() {

for (ViewModel vm : mMap.values()) {

vm.clear();

}

mMap.clear();

}

Activity中的销毁

继续跟踪代码可以看到在ComponentActivity中：

public ComponentActivity() {

getLifecycle().addObserver(new LifecycleEventObserver() {

@Override

public void onStateChanged(@NonNull LifecycleOwner source,

@NonNull Lifecycle.Event event) {

if (event == Lifecycle.Event.ON_DESTROY) {

if (!isChangingConfigurations()) {

// 销毁ViewModel

getViewModelStore().clear();

}

}

}

});

}

在ComponentActivity的构造方法中，可以看到通过Lifecycle在ON_DESTROY事件中销毁ViewModel。

Fragment中的销毁

首先通过代码跟踪到ViewModelStore的clear()方法调用的地方，在FragmentManagerViewModel类的clearNonConfigState()方法中找到了ViewModel的销毁逻辑。

void clearNonConfigState(@NonNull Fragment f) {

…

// Clear and remove the Fragment’s ViewModelStore

ViewModelStore viewModelStore = mViewModelStores.get(f.mWho);

if (viewModelStore != null) {

// 销毁ViewModel

viewModelStore.clear();

mViewModelStores.remove(f.mWho);

}

}

如果继续跟踪代码可以看到代码的调用栈是 FragmentStateManager::destroy() -> (Fragment状态切换)->FragmentManager::dispatchDestroy()->FragmentActivity::onDestory()。

这里有个小细节需要注意，也是我在项目中遇到的一个问题。就是ViewModel的销毁在onDestory()中，是晚于onDestoryView()的，所以要注意在使用ViewModel做操作时会不会触发组件更新。不然的话可能造成空指针异常。

ViewModel的生命周期绑定

在上面分了ViewModel的创建与销毁过程中就可以得出ViewModel生命周期是如何与组件交互的了。主要还是通过Lifecycle和组件的生命周期方法来进行回调管理。

Activity重建下的ViewModel

按照上面的逻辑，在Activity重建时会执行destory生命周期事件，那么为什么ViewModel没有销毁呢？

还是直接在代码里找答案，通过对ComponentActivity的getViewModelStore()方法进行分析。可以找到这个问题的答案。

public ViewModelStore getViewModelStore() {

…

if (mViewModelStore == null) {

NonConfigurationInstances nc =

(NonConfigurationInstances) getLastNonConfigurationInstance();

if (nc != null) {

// Restore the ViewModelStore from NonConfigurationInstances

mViewModelStore = nc.viewModelStore;

}

if (mViewModelStore == null) {

mViewModelStore = new ViewModelStore();

}

}

return mViewModelStore;

}

可以看大mViewModelStore变量如果是null的话，会从NonConfigurationInstances实例中取。那么我们就分析NonConfigurationInstances实例的来源。

从NonConfigurationInstances的名称可以大致判断这个类与配置无关。

public final Object onRetainNonConfigurationInstance() {

Object custom = onRetainCustomNonConfigurationInstance();

ViewModelStore viewModelStore = mViewModelStore;

if (viewModelStore == null) {

// No one called getViewModelStore(), so see if there was an existing

// ViewModelStore from our last NonConfigurationInstance

NonConfigurationInstances nc =

(NonConfigurationInstances) getLastNonConfigurationInstance();

if (nc != null) {

viewModelStore = nc.viewModelStore;

}

}

if (viewModelStore == null && custom == null) {

return null;

}

NonConfigurationInstances nci = new NonConfigurationInstances();

nci.custom = custom;