LiveData 和 ViewModel (AAC)

重点：

1、LiveData核心方法是 postValue和setValue用来通知观察者更新数据。
MutableLiveData是它的一个实现类。其中定义了postValue和setValue用来通知观察者更新数据。
还有4个常用的方法，要通过扩展来使用 (扩展LiveData使用情景，例如观察网络状态变化)
observe
onActive
onInactive
observeForever

2、为什么将LiveData放置到ViewModel中，而不放到activity或者fragment中？
（1）LiveData的生命周期取决于创建者，所以，在ViewModel中创建，LiveData的存活周期等同于ViewModel。例如：将LiveData和特定的activity/fragment解耦（放在ViewModel中），能够在configuration改变的时候，LiveData依然存活。

（2）避免fragment和activity的代码臃肿

3、ViewModel的核心价值是独特的生命周期，就一拥有独特生命周期的容器。

4、LiveData也可以直接与Lifecycle 配合使用，不经过ViewModel

5、LiveData还有其他功能，例如资源共享等等。

但自己觉得，AAC(Lifecycle ,ViewModel, LiveData) 核心是优雅地实现了MVP(解耦、自动化测试)，至于LiveData的其他用法可以先放一放，有时间再深入，因为就算没有LIveData，那些功能以前一样可以实现。

---

Android Jetpack 架构组件最佳实践(这文章要细看) ，下面是摘要

关于ViewModel的最佳实践
任何时候都不要将Context传入ViewModel。
如果要在ViewModel中使用Application实例，请使用AndroidViewModel类。
ViewModel+LiveData+Databinding 可构建反应式UI。（请查看文末提供的参考资料）
ViewModel与onSaveInstanceState要配合使用。其实ViewModel和onSaveInstanceState是相辅相成的。

当Fragment被detach后再attach回来，会导致添加多个Observer？
原因：由于Fragment默认实现是在onDestroy才通知liveData 移除observers，而我们每次在onCreateView都会add新的observer实例，这样就会导致数据更新时，LiveData会同时通知多个Observer，界面就会快速刷新多次。

解决方案：当你在onActivityCreated方法中添加LiveData.observer(LifecycleOwner owner, Observer<T> observer)时，第一个参数使用Fragment.getViewLifecycleOwner()方法返回值。(如果你没有找到该方法，请更新你依赖的support包版本，Google已在新版本中提供该方法)
将LiveData.observer(LifecycleOwner owner, Observer<T> observer)放在onCreate回调中，在Fragment显示时手动触发数据刷新，当然最好还是更新support版本来解决。

 

---

本文参考了三篇文章

主线：Android LiveData 使用详解

参考：Jetpack架构组件 — LiveData与ViewModel入坑详解（kotlin）

api式详解：LiveData基本教程

官网

---

前言

那么我们为什么要使用LiveData和ViewModel呢？他们有什么优势呢？

在LiveData出现之前，一般状态分发我们使用EventBus或者RxJava，这些都很容易出现内存泄漏问题，而且需要我们手动管理生命周期。而LiveData则规避了这些问题，LiveData是一个持有Activity、Fragment生命周期的数据容器。当数据源发生变化的时候，通知它的观察者更新UI界面。同时它只会通知处于Active状态的观察者更新界面，如果某个观察者的状态处于Paused或Destroyed时那么它将不会收到通知。所以不用担心内存泄漏问题。

ViewModel将视图和逻辑进行了分离。Activity或者Fragment只负责UI显示部分。具体的网络请求或者数据库操作则有ViewModel负责。这样避免了视图的臃肿和代码的耦合。通过下面这张ViewModel生命周期可以看出，当屏幕发生旋转而导致Activity被销毁并重新创建时，ViewModel并没有被销毁，从而帮助我们在Activity重新创建后获取数据更新UI。它和onSaveInstanceState方法相比更有优势，因为onSaveInstanceState方法只不适合大量数据的恢复操作，只能恢复少量并且被序列化和反序列化的数据，而ViewModel不仅支持大量数据，还不需要序列化、反序列化操作。

LiveData 使用

基本使用
  1、引入相关的依赖包

// ViewModel and LiveData
implementation "android.arch.lifecycle:extensions:1.1.0"
// alternatively, just ViewModel
implementation "android.arch.lifecycle:viewmodel:1.1.0"
// alternatively, just LiveData
implementation "android.arch.lifecycle:livedata:1.1.0"

2、在代码中使用

LiveData 是一个抽象类，它的实现子类有 MutableLiveData ，MediatorLiveData。在实际使用中，用得比较多的是 MutableLiveData。他常常结合 ViewModel 一起使用。下面，让我们一起来看一下怎样使用它？

MediatorLiveData的使用方法

首先，我们先写一个类继承我们的 ViewModel，里面持有 mNameEvent。

public class TestViewModel extends ViewModel {

    private MutableLiveData<String> mNameEvent = new MutableLiveData<>();

    public MutableLiveData<String> getNameEvent() {
        return mNameEvent;
    }

