学习记录（4） - ViewModel

前言

学习记录系列是通过阅读学习《Android Jetpack应用指南》对书中内容学习记录的Blog，《Android Jetpack应用指南》京东天猫有售，本文是学习记录的第四篇。

诞生

在页面（Activity/Fragment）功能较为简单的情况下，通常会将UI交互、与数据获取等相关的业务逻辑全部写在页面中。但是在页面功能复杂的情况下，这样做是不合适的，因为它不符合“单一功能原则”。页面只应该负责处理用户与UI控件的交互，并将数据展示到屏幕上。与数据相关的业务逻辑应该单独处理和存放。

单一功能原则：在维基百科中关于“单一功能原则”的定义。在面向对象编程领域中，单一功能原则（Single responsibility principle）规定每个类都应该有一个单一的功能，并且该功能应该由这个类完全封装起来。这个类的所有服务都应该严密地和该功能平行（功能平行，意味着没有依赖）

简介

ViewModel专门用于存放在应用程序页面所需的数据。ViewModel 是介于 View（视图）和 Model（数据模型）之间的一个东西。它起到了桥梁的作用，使视图和数据既能够分离开，也能够保持通信。
如图所示，ViewModel将页面所需的数据从页面中剥离出来，页面只需要处理用户交互和展示数据

image.png

ViewModel 的生命周期

ViewModel 生命周期是贯穿整个 activity 生命周期，包括 Activity 因旋转造成的重创建，直到 Activity 真正意义上销毁后才会结束。既然如此，用来存放数据再好不过了。

image.png

ViewModel 的基本使用方法

1.在 app 的 build.gradle 中添加依赖。

dependencies {
    添加ViewModel依赖
    implementation 'androidx.lifecycle:lifecycle-viewmodel:2.2.0'
}

2.写一个继承自 ViewModel 的类，将其命名为 TimerViewModel

public class TimerViewModel extends ViewModel {

    @Override
    protected void onCleared() {
        super.onCleared();
    }
}

ViewModel 是一个抽象类，其中只有一个 onCleared()方法。当 ViewModel 不再被需要，即与之相关的 Activity 都被销毁时，该方法会被系统调用。可以在该方法中执行一些资源释放的相关操作。注意，由于屏幕旋转而导致的 Activity 重建，并不会调用该方法。

3.前面提到，ViewModel 最重要的作用时将视图与数据分离，并独立与 Activity 的重建。为了验证这一点，在 ViewModel 中创建一个计时器 Timer，每隔 1s，通过接口 OnTimerChangeListener 通知它的调用者。

public class TimerViewModel extends ViewModel {

    private Timer timer;
    private int currentSecond;

    /**
     * ViewModel最重要的作用是将视图与数据分离，并独立于Activity的重建。
     * 为了验证这样一点，在ViewModel中创建一个计时器Timer，每隔1s通过接口
     * OnTimerChangeListener通知它的调用者
     */
    public void startTiming() {

        if (timer == null) {

            currentSecond = 0;

            timer = new Timer();
            TimerTask timerTask = new TimerTask() {
                @Override
                public void run() {
                    currentSecond ++;
                    if (onTimerChangeListener != null) {
                        onTimerChangeListener.onTimeChanged(currentSecond);
                    }
                }
            };
            timer.schedule(timerTask, 1000, 1000);
        }
    }

    /**
     * 通过接口的方式完成对调用者的通知
     */
    public interface OnTimerChangeListener {

        void onTimeChanged(int currentSecond);
    }

    private OnTimerChangeListener onTimerChangeListener;

    public void setOnTimerChangeListener(OnTimerChangeListener onTimerChangeListener) {
        this.onTimerChangeListener = onTimerChangeListener;
    }

    /**
     * ViewModel是一个抽象类，其中只有一个onCleared()方法。
     * 当ViewModel不再被需要，即与之相关的Activity都被销毁时，
     * 该方法会被系统调用。可以在该方法中执行一些资源释放相关操作
     */
    @Override
    protected void onCleared() {
        super.onCleared();
        timer.cancel();
    }
}

4.在 TimerActivity 中监听 OnTimerChangeListener 发来的通知，并根据通知更新 UI 界面。ViewModel 的实例化过程，是通过 ViewModelProvider 来完成的。ViewModelProvider 会判断 ViewModel 是否存在，若存在则直接返回，否则它会创建一个 ViewModel。

