ViewModel的基本使用

转载自https://zhuanlan.zhihu.com/p/76361500

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

为此，Android为我们提供了ViewModel类，专门用于存放应用程序页面所需的数据。它将页面所需的数据从页面中剥离出来，页面只需要处理用户交互，以及负责展示数据的工作。

ViewModel将数据从Activity中剥离

另外，如果我们的应用程序支持横竖屏切换，当用户旋转手机屏幕时，我们还需要考虑数据的存储与恢复。如果数据不进行存储，那么通常我们还需要重新去获取一次。

而ViewModel能为我们解决这个问题，它独立于配置变化。也就是说，屏幕旋转导致的Activity重建，并不会影响到ViewModel的生命周期。

ViewModel这个名字可以这样理解：它是介于View（视图）和Model（模型数据）之间的这样一个东西，它起到了桥梁的作用，使得视图和数据既能够分离开，也能够保持通信。

Activity旋转重建与ViewModel生命周期之间的关系

---

接下去，我们一起来看看，如何在代码中实现一个ViewModel。

1.在应用程序的build.gradle中加入依赖。

implementation "android.arch.lifecycle:extensions:1.1.1"

2.写一个继承自ViewModel的类。

 

public class TimerViewModel extends ViewModel
{
    /**
     * 由于屏幕旋转导致的Activity重建，该方法不会被调用
     *
     * 只有ViewModel已经没有任何Activity与之有关联，系统则会调用该方法，你可以在此清理资源
     * */
    @Override
    protected void onCleared()
    {
        super.onCleared();
    }
}

ViewModel是一个抽象类，其中只有一个方法onCleared()，当ViewModel不再被需要的时候，也就是与之相关的Activity都被销毁时，该方法会被系统调用，我们可以在这个方法里面执行一些资源释放的操作，以免内存泄漏。

注意：既然ViewModel的销毁是由系统来判断和执行的，那么系统是如何判断的呢？是根据Context引用。因此，我们在使用ViewModel的时候，千万不能从外面传入Activity，Fragment或者View之类的含有Context引用的东西，否则系统会认为该ViewModel还在使用中，从而无法被系统销毁回收，导致内存泄漏的发生。

3.在页面中使用ViewModel。

TimerViewModel timerViewModel = ViewModelProviders.of(this).get(TimerViewModel.class);

ViewModel的实例化并不是通过普通的new来完成的，而是通过ViewModelProviders来完成。ViewModelProviders会去判断ViewModel是否存在，若存在则直接返回，否则它会去创建一个ViewModel。

4.前面我们提到，ViewModel最重要的作用是将界面和数据分离，并且独立于Activity的重建。为了验证这一点，我们在ViewModel中创建一个Timer计时器，每隔一秒钟，通过接口OnTimeChangeListener通知它的调用者。

public class TimerViewModel extends ViewModel
{
    private String TAG = this.getClass().getName();
    private Timer timer;
    private int currentSecond;

    /**
     * 开始计时
     * */
    public void startTiming()
    {
        if (timer == null)
        {
            currentSecond = 0;
            timer = new Timer();
            TimerTask timerTask = new TimerTask()
            {
                @Override
                public void run()
                {
                    currentSecond++;
                    if(onTimeChangeListener != null)
                    {
                        onTimeChangeListener.onTimeChanged(currentSecond);
                    }
                }
            };
            timer.schedule(timerTask, 1000, 1000);//延迟3秒执行
        }
    }

    /**
     * 通过接口的方式，完成对调用者的通知，这种方式不是太好，更好的方式是通过LiveData组件来实现
     * */
    public interface OnTimeChangeListener
    {
        void onTimeChanged(int second);
    }

    private OnTimeChangeListener onTimeChangeListener;

    public void setOnTimeChangeListener(OnTimeChangeListener onTimeChangeListener)
    {
        this.onTimeChangeListener = onTimeChangeListener;
    }

    /**
     * 由于屏幕旋转导致的Activity重建，该方法不会被调用
     *
     * 只有ViewModel已经没有任何Activity与之有关联，系统则会调用该方法，你可以在此清理资源
     * */
    @Override
    protected void onCleared()
    {
        super.onCleared();
        Log.d(TAG, "onCleared()");
        timer.cancel();
    }
}

接着，在TimerActivity中监听OnTimeChangeListener发来的通知，并据此更新UI界面。

public class TimerActivity extends AppCompatActivity
{

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

    private void iniComponent()
    {
        final TextView tvTime = findViewById(R.id.tvTime);
        //通过ViewModelProviders得到ViewModel，如果ViewModel不存在就创建一个新的，如果已经存在就直接返回已经存在的
        TimerViewModel timerViewModel = ViewModelProviders.of(this).get(TimerViewModel.class);
        timerViewModel.setOnTimeChangeListener(new TimerViewModel.OnTimeChangeListener()
        {
            @Override
            public void onTimeChanged(final int second)
            {
                //更新UI界面
                runOnUiThread(new Runnable()
                {
                    @Override
                    public void run()
                    {
                        tvTime.setText("TIME:" + second);
                    }
                });
            }
        });

        timerViewModel.startTiming();
    }
}

运行程序并旋转屏幕。可以看到，旋转屏幕导致Activity重建时，计时器并没有停止，也就是说，横竖屏状态下Activity对应的ViewModel是同一个。

使用ViewModel，不仅将界面和数据从代码上进行了分离，而且不再需要关心屏幕旋转带来的数据的丢失和获取问题。也许你会说onSaveInstanceState() 方法同样可以解决屏幕旋转带来的数据丢失问题，但它只能保存少量的能支持序列化的数据，而ViewModel没有这个限制，它能支持页面中所有的数据。但要注意的是，ViewModel不支持数据的持久化，当界面彻底销毁，ViewModel及其数据也就不存在了。

我们前面提到过，使用ViewModel的时候，不能将任何含有Context引用的对象传入ViewModel，因为这可能会导致内存泄露。但如果你希望在ViewModel中使用Context怎么办呢？我们可以使用AndroidViewModel类，它继承自ViewModel，并且接收Application作为Context，既然是Application作为Context，也就意味着，我们能够明确它的生命周期和Application是一样的，这就不算是一个内存泄露了。

另外，在本示例中，我们通过自定义接口的方式（OnTimeChangeListener）来实现ViewModel到Activity的通信，这不是一种好的方法，实际上Android为我们提供了LiveData组件来解决这个问题。通过LiveData，当ViewModel中的数据发生变化时，Activity能自动收到通知，从而更新UI。我们在下一章节中继续讨论这个问题。