    public void getName(){
        // 网络、room等等获取数据
        String name=.....  ;
        mNameEvent.postValue(name);
    }

}

接着，我们在 Activity 中创建 ViewModel，并监听 ViewModel 里面 mNameEvent 数据的变化，当数据改变的时候，我们打印相应的 log，并设置给 textView，显示在界面上。这样我们就完成了对 mNameEvent 数据源的观察。

mTestViewModel = ViewModelProviders.of(this).get(TestViewModel.class);
MutableLiveData<String> nameEvent = mTestViewModel.getNameEvent();
nameEvent.observe(this, new Observer<String>() {
    @Override
    public void onChanged(@Nullable String s) {
        Log.i(TAG, "onChanged: s = " + s);
        mTvName.setText(s);
    }
});

最后当我们数据源改变的时候，我们需要调用 livedata 的 setValue 或者 postvalue 方法。他们之间的区别是， 调用 setValue 方法，Observer 的 onChanged 方法会在调用 serValue 方法的线程回调。而
postvalue 方法，Observer 的 onChanged 方法将会在主线程回调。

mTestViewModel.getName();

可能部分同学有这样的疑问了，我们的 ViewModel 是通过 ViewModelProviders.of(this).get(TestViewModel.class); 方法创建出来的，如果我们要携带参数，怎么办？

其实，官方也替我们考虑好了，同样是调用 ViewModelProvider of(@NonNull Fragment fragment, @Nullable Factory factory) 方法，只不过，需要多传递一个 factory 参数。

Factory 是一个接口，它只有一个 create 方法。

public interface Factory {
    /**
     * Creates a new instance of the given {@code Class}.
     * <p>
     *
     * @param modelClass a {@code Class} whose instance is requested
     * @param <T>        The type parameter for the ViewModel.
     * @return a newly created ViewModel
     */
    @NonNull
    <T extends ViewModel> T create(@NonNull Class<T> modelClass);
}

在实际当中，我们的做法是：实现 Factory 接口，重写 create 方法，在create 方法里面调用相应的构造函数，返回相应的实例。

public class TestViewModel extends ViewModel {

    private final String mKey;
    private MutableLiveData<String> mNameEvent = new MutableLiveData<>();

    public MutableLiveData<String> getNameEvent() {
        return mNameEvent;
    }

    public TestViewModel(String key) {
        mKey = key;
    }

    public static class Factory implements ViewModelProvider.Factory {
        private String mKey;

        public Factory(String key) {
            mKey = key;
        }

        @Override
        public <T extends ViewModel> T create(Class<T> modelClass) {
            return (T) new TestViewModel(mKey);
        }
    }

    public String getKey() {
        return mKey;
    }
}

ViewModelProviders.of(this, new TestViewModel.Factory(mkey)).get(TestViewModel.class)

---

自定义 Livedata （扩展LiveData）
Livedata 主要有几个方法

1. observe
2. onActive
3. onInactive
4. observeForever

void observe (LifecycleOwner owner, Observer observer)

Adds the given observer to the observers list within the lifespan of the given owner. The events are dispatched on the main thread. If LiveData already has data set, it will be delivered to the observer.

void onActive ()

Called when the number of active observers change to 1 from 0.
This callback can be used to know that this LiveData is being used thus should be kept up to date.

当回调该方法的时候，表示该 liveData 正在背使用，因此应该保持最新

void onInactive ()

Called when the number of active observers change from 1 to 0.
This does not mean that there are no observers left, there may still be observers but their lifecycle states aren’t STARTED or RESUMED (like an Activity in the back stack).
You can check if there are observers via hasObservers().

当该方法回调时，表示他所有的 obervers 没有一个状态处理 STARTED 或者 RESUMED，注意，这不代表没有 observers。

Void observeForever

跟 observe 方法不太一样的是，它在 Activity 处于 onPause ，onStop， onDestroy 的时候，都可以回调 obsever 的 onChange 方法，但是有一点需要注意的是，我们必须手动 remove obsever，否则会发生内存泄漏。

这里我们以观察网络状态变化为例子讲解

1. 首先我们自定义一个 Class NetworkLiveData，继承 LiveData，重写它的 onActive 方法和 onInactive 方法
2. 在 onActive 方法中，我们注册监听网络变化的广播，即ConnectivityManager.CONNECTIVITY_ACTION。在 onInactive 方法的时候，我们注销广播。

public class NetworkLiveData extends LiveData<NetworkInfo> {

    private final Context mContext;
    static NetworkLiveData mNetworkLiveData;
    private NetworkReceiver mNetworkReceiver;
    private final IntentFilter mIntentFilter;

    private static final String TAG = "NetworkLiveData";

    public NetworkLiveData(Context context) {
        mContext = context.getApplicationContext();
        mNetworkReceiver = new NetworkReceiver();
        mIntentFilter = new IntentFilter(ConnectivityManager.CONNECTIVITY_ACTION);
    }

    public static NetworkLiveData getInstance(Context context) {
        if (mNetworkLiveData == null) {
            mNetworkLiveData = new NetworkLiveData(context);
        }
        return mNetworkLiveData;
    }

