jetpack-ViewModel 源码解析

//通过key 获取value
T getTag(String key) {
if (mBagOfTags == null) {
return null;
}
synchronized (mBagOfTags) {
return (T) mBagOfTags.get(key);
}
}
// 关闭操作
private static void closeWithRuntimeException(Object obj) {
if (obj instanceof Closeable) {
try {
((Closeable) obj).close();
} catch (IOException e) {
throw new RuntimeException(e);
}
}
}
}

---

二、ViewModelStore

ViewModelStore是用来存储 各种ViewModel的，内部是一个HashMap 来保存数据

public class ViewModelStore {
//存放 ViewModel
private final HashMap<String, ViewModel> mMap = new HashMap<>();
//保存ViewModel 如果已经存在，则 触发一次清空逻辑
final void put(String key, ViewModel viewModel) {
ViewModel oldViewModel = mMap.put(key, viewModel);
if (oldViewModel != null) {
oldViewModel.onCleared();
}
}
//通过key 获取 ViewModel
final ViewModel get(String key) {
return mMap.get(key);
}
//获取所有存储的key
Set keys() {
return new HashSet<>(mMap.keySet());
}
//清除所有ViewModel 并触发 clear 操作
public final void clear() {
for (ViewModel vm : mMap.values()) {
vm.clear();
}
mMap.clear();
}
}

ViewModelStore 的获取方式是怎的呢 ？

---

三、 ViewModelStoreOwner

public interface ViewModelStoreOwner {
/**

• Returns owned {@link ViewModelStore}
• @return a {@code ViewModelStore}
  */
  @NonNull
  ViewModelStore getViewModelStore();
  }

ViewModelStoreOwner 是ViewModelStore 的持有者，是个接口类，那就是谁实现了这个接口，谁就是提供ViewModelStore的生产者。

public class ComponentActivity extends androidx.core.app.ComponentActivity implements
ViewModelStoreOwner,
HasDefaultViewModelProviderFactory {

private ViewModelStore mViewModelStore;
private ViewModelProvider.Factory mDefaultFactory;
//实现 ViewModelStoreOwner 接口，可以获取 ViewModelStore
@NonNull
@Override
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) {
  // Restore the ViewModelStore from NonConfigurationInstances
  mViewModelStore = nc.viewModelStore;
  }
  if (mViewModelStore == null) {
  mViewModelStore = new ViewModelStore();
  }
  }
  return mViewModelStore;
  }

//实现 HasDefaultViewModelProviderFactory 接口，对外提供 ViewModelProvider.Factory 生成ViewModel
@NonNull
@Override
public ViewModelProvider.Factory getDefaultViewModelProviderFactory() {
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 (mDefaultFactory == null) {
  mDefaultFactory = new SavedStateViewModelFactory(
  getApplication(),
  this,
  getIntent() != null ? getIntent().getExtras() : null);
  }
  return mDefaultFactory;
  }

}

ComponentActivity 实现了 ViewStoreOwner 和 HasDefaultViewModelProviderFactory 接口 用来返回 ViewModelStore 和 ViewModelProvider.Factory

​ 我们看到 都判断了 getApplication() 为null 的情况下会抛出异常，getApplication 返回的 mApplication 是在 Activity 的 attach中赋值的 ，也就是在 attach 之前会一直为空，这之前使用会抛出异常。

Activity.Java

@UnsupportedAppUsage
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) {
/省略其他代码*/
mApplication = application;
/省略其他代码/

}

四、ViewModelProvider.Factory

我们看到 ViewModelProvider中定义了接口 Factory,实现该接口可以返回一个 Factory.

public interface Factory {
@NonNull
T create(@NonNull Class modelClass);
}

ComponentActivity 默认返回的是 SavedStateViewModelFactory，该类实现了 Factory，并禁用了一个参数的 create 接口，实现了两个参数的接口,需要带一个key：

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

@NonNull
@Override
public T create(@NonNull Class modelClass) {
throw new UnsupportedOperationException("create(String, Class<?>) must be called on "

• “implementaions of KeyedFactory”);
  }

五、ViewModelProvider

