Android架构之ViewModel组件

Jetpack组件系列文章
Android架构之LifeCycle组件
Android架构之Navigation组件(一)
Android架构之Navigation组件(二)
Android架构之Navigation组件(三)
Android架构之Navigation组件(四)
Android架构之ViewModel组件
Android架构之LiveData组件
Android架构之Room组件(一)
Android架构之Room组件(二)
Android架构之WorkManager组件
Android架构之DataBinding(一)
Android架构之DataBinding(二)
Android架构之Paging组件(一)
Android架构之Paging组件(二)
Jetpack与MVVM架构

ViewModel简介

视图与数据模型之间的桥梁ViewModel

在页面(Activity/Fragment)功能较为简单的情况下，我们通常会将UI交互、与数据获取等相关的业务逻辑全部写在页面中。但是在页面功能复杂的情况下，代码量会变的非常多，也违反了"单一功能原则"。 页面只应该负责处理用户与UI控件的交互，并将数据展示到屏幕上，而数据获取相关的业务逻辑应该单独处理和存放。
为了解决这个问题，Android为我们提供了ViewModel类，专门用于存放页面所需的数据。
ViewModel可以这么理解: 它是介于View(视图)和Model(数据模型)之间的一个东西。它起到了桥梁的作用，使视图和数据既能分离，也能保持通信。

ViewModel的生命周期

如下图所示:

ViewModel的生命周期会比创建它的Activity、Fragment的生命周期都要长。即ViewModel中的数据会一直存活在Activity/Fragment中。

众所周知，由于Android平台的特殊性，若应用程序发送屏幕旋转的时候会经历Activity的销毁与重建，这里就涉及到数据保存的问题。虽然Activity可以通过onSaveInstanceState()机制保存与恢复数据，但是onSaveInstanceState()方法只能存储少量的数据进行恢复，但是遇到大量的数据该怎么办呢？

幸运的是,ViewModel能完美的为我们解决这个问题，ViewModel有自己独立的生命周期，屏幕旋转所导致的Activity重建，并不会影响ViewModel的生命周期.

ViewModel的使用

添加依赖

在app的build.gradle中添加依赖

dependencies {
	implementation "androidx.lifecycle:lifecycle-viewmodel:2.2.0"
}

写一个继承自ViewModel的类

将其命名为TimerViewModel

public class TimerViewModel extends ViewModel {
    @Override
    protected void onCleared() {
        super.onCleared();
    }
   } 

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

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

public class TimerViewModel extends ViewModel {
    private Timer timer;
    private  int currentSecond;
    @Override
    protected void onCleared() {
        super.onCleared();
        //清理资源
        timer.cancel();
    }

    //开始计时
    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);
        }
    }
    private  OnTimeChangeListener onTimeChangeListener;

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

    public  interface  OnTimeChangeListener{
        void onTimeChanged(int second);
    }

}

我们可以在onCleared()对定时器资源的释放，防止造成内存泄露。通过接口的方式，完成对调用者的通知，实际上这种方式不是很好，更好的方式是通过LiveData组件来实现，后面我会进行讲到的。

编写TimerActivity

ViewModel的实例化过程，是通过ViewModelProvider来完成的。ViewModelProvider会判断ViewModel是否存在，若存在则直接返回，否则它会创建一个ViewModel. 代码如下:

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 textView = findViewById(R.id.textview);
        TimerViewModel timerViewModel =  new ViewModelProvider(this).get(TimerViewModel.class);
        timerViewModel.setOnTimeChangeListener(new TimerViewModel.OnTimeChangeListener() {
            @Override
            public void onTimeChanged(final int second) {
                //更新UI
                runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                        textView.setText("TIME:"+second);
                    }
                });
            }
        });
        timerViewModel.startTiming();
    }
}

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

ViewModel的原理

我们在页面中通过ViewModelProvider类来实例化ViewModel

 TimerViewModel timerViewModel =  new ViewModelProvider(this).get(TimerViewModel.class);

查看ViewModelProvider的源码知道ViewModelProvider的构造函数是接收一个ViewModelStoreOwner对象作为参数

 public ViewModelProvider(@NonNull ViewModelStoreOwner owner) {
        this(owner.getViewModelStore(), owner instanceof HasDefaultViewModelProviderFactory
                ? ((HasDefaultViewModelProviderFactory) owner).getDefaultViewModelProviderFactory()
                : NewInstanceFactory.getInstance());
    }

看到这里，大家是否都有个疑问，明明ViewModelProvider需要传入ViewModelStoreOwner对象，那为什么我们传入this(当前Activity)就可以实例化呢?
因为TimerActivity继承自AppCompatActivity, AppCompatActivity继承自FragmentActivity，FragmentActivity继承自ComponentActivity,而ComponentActivity实现了ViewModelStoreOwner接口,这个接口中有一个
getViewModelStore()方法返回的是ViewModelStore

