在说起Jetpack的ViewModel时,我们第一反应都会想到它就是MVVM中的VM。然而这两者并不是等价关系,Jetpack的ViewModel它只是官方为我们提供的一个具体工具,他的作用其实就是一个数据管理容器。而MVVM是一种构架思想,VM是这里面的一层,用来链接V与M层。
由于Jetpack的ViewModel的独有特性我们可以对它进行拓展,使它充当MVVM的VM角色。
1.ViewModel的使用
创建ViewModel
public class MyViewModel extends ViewModel {
public int count;
public int getCount() {
return count;
}
public void setCount(int count) {
this.count = count;
}
}
获取ViewModel对象
public class ViewModelActivity extends AppCompatActivity {
private MyViewModel viewModel;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
viewModel = ViewModelProviders.of(this).get(MyViewModel.class);
viewModel.setCount(2);
viewModel.getCount();
}
}
当然上面的示例代码没有具体意义,但是纯粹使用ViewModel就是这么简单,先抛开ViewModel在MVVM中的使用,我们可以用ViewModel来做些什么呢,它有怎样的优势?
2.ViewModel的使用场景
2.1.横竖屏切换时,Activity重新创建,可以通过ViewModel保存数据。
ViewModel与Activity生命周期关系如下:
可以看到,在屏幕旋转Activity重新创建的过程中,ViewModel一直保持存活。
2.2.同一个Activity下,Fragment之间的数据共享。
我们可以将数据存放到Activity的ViewModel中,在Activity中的Fragment中通过以下代码获取到Activity中的ViewModel,实现数据共享。
viewModel = ViewModelProviders.of(activity).get(MyViewModel.class);
3.ViewModel的实现原理
(下面的源码分析都基于在Activity中使用ViewModel,旨在理清流程,在Fragmeng中的原理大致相同)
3.1.ViewModel的获取
ViewModelProviders.of(activity).get(MyViewModel.class)
--ViewModelProviders.java
public static ViewModelProvider of(@NonNull FragmentActivity activity,
@Nullable Factory factory) {
Application application = checkApplication(activity);
if (factory == null) {
factory = ViewModelProvider.AndroidViewModelFactory.getInstance(application);
}
return new ViewModelProvider(activity.getViewModelStore(), factory);
}
这里需要注意activity.getViewModelStore(),它是一个ViewModelStore对象,ViewModelStore的实现非常简单,内部维护一个HashMap用来存放ViewModel。
public class ViewModelStore {
private final HashMap 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 keys() {
return new HashSet<>(mMap.keySet());
}
public final void clear() {
for (ViewModel vm : mMap.values()) {
vm.clear();
}
mMap.clear();
}
}
ViewModelProviders.of(activity)获取到ViewModelProvider后,通过ViewModelProvider.get(modelClass)获取ViewModel。
--ViewModelProvider.java
private static final String DEFAULT_KEY =
"androidx.lifecycle.ViewModelProvider.DefaultKey";
public T get(@NonNull Class 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);
}
public T get(@NonNull String key, @NonNull Class modelClass) {
ViewModel viewModel = mViewModelStore.get(key);
if (modelClass.isInstance(viewModel)) {
return (T) viewModel;
} else {
if (viewModel != null) {
}
}
if (mFactory instanceof KeyedFactory) {
viewModel = ((KeyedFactory) (mFactory)).create(key, modelClass);
} else {
viewModel = (mFactory).create(modelClass);
}
mViewModelStore.put(key, viewModel);
return (T) viewModel;
}
这里的mViewModelStore就是上面new ViewModelProvider(activity.getViewModelStore(), factory)时传入的activity的ViewModelStore。
整体流程:在获取ViewModel时,先从Acactivitytivity中的ViewModelStore容器中获取,
获取的key为DEFAULT_KEY +ViewModel.class.getCanonicalName()。没有获取到时通过Factory创建对应ViewModel,并添加到Acactivitytivity中的ViewModelStore容器中,下次可以直接获取到。
所以在一个Activity中同一个class对应的ViewModel只会存在一个,这也就是上面场景2的使用基础。
3.2.清楚ViewModel的获取流程后,接下来看ViewModel怎样做到旋转屏幕依然保持存活的。
我们知道Activity在屏幕旋转时默认会重新创建Activity,新的Activity是不会保存原Activity的数据的,那ViewModel是怎样跨Activity对象得到保存的呢?
根据3.1我们知道ViewModel存放在Activity的ViewModelStore中,我们看一下activity.getViewModelStore():
--ComponentActivity.java
public ViewModelStore getViewModelStore() {
if (getApplication() == null) {
throw new IllegalStateException("Your activity is not yet attached to the "
+ "Application instance. You can't request ViewModel before onCreate call.");
}
if (mViewModelStore == null) {
NonConfigurationInstances nc =
(NonConfigurationInstances) getLastNonConfigurationInstance();
if (nc != null) {
mViewModelStore = nc.viewModelStore;
}
if (mViewModelStore == null) {
mViewModelStore = new ViewModelStore();
}
}
return mViewModelStore;
}
第一次获取ViewModelStore时,会先调用getLastNonConfigurationInstance()获取到一个NonConfigurationInstances对象,并尝试从NonConfigurationInstances中获取ViewModelStore,没有获取到时才会创建一个ViewModelStore;
--ComponentActivity.java
NonConfigurationInstances mLastNonConfigurationInstances;
public Object getLastNonConfigurationInstance() {
return mLastNonConfigurationInstances != null
? mLastNonConfigurationInstances.activity : null;
}
final void attach(Context context, ActivityThread aThread,
Instrumentation instr, IBinder token, int ident,
Application application, Intent intent, ActivityInfo info,
CharSequence title, Activity parent, String id,
NonConfigurationInstances lastNonConfigurationInstances,
Configuration config, String referrer, IVoiceInteractor voiceInteractor,
Window window, ActivityConfigCallback activityConfigCallback, IBinder assistToken) {
......
mLastNonConfigurationInstances = lastNonConfigurationInstances;
......
}
mLastNonConfigurationInstances是ComponentActivity中的一个变量,它在Activity创建时attach()中被系统传入。
mLastNonConfigurationInstances.activity的保存发生在
public final Object onRetainNonConfigurationInstance() {
Object custom = onRetainCustomNonConfigurationInstance();
ViewModelStore viewModelStore = mViewModelStore;
if (viewModelStore == null) {
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;
}
最后还有一个小细节,在androidx.activity.ComponentActivity的构造方法中对当前Activity的生命周期进行了监听。
androidx.activity.ComponentActivity.java
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()) {
getViewModelStore().clear();
}
}
}
});
}
可以看到Activity在Destroy时,如果不是屏幕旋转才会清空tViewModelStore()中的ViewModel。