【Android】ViewModel原理分析

概述

本文主要通过分析ViewModel源码解决以下两个疑问：
1、ViewModel如何保证的唯一性
2、ViewModel如何保证数据不丢失的

---

为了解决这些问题，从ViewModel的构造开始，一般创建ViewModel的方法如下：

ViewModelProvider(this, defaultViewModelProviderFactory).get(MyViewModel::class.java)

很明显，ViewModel的创建使用了工厂模式，这里使用默认工厂，接下来看一下get方法：

public <T extends ViewModel> T get(@NonNull Class<T> modelClass) {    String canonicalName = modelClass.getCanonicalName();    
	if (canonicalName == null) {        
	throw new IllegalArgumentException("Local and anonymous classes can not be ViewModels");    
	}    
	return get(DEFAULT_KEY + ":" + canonicalName, modelClass);  // 1
}

在注释1继续追踪，可以看到如下代码：

public <T extends ViewModel> T get(@NonNull String key, @NonNull Class<T> modelClass) {
    ViewModel viewModel = mViewModelStore.get(key);

    if (modelClass.isInstance(viewModel)) {
        if (mFactory instanceof OnRequeryFactory) {
            ((OnRequeryFactory) mFactory).onRequery(viewModel);
        }
        return (T) viewModel;
    } else {
        //noinspection StatementWithEmptyBody
        if (viewModel != null) {
            // TODO: log a warning.
        }
    }
    if (mFactory instanceof KeyedFactory) {
        viewModel = ((KeyedFactory) mFactory).create(key, modelClass);
    } else {
        viewModel = mFactory.create(modelClass);
    }
    mViewModelStore.put(key, viewModel);
    return (T) viewModel;
}

这里通过key（就是之前传过去自己实现的ViewModel的类的名字）在mViewModelStore中拿出了viewModel。重点来了，mViewModelStore涉及到了之前提到的一个问题，ViewModel如何保证唯一性的。mViewModelStore是一个ViewModelStore对象，接下来看一下这个对象：

public class ViewModelStore {

    private final HashMap<String, ViewModel> mMap = new HashMap<>();

    final void put(String key, ViewModel viewModel) {
        ViewModel oldViewModel = mMap.put(key, viewModel);
        if (oldViewModel != null) {
            oldViewModel.onCleared();
        }
    }

    final ViewModel get(String key) {
        return mMap.get(key);
    }

    Set<String> keys() {
        return new HashSet<>(mMap.keySet());
    }

    /**
     *  Clears internal storage and notifies ViewModels that they are no longer used.
     */
    public final void clear() {
        for (ViewModel vm : mMap.values()) {
            vm.clear();
        }
        mMap.clear();
    }
}

可以看出底层是通过一个Map来存储ViewModel实例的，同时这个Map也保证了一个Activity中只能有一个对应类型的ViewModel存在，为了进一步说明，可以看到ViewModelProvider的构造方法

public ViewModelProvider(@NonNull ViewModelStoreOwner owner, @NonNull Factory factory) {
    this(owner.getViewModelStore(), factory);
}

这里的ViewModelStoreOwner是一个接口，很多Activity以及Fragment都实现了这个接口，这里以AppCompatActivity为例：

AppCompatActivity继承自FragmentActivity，FragmentActivity继承自ComponentActivity，在ComponentActivity实现了ViewModelStoreOwner接口，这里会通过ensureViewModelStore创建ViewModelStore。

void ensureViewModelStore() {
    if (mViewModelStore == null) {
        NonConfigurationInstances nc =
                (NonConfigurationInstances) getLastNonConfigurationInstance();	//1
        if (nc != null) {
            // Restore the ViewModelStore from NonConfigurationInstances
            mViewModelStore = nc.viewModelStore;
        }
        if (mViewModelStore == null) {
            mViewModelStore = new ViewModelStore();
        }
    }
}

注释1处会拿到onRetainNonConfigurationInstance方法的返回值

public final Object onRetainNonConfigurationInstance() {
    // Maintain backward compatibility.
    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;
    nci.viewModelStore = viewModelStore;
    return nci;
}

可以看出这里保存了一个NonConfigurationInstances实例，这个实例中保存之前的viewModelStore实例，这就是ViewModel不会随着Activity销毁而销毁的原因，具体是在什么时机调用的可以继续追踪，最后，可以得到如下调用链：

onRetainNonConfigurationInstance -> LocalActivityManager.dispatchRetainNonConfigurationInstance -> ActivityGroup.onRetainNonConfigurationChildInstances -> Activity.retainNonConfigurationInstances -> ActivityThread.performDestroyActivity

也就是说在Activity执行destroy方法的时候会保存一下当时的信息，ViewModel也在那个时候被保存下来了。

---

总结

现在回到上面那两个问题：

1、如何保证的唯一性
ViewModel是根据ViewModel实现类的名字保存在一个HashMap中的，HashMap保证了ViewModel的唯一性

2、如何保证数据不丢失的
在Activity执行destory方法的时候，会保存当前的ViewModelStore，等到下次重走生命周期的时候会重新拿到上次的ViewModel，也就保证了数据不会发生丢失。