【Android Jetpack 高手日志】ViewModel 从入门到精通，kotlin 中文文档
可以看到ViewModelStore的代码很简单，就是用一个 HashMap 存储了key(String)和value(ViewModel)，这里的 key 的名字为
// key 的名字
DEFAULT_KEY + ":" + canonicalName
private static final String DEFAULT_KEY =
"androidx.lifecycle.ViewModelProvider.DefaultKey";
String canonicalName = modelClass.getCanonicalName();
因为第二个参数是通过getDefaultViewModelProviderFactory()获取到的，前面说过Activity是 HasDefaultViewModelProviderFactory的实现类，我们再来看看Activity中的getDefaultViewModelProviderFactory()方法
@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;
}
可以看到是通过一个SavedStateViewModelFactory来获取ViewModelProvider.Factory，命名也很清晰直观，就是保存状态的 ViewModel 工厂。
下面我们再来看看get(AccountViewModel::class.java)方法
@NonNull
@MainThread
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); //key 的名字
}
@SuppressWarnings("unchecked")
@NonNull
@MainThread
public <T extends ViewModel> T get(@NonNull String key, @NonNull Class<T> modelClass) {
ViewModel viewModel = mViewModelStore.get(key); //从 hashmap 中获取 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.
}
}
//使用 Factory 创建
if (mFactory instanceof KeyedFactory) {
viewModel = ((KeyedFactory) (mFactory)).create(key, modelClass);
} else {
viewModel = (mFactory).create(modelClass);
}
//存入 viewModelStore
mViewModelStore.put(key, viewModel);
return (T) viewModel;
}
简单来说就是从mViewModelStore获取 ViewModel，如果没有获取到，就使用 Factory 创建，然后存入mViewModelStore。
这样逻辑就清楚了，ViewModelProvider(this).get(AccountViewModel::class.java)会把ViewModel存入ViewModelStore中。
因为 Activity 实现了ViewModelStoreOwner 接口，可以理解为 ViewModelStore（ViewModel 存储器）的拥有者，也就是说我们的 Activity/Fragment 是 ViewModel 存储器的拥有者。
public interface ViewModelStoreOwner {
/**
Returns owned {@link ViewModelStore}
@return a {@code ViewModelStore}
*/
@NonNull
ViewModelStore getViewModelStore();
}
然后我们来看看该方法在 Activity 中的实现
@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) {
//从 getLastNonConfigurationInstance 获取
NonConfigurationInstances nc =
(NonConfigurationInstances) getLastNonConfigurationInstance();
if (nc != null) {
//恢复 viewmodelstore
// Restore the ViewModelStore from NonConfigurationInstances
mViewModelStore = nc.viewModelStore;
}
//如果还是获取不到，就新建一个
if (mViewModelStore == null) {
mViewModelStore = new ViewModelStore();
}
}
return mViewModelStore;
}
从该方法中可以看到，Activity（ViewModelStoreOwner）内部最终会创建一个ViewModelStore，用来存储ViewModel，接下来我们来看getLastNonConfigurationInstance方法
//ComponentActivity.java
NonConfigurationInstances mLastNonConfigurationInstances;
@Nullable
public Object getLastNonConfigurationInstance() {
return mLastNonConfigurationInstances != null
? mLastNonConfigurationInstances.activity : null;
}
static final class NonConfigurationInstances {
Object custom;
ViewModelStore viewModelStore;
}
为什么使用 getLastNonConfigurationInstance 方法呢，我们先来看看 Activity 状态保存和恢复：
[](
)onSaveInstanceState和onRetainNonConfigurationInstance 的使用场景区别
我们知道，在屏幕旋转的时候会执行保存状态和恢复状态的方法
@Override
protected void onSaveInstanceState(Bundle outBundle) { //保存
super.onSaveInstanceState(outBundle);
}
@Override
protected void onRestoreInstanceState(Bundle savedInstanceState) { //恢复
super.onRestoreInstanceState(savedInstanceState);
}
//注意，如果你是继承 AppcompactActiviy，该方法已经在它的父类 ComponentActivity 定义为 final,子类无法重写
//继承 Activity 就可以
public Object onRetainNonConfigurationInstance() {
// TODO Auto-generated method stub
// 在这里设置需要保存的内容，在切换时不是 bundle 了，我们可以直接通过 object 来代替。
return super.onRetainNonConfigurationInstance();
}
@Nullable
@Override
public Object getLastNonConfigurationInstance() {
return super.getLastNonConfigurationInstance();
}
在 Android 10，他们的执行顺序都在onStop和onDestory之间，而且onSaveInstanceState比onRetainNonConfigurationInstance先执行，一般情况我们保存的数据不是太大，适合放在 Bundle 中，这个时候使用onSaveInstanceState比较合适，如果要保存的数据不适合放在 Bundle 中（比如： 一个 socket）或是数据比较大（比如 Bitmap），那么这个时间我们就应该使用onRetainNonConfigurationInstance()，而且我们使用onRetainNonConfigurationInstance()可以保存任何类型的对象，像AsyncTask和SQLiteDatabse，我们都可以进行保存。这些类型的数据可能会被一个新的Activity重新使用。
也就是说 Bundle 中只能放一些特定的类型，比如基本数据类型，数组，Serialable 对象，而onRetainNonConfigurationInstance中只要是个 Object 对象就可以了。
同时当某个activity变得“容易”被系统销毁时，该activity的onSaveInstanceState就会被执行，而onRetainNonConfigurationInstance更多的是时候是在配置改变时操作的，这个时候保存一些不会因为配置改变而发生改变的东西，而且onSaveInstanceState数据是序列化保存到磁盘中。而onRetainNonConfigurationInstance保存的数据是存在内存中。
所以这里我们的 ViewModel 肯定是放在onRetainNonConfigurationInstance方法中，再来看看
//ComponentActivity.java
@Override
@Nullable
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，将 viewModelStore 保存
NonConfigurationInstances nci = new NonConfigurationInstances();
nci.custom = custom;
nci.viewModelStore = viewModelStore;
return nci;
}
可以看到在该方法中保存了viewModelStore，保存在了NonConfigurationInstances。而该getLastNonConfigurationInstance的真正实现是在 Activity.java 类中
//Activity.java
//静态内部类
static final class NonConfigurationInstances {
Object activity;
HashMap<String, Object> children;
FragmentManagerNonConfig fragments;
ArrayMap<String, LoaderManager> loaders;
VoiceInteractor voiceInteractor;
}
NonConfigurationInstances mLastNonConfigurationInstances;
@Nullable
public Object getLastNonConfigurationInstance() {
return mLastNonConfigurationInstances != null
? mLastNonConfigurationInstances.activity : null;
}
而mLastNonConfigurationInstances的赋值是在attach方法中的mLastNonConfigurationInstances = lastNonConfigurationInstances;，
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) {
attachBaseContext(context);
···
mLastNonConfigurationInstances = lastNonConfigurationInstances;
···
[](
)为什么 ViewModel 在配置变化后依旧存在？
而attach中的传入的参数lastNonConfigurationInstances是ActivityClientRecord的一个变量，而ActivityClientRecord是存在ActivityThread的mActivities(ArrayMap)中，ActivityThread中的ActivityClientRecord不受activity重建的影响，所以ActivityThread中的lastNonConfigurationInstances同样也不受影响，所以ComponentActiviy中的NonConfigurationInstances也无影响，所以ViewModelStore不受影响，最终ViewModel在Activity重新创建后调用getLastNonConfigurationInstance获取得到，这也是ViewModel一直存在的原因。
在更早之前版本保存 ViewModel 是使用HolderFragment的，Fragment 中的setRetainInstance(boolean)在设置为 true 时可以是当前的 Fragment 在 Activity 重建时存储下来，所以可以在 Activity 中注入一个 Fragment，这样就可以达到保存 ViewModel 的功能了。详情可以参考这篇[文章](
)。
[](
)Fragment 之间是如何通过 ViewModel 共享数据的？
从上面的分析，我们知道ViewModel存在Activity的ViewModelStore中，多个 Fragment 依赖于同一个 Activity，这个时候拿到同一个ViewModel自然就不是问题了。
[](
)为什么旋转后所有的 LiveData 会重新执行一次通知
原因很简单，因为 LiveData 的事件是粘性事件，也就是说当 Activity 销毁后，因为 ViewModel 中的 LiveData 并没有销毁（有具体的值），在 Activity 重新创建后，LiveData 会将该值发送给当前 Activity 界面，达到恢复 Activity 界面状态的效果。
[](
)ViewModel 如何避免内存泄漏
在ComponentActivity的构造器中可以看出，getLifecycle().addObserver添加了一个观察者观察界面是否销毁，一旦销毁，就清空ViewModelStore中的所有ViewModel。
public ComponentActivity() {
Lifecycle lifecycle = getLifecycle();
//noinspection ConstantConditions
if (lifecycle == null) {
throw new IllegalStateException("getLifecycle() returned null in ComponentActivity's "
"constructor. Please make sure you are lazily constructing your Lifecycle "
"in the first call to getLifecycle() rather than relying on field "
"initialization.");
}
if (Build.VERSION.SDK_INT >= 19) {
getLifecycle().addObserver(new LifecycleEventObserver() {
@Override
public void onStateChanged(@NonNull LifecycleOwner source,
@NonNull Lifecycle.Event event) {
if (event == Lifecycle.Event.ON_STOP) {
Window window = getWindow();
final View decor = window != null ? window.peekDecorView() : null;
if (decor != null) {
decor.cancelPendingInputEvents();
}
}
}
});
}
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(); //界面执行 onDestroy 方法是，清空 viewmodel
}
}
}
});
if (19 <= SDK_INT && SDK_INT <= 23) {
getLifecycle().addObserver(new ImmLeaksCleaner(this));
}
}
[](
)ViewModel 和协程一起使用
ViewModel 支持协程，ViewMdoelScope 为应用中的每个ViewModel定义了ViewMdoelScope，如果 ViewModel 已清除，则在此范围内启动的协程都会自动取消。如果您具有仅在 ViewModel 处于活动状态时才需要完成的工作，此时协程非常有用。例如，如果要为布局计算某些数据，则应将工作范围限定至 ViewModel，以便在 ViewModel 清除后，系统会自动取消工作以避免消耗资源。
viewModelScope.launch {
// Coroutine that will be canceled when the ViewModel is cleared.
}
Android Jetpack 的这些架构组件配合起来会非常强大，大大节省开发者的开发时间，同时还能轻松避免内存泄漏，简直就是开发利器。
[](
)总结
ViewModel 是个非常好用的 Android Jetpack 组件，可在发生屏幕旋转等配置更改后继续留存，同时还能在不同 Fragment 之间共享，在配合协程使用时也非常方便，还能轻松避免内存泄漏。
需要注意的是，不少开发者会将 ViewModel 实现 LifecycleObserver 接口，把 ViewModel 当做一个能感应生命周期变化的组件，在感知到生命周期的方法中执行loadData之类的操作，然后通过 LiveData 去通知 UI 做出对应的改变，这样的做法丧失了官方为我们设计的 ViewModel 的初衷，反而有点不伦不类了。而且 ViewModel 配合协程也非常方便，也有很多人将网络请求也放到 ViewModel 去调用，个人感觉也是很不合适的，可以参考官方的[Demo](
)进行设计。
[](
)文末的话
最近火热的 Jetpack Compose 是谷歌在 2019Google i/o 大会上发布的新的库，是用于构建原生 Android UI 的现代工具包。他有强大的工具和直观的 Kotlin API，简化并加速了 Android 上的 UI 开发。可以帮助开发者用更少更直观的代码创建 View，还有更强大的功能，以及还能提高开发速度。
客观地讲，Compose 确实是一套比较难学的东西，因为它毕竟太新也太大了，它是一个完整的、全新的框架，确实让很多人感觉「学不动」，这也是个事实。
如果你是因为缺少学习资料，而我正好薅到这本谷歌内部大佬根据实战编写的《Jetpack Compose 最全上手指南》，从入门到精通，教程通俗易懂，实例丰富，既有基础知识，也有进阶技能，能够帮助读者快速入门，是你学习 Jetpack Compose 的葵花宝典，快收藏起来！！！
[](
)由于篇幅原因，如有需要以下完整学习笔记 PDF，可以点击[我的 GitHub](
)免费下载获取！
[](
)第一章 初识 Jetpack Compose
1. 为什么我们需要一个新的 UI 工具？
2. Jetpack Compose 的着重点
加速开发
强大的 UI 工具
直观的 Kotlin API
3. API 设计
4. Compose API 的原则
一切都是函数
顶层函数（Top-level function）
组合优于继承
信任单一来源
5. 深入了解 Compose
Core
Foundation
Material
插槽 API
[](
)第二章 Jetpack Compose 构建 Android UI
1. Android Jetpack Compose 最全上手指南
Jetpack Compose 环境准备和 Hello World
布局
使用 Material design 设计
Compose 布局实时预览
……
2. 深入详解 Jetpack Compose | 优化 UI 构建
Compose 所解决的问题
Composable 函数剖析
声明式 UI
组合 vs 继承
封装
重组
……
3. 深入详解 Jetpack Compose | 实现原理
@Composable 注解意味着什么？
执行模式
Positional Memoization (位置记忆化)
存储参数
重组
……
[](
)第三章 Jetpack Compose 项目实战演练（附 Demo）
1. Jetpack Compose 应用 1
开始前的准备
创建 DEMO
遇到的问题
2. Jetpack Compose 应用 2
3. Jetpack Compose 应用做一个倒计时器
数据结构
倒计时功能
状态模式
Compose 布局
绘制时钟
4. 用 Jetpack Compose 写一个玩安卓 App
准备工作
引入依赖
新建 Activity
创建 Compose
PlayTheme
画页面
底部导航栏
管理状态
添加页面
5. 用 Compose Android 写一个天气应用
开篇
画页面
画背景
画内容
……
6. 用 Compose 快速打造一个“电影 App”
还未添加个人签名 2021.10.31 加入
还未添加个人简介
评论