public class ComponentActivity extends androidx.core.app.ComponentActivity implements
        LifecycleOwner,
        ViewModelStoreOwner,
        HasDefaultViewModelProviderFactory,
        SavedStateRegistryOwner,
        OnBackPressedDispatcherOwner 
.....

@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 的源码

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会去HashMap中检查该ViewModel是否已经存在缓存中，若存在，则直接返回，否则，则实例化一个。因此，Activity由于屏幕旋转导致的销毁重建并不会影响ViewModel.

但是，我们在使用ViewModel，需要注意的时，不要向ViewModel中传入任何类型的Context或带有Context引用的对象，可能会导致页面无法销毁，从而引发内存泄露。
需要注意的是，除了Activity,Fragment也默认实现了ViewModelStoreOwner接口，因此，我们也可以在Fragment中正常使用ViewModel;

ViewModel与AndroidViewModel

如果你希望在VIewModel中使用Context对象(例如，为了查找系统服务)，可以使用AndroidViewModel类，它继承自ViewMoel,并接收Application作为Context.。因为Application会扩展Context,代码如下

public class TimerViewModel extends AndroidViewModel {
	 public TimerViewModel(@NonNull Application application) {
        super(application);
    }
}

ViewModel与onSaveInstanceState()方法

onSaveInstanceState()方法

onSaveInstanceState()方法只能保存少量的、能支持序列化的数据，但是onSaveInstanceState()方法可以持久化页面的数据。

ViewModel

ViewModel能支持页面中所有的数据，但是需要注意的是，ViewModel不支持数据的持久化，当页面被彻底销毁时，ViewModel及其持有的数据就不存在。

大家需要了解onSaveInstanceState()方法和ViewModel的区别，二者不可混淆。

在Fragment之间共享数据

由于前面我们没有讲LiveData,这里用字符串来代替，下节我们会专门来讲ViewModel和LiveData配合使用的，大家不要着急

Activity 中的两个或更多 Fragment 需要相互通信是一种很常见的情况. 假设您有一个Fragment,在该Fragment中，用户从列表中选择一项，还有另一个Fragment，用于显示选定项的内容，我们一般都是通过定义某种接口，这个Fragment回调接口，另一个Fragment实现接口，并且Activity必须将两者绑定在一起，此外，这两个Fragment都必须处理另一个Fragment尚未创建或不可见的情况。

但是ViewModel可以很好的解决Fragment之间通信的问题。这两个Fragment可以使用其Activity范围共享ViewModel来处理此类通信.

创建ShareViewModel继承自ViewModel

public class SharedViewModel extends ViewModel {
    private  String text = "";

    public void setText(String text) {
        this.text = text;
    }

    public String getText() {
        return text;
    }
}

创建MasterFragment设置数据

  private SharedViewModel model;
    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View view =  inflater.inflate(R.layout.fragment_master, container, false);
        //设置数据
        model = new ViewModelProvider(getActivity()).get(SharedViewModel.class);
        model.setText("小鑫你好啊");

        view.findViewById(R.id.toDetail).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Navigation.findNavController(v).navigate(R.id.action_masterFragment_to_detailFragment);
            }
        });
        return view;
    }

创建DetailFragment获取数据并显示

@Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View view =inflater.inflate(R.layout.fragment_detail, container, false);
        SharedViewModel model = new ViewModelProvider(getActivity()).get(SharedViewModel.class);
        //取出数据
        String text = model.getText();
        //显示在UI上
        TextView textView = view.findViewById(R.id.tv_text1);
        textView.setText(text);
        return view;
    }

运行程序,发现DetailFragment确实能获取到数据并显示在UI,是不是非常简单！
这里Fragment之间的跳转用的Navigation，代码就不贴出了，前面已经很详细介绍了。

请注意, 这两个Fragment都会检索包含它们的Activity.这样，当这两个Fragment各自获取ViewModelProvider时，它们都会收到相同的SharedViewModel实例(其范围限定为该Activity)

此方法具有以下优势

• Activity 不需要执行任何操作，也不需要对此通信有任何了解。
• 除了 SharedViewModel 约定之外，Fragment 不需要相互了解。如果其中一个 Fragment 消失，另一个 Fragment 将继续照常工作
• 每个 Fragment 都有自己的生命周期，而不受另一个 Fragment 的生命周期的影响。如果一个 Fragment 替换另一个 Fragment，界面将继续工作而没有任何问题。

总结

ViewModel可以帮助我们更好地将页面与数据从代码层面分离开来，依赖ViewModel的生命周期特性，我们不需要在关心屏幕旋转导致数据丢失的问题，需要注意的是，如果想在ViewModel中使用Context,建议使用ViewModel的子类AndroidViewModel。

下节，我们将来学习LiveData, 通过LiveData，当ViewModel中的数据发送变化时，页面能自动收到通知，进而更新UI，更加方便我们进行开发。

好了，ViewModel到这里就结束了，不足之处，望大家指出来，共同进步，谢谢！