    @Override
    protected void onActive() {
        super.onActive();
        Log.d(TAG, "onActive:");
        mContext.registerReceiver(mNetworkReceiver, mIntentFilter);
    }

    @Override
    protected void onInactive() {
        super.onInactive();
        Log.d(TAG, "onInactive: ");
        mContext.unregisterReceiver(mNetworkReceiver);
    }

    private static class NetworkReceiver extends BroadcastReceiver {

        @Override
        public void onReceive(Context context, Intent intent) {
            ConnectivityManager manager = (ConnectivityManager) context
                    .getSystemService(Context.CONNECTIVITY_SERVICE);
            NetworkInfo activeNetwork = manager.getActiveNetworkInfo();
            getInstance(context).setValue(activeNetwork);

        }
    }
}

这样，当我们想监听网络变化的时候，我们只需要调用相应的 observe 方法即可，方便又快捷。

NetworkLiveData.getInstance(this).observe(this, new Observer<NetworkInfo>() {
    @Override
    public void onChanged(@Nullable NetworkInfo networkInfo) {
        Log.d(TAG, "onChanged: networkInfo=" +networkInfo);
    }
});

 

共享数据

Fragment Activity 之间共享数据
我们回过头来再来看一下 ViewModelProvider 的 of 方法，他主要有四个方法，分别是

1. ViewModelProvider of(@NonNull Fragment fragment)
2. ViewModelProvider of(@NonNull FragmentActivity activity)
3. ViewModelProvider of(@NonNull Fragment fragment, @Nullable Factory factory)
4. ViewModelProvider of(@NonNull FragmentActivity activity, @Nullable Factory factory)

1,2 方法之间的主要区别是传入 Fragment 或者 FragmentActivity。而我们知道，通过 ViewModel of 方法创建的 ViewModel 实例， 对于同一个 fragment 或者 fragmentActivity 实例，ViewModel 实例是相同的，因而我们可以利用该特点，在 Fragment 中创建 ViewModel 的时候，传入的是 Fragment 所依附的 Activity。因而他们的 ViewModel 实例是相同的，从而可以做到共享数据。

// LiveDataSampleActivity(TestFragment 依赖的 Activity）
mTestViewModel = ViewModelProviders.of(this, new TestViewModel.Factory(mkey)).get(TestViewModel.class);
MutableLiveData<String> nameEvent = mTestViewModel.getNameEvent();
nameEvent.observe(this, new Observer<String>() {
    @Override
    public void onChanged(@Nullable String s) {
        Log.i(TAG, "onChanged: s = " + s);
        mTvName.setText(s);
    }
});


// TestFragment 中
mViewModel = ViewModelProviders.of(mActivity).get(TestViewModel.class);
mViewModel.getNameEvent().observe(this, new Observer<String>() {
    @Override
    public void onChanged(@Nullable String s) {
        Log.d(TAG, "onChanged: s =" + s + " mViewModel.getKey() =" + mViewModel.getKey());
        mTvName.setText(s);
        boolean result = mViewModel == ((LiveDataSampleActivity) mListener).mTestViewModel;
        Log.d(TAG, "onChanged: s result =" + result);
    }
});

这样，LiveDataSampleActivity 和 TestFragment 中的 ViewModel 是同一个实例。即 Activity 和 Fragment 共享数据。

全局共享数据

说到全局共享数据，我们想一下我们的应用全景，比如说我的账户数据，这个对于整个 App 来说，肯定是全局共享的。有时候，当我们的数据变化的时候，我们需要通知我们相应的界面，刷新 UI。如果用传统的方式来实现，那么我们一般才采取观察者的方式来实现，这样，当我们需要观察数据的时候，我们需要添加 observer，在界面销毁的时候，我们需要移除 observer。

但是，如果我们用 LiveData 来实现的话，它内部逻辑都帮我们封装好了，我们只需要保证 AccountLiveData 是单例的就ok，在需要观察的地方调用 observer 方法即可。也不需要手动移除 observer，不会发生内存泄漏，方便快捷。

这里 AccountLiveData 的实现就不贴出来了，可以参考上面的 NetworkLiveData 实现

---

小结

这里说一点关于 LiveData 与 ViewModel 的应用场景吧，我尽量说得通俗一点，不要说得那么官方，这样对新手很难理解。觉得不错的，请点个赞，让我们看到你们的欢呼声。你们的支持就是我写作的最大动力。

LiveData 内部已经实现了观察者模式，如果你的数据要同时通知几个界面，可以采取这种方式
我们知道 LiveData 数据变化的时候，会回调 Observer 的 onChange 方法，但是回调的前提是 lifecycleOwner（即所依附的 Activity 或者 Fragment） 处于 started 或者 resumed 状态，它才会回调，否则，必须等到 lifecycleOwner 切换到前台的时候，才回调。因此，这对性能方面确实是一个不小的提升。但是，对于你想做一些类似与在后台工作的（黑科技）， liveData 就不太适合了，你可以使用 observeForever 方法，或者自己实现观察者模式去吧。