public class TimerActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_timer);

        initComponent();
    }

    private void initComponent() {
        final TextView tvTimer = findViewById(R.id.tv_timer);
        // 实例化ViewModel
        TimerViewModel testViewModel = new ViewModelProvider(this).get(TimerViewModel.class);
        testViewModel.setOnTimerChangeListener(currentSecond -> {
            // 更新UI界面
            runOnUiThread(new Runnable() {
                @Override
                public void run() {
                    tvTimer.setText("Timer: " + currentSecond);
                }
            });
        });
        testViewModel.startTiming();
    }
}

运行程序并旋转屏幕，当旋转屏幕导致 Activity 重建时，计时器没有停止。这意味着在横/竖屏状态下的 Activity 所对应的 ViewModel 是同一个，它并没有被销毁，它所持有的数据也一直到存在着。

ViewModel 的原理

在页面中通过 ViewModelProvider 类来实例化 ViewMdeol

TestViewModel testViewModel = new ViewModelProvider(this).get(TestViewModel.class);

ViewModelPrivider 接收一个 ViewModelStoreOwner 对象作为参数。在以上示例代码中该参数是 this ，指代当前的 Activity。这是因为 Activity 继承自 FragmentActivity，而在 androidx 依赖包中，FragmentActivity 默认实现 ViewModelStoreOwner 接口。

public class FragmentActivity extends ComponentActivity implements
        ActivityCompat.OnRequestPermissionsResultCallback,
        ActivityCompat.RequestPermissionsRequestCodeValidator {
...
        @NonNull
        @Override
        public ViewModelStore getViewModelStore() {
            return FragmentActivity.this.getViewModelStore();
        }
...
}

接口方法 getViewModelStore() 所定义的返回类型为 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();
    }
}

从 ViewModelStore 的源码可以看出，ViewModel 实际是以 HashMap<String，ViewModel>的形式被缓存起来了。ViewModel 与页面之间没有直接的关联，它们通过 ViewModelProvider 进行关联。当页面需要 ViewModel 时，会向 ViewModelProvider 索要，ViewModelProvider 检查该 ViewModel 是否已经存在于缓存中，若存在，则直接返回，若不存在，则实例化一个。因此，Activity 由于配置变化导致的销毁重建并不会影响 ViewModel ，ViewModel 是独立于页面存在的。也正因为此，在使用 ViewModel 时需要特别注意，不需要向 ViewModel 中传入任何类型的 Context 或带有 Context 引用的对象，这可能会导致页面无法被销毁，从而引发内存泄漏。
需要注意的是，除了 Activity，androidx 依赖包中的 Fragment 也默认实现了 ViewModelStoreOwner 接口。因此，也可以在 Fragment 中正常使用 ViewModel。

ViewModel 与 AndroidViewModel

ViewModel 中不能将任何类型和 Context 或含有 Context引用的对象传入到 ViewModel 中，因为这可能会导致内存泄漏。如果希望在 ViewModel 中使用 Context，可以使用 AndroidViewModel 类，它继承自 ViewModel，并接收 Application 作为 Context。这意味着，它的生命周期和 Application 是一样的，那么这就不算是一个内存泄漏了。

ViewModel 与 onSaveInstanceState()方法

1.onSaveInstanceState()方法只能保存少量的、能支持序列化的数据。ViewModel没有这个限制
2.ViewModel 能支持页面中所有的数据。ViewModel 不支持数据的持久化，当页面被彻底销毁时，ViewModel 及持有的数据就不存在了。onSaveInstanceState()方法可以持久化页面的数据。
3.二者不可混淆

总结

ViewModel 可以帮助我们更好地将页面与数据从代码层间上分离开来。更重要的是，依赖于 ViewModel 的生命周期特性，我们不再需要关心屏幕旋转带来的数据丢失的问题，进而也不需要重新获取数据。
需要注意的是，在使用 ViewModel 的过程中，千万不要将任何类型的 Context 或含有 Context引用的对象传入到 ViewModel ，这可能会引起内存泄漏。如果一定要在 ViewModel 中使用 Context，那么建议使用 ViewModel 的子类 AndroidViewModel。