ViewModelProvider 有两个成员变量： ViewModel 工厂类，和ViewModel 存储的地方

private final Factory mFactory;
private final ViewModelStore mViewModelStore;

ViewModelProvider 有三个构造方法：

//传入 ViewModelStoreOwner owner 实现接口返回 ViewModelStore 和 Factoty,如果不是 HasDefaultViewModelProviderFactory,则 NewInstanceFactory 生成一个（采用单例）
public ViewModelProvider(@NonNull ViewModelStoreOwner owner) {
this(owner.getViewModelStore(), owner instanceof HasDefaultViewModelProviderFactory
? ((HasDefaultViewModelProviderFactory) owner).getDefaultViewModelProviderFactory()
: NewInstanceFactory.getInstance());
}
//传入 ViewModelStoreOwner owner 实现接口返回 ViewModelStore ，Factory 自定义传入
public ViewModelProvider(@NonNull ViewModelStoreOwner owner, @NonNull Factory factory) {
this(owner.getViewModelStore(), factory);
}
//传入 ViewModelStoreOwner ViewModelStore 和 Factory 自定义传入
public ViewModelProvider(@NonNull ViewModelStore store, @NonNull Factory factory) {
mFactory = factory;
mViewModelStore = store;
}

ViewModelProvider 获取ViewModel有两种方法：

//不传入key，默认key 是 androidx.lifecycle.ViewModelProvider.DefaultKey + modelClass.getCanonicalName()
@NonNull
@MainThread
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);
}

//传入key，如果有已经存在 则返回已经存在的否则生成一个 放入 ViewModelStore 中
@SuppressWarnings(“unchecked”)
@NonNull
@MainThread
public T get(@NonNull String key, @NonNull Class modelClass) {
ViewModel viewModel = mViewModelStore.get(key);
//这里判断了 ViewModel 是都已经存在
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.
}
}
//新生成ViewModel 并放入 ViewModelStore中
if (mFactory instanceof KeyedFactory) {
viewModel = ((KeyedFactory) mFactory).create(key, modelClass);
} else {
viewModel = mFactory.create(modelClass);
}
mViewModelStore.put(key, viewModel);
return (T) viewModel;
}

可以看到 viewModel 是通过 ViewModelStore 按key和 value 存储的，那么就为数据可恢复提供了机制。

六、数据恢复

我们先看下要恢复数据，就要看如何恢复 ViewModelStore

@NonNull
@Override
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) {
  // Restore the ViewModelStore from NonConfigurationInstances
  mViewModelStore = nc.viewModelStore;
  }
  if (mViewModelStore == null) {
  mViewModelStore = new ViewModelStore();
  }
  }
  return mViewModelStore;
  }

可以看到 获取ViewModelStore会先从 NonConfigurationInstances 获取

接下来我们看下 NonConfigurationInstances 这个是从哪里得来的？，可以看到 mLastNonConfigurationInstances 是在activity attach 时参数传入和赋值的

最后

为了方便有学习需要的朋友，我把资料都整理成了视频教程（实际上比预期多花了不少精力）

当程序员容易，当一个优秀的程序员是需要不断学习的，从初级程序员到高级程序员，从初级架构师到资深架构师，或者走向管理，从技术经理到技术总监，每个阶段都需要掌握不同的能力。早早确定自己的职业方向，才能在工作和能力提升中甩开同龄人。

• 无论你现在水平怎么样一定要 持续学习 没有鸡汤，别人看起来的毫不费力，其实费了很大力，这四个字就是我的建议！！
• 我希望每一个努力生活的IT工程师，都会得到自己想要的，因为我们很辛苦，我们应得的。

当程序员容易，当一个优秀的程序员是需要不断学习的，从初级程序员到高级程序员，从初级架构师到资深架构师，或者走向管理，从技术经理到技术总监，每个阶段都需要掌握不同的能力。早早确定自己的职业方向，才能在工作和能力提升中甩开同龄人。

无论你现在水平怎么样一定要 持续学习 没有鸡汤，别人看起来的毫不费力，其实费了很大力，没有人能随随便便成功。

加油，共勉。
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！