【AAC 系列三】深入理解架構組件：LiveData

轉載：https://juejin.im/post/5ce54c2be51d45106343179d

0. 前言

本文是深入理解「Android Architecture Components」系列文章第三篇源碼基於 android.arch.lifecycle:livedata-core:1.1.1

在之前我們深入研究了 Lifecycle 的實現原理，並在文末提到了LiveData 以及 ViewModel，這次我們來講講 LiveData。

LiveData 是 Android Architecture Components 中的一員，先看下官方是如何介紹的：

LiveData is an observable data holder class. Unlike a regular observable, LiveData is lifecycle-aware, meaning it respects the lifecycle of other app components, such as activities, fragments, or services. This awareness ensures LiveData only updates app component observers that are in an active lifecycle state. [見 9.1]

This class is designed to hold individual data fields of ViewModel, but can also be used for sharing data between different modules in your application in a decoupled fashion. [見 9.2]

簡單講 LiveData 是一個能夠感知生命週期、可觀察的數據持有類 ，它被設計成 ViewModel 的一個成員變量；可以以一個 更解耦 的方式來共享數據。

實際使用下來發現 LiveData 有幾個特性：

LiveData 的實現基於觀察者模式；
LiveData 跟 LifecycleOwner 綁定，能感知生命週期變化，並且只會在 LifecycleOwner 處於 Active 狀態（STARTED/RESUMED）下通知數據改變；
LiveData 會自動在 DESTROYED 的狀態下移除 Observer ，取消訂閱，所以不用擔心內存泄露；

那麼 LiveData 上述特性的原理是怎麼樣的呢？
使用 LiveData 又需要注意些什麼呢？

本文將圍繞此展開。

1. LiveData 的基本使用

雖然 LiveData 通常跟 ViewModel 配合使用，不過也可以單獨使用，爲了簡單起見，這裏不配合 ViewModel。

以下是一個簡單的例子：

MutableLiveData<String> liveString = new MutableLiveData<>();
liveString.observe(this, new Observer<String>() {
  @Override
  public void onChanged(@Nullable final String s) {
    Log.d(TAG, "onChanged() called with: s = [" + s + "]");
  }
});

liveString.postValue("程序亦非猿");

運行後可以看到日誌輸出：onChanged() called with: s = [程序亦非猿] 。

釋義：
定義一個 MutableLiveData （LiveData 的一個常用子類），通過 observe 方法可以訂閱修改數據的通知，通過 postValue() 或者 setValue() 方法可以更新數據，已經訂閱的 Observer 能夠得到數據更改的通知，也即回調 onChanged() 方法。

這樣就算是用上 LiveData 了。

接下來，上乾貨！

2. LiveData 的原理分析

在分析原理前，再明確一下我們的疑問：

LiveData 是如何跟 LifecycleOwner 進行綁定，做到感知生命週期的？
LiveData 只在 LifecycleOwner active 狀態發送通知，是怎麼處理的？
LiveData 會自動在 DESTROY 的狀態下取消訂閱，是怎麼處理的？
通過 setValue()/postValue() 更新數據的處理流程是如何？
生命週期變化後數據處理流程是怎麼樣的？

同時提前看下我整理的 LiveData UML 圖，對 LiveData 有個整體的瞭解，後續的涉及到的類都在這裏了，有助於理解。

(圖1.LiveData 類圖)

OK， here we go!

2.1 LiveData.observe()

LiveData 的使用流程從 observe() 開始，咱們嘗試從 observe() 方法開始分析：

@MainThread
public void observe(@NonNull LifecycleOwner owner, @NonNull Observer<T> observer) {
    //如果是 DESTROYED 的狀態則忽略
    if (owner.getLifecycle().getCurrentState() == DESTROYED) {
        // ignore
        return;
    }
    //把 Observer 用 LifecycleBoundObserver 包裝起來
    LifecycleBoundObserver wrapper = new LifecycleBoundObserver(owner, observer);
    //緩存起來
    ObserverWrapper existing = mObservers.putIfAbsent(observer, wrapper);
    //如果已經 observe 過 並且兩次的 owner 不同則報錯
    if (existing != null && !existing.isAttachedTo(owner)) {
        throw new IllegalArgumentException("Cannot add the same observer"
                + " with different lifecycles");
    }
    if (existing != null) {
        return;
    }
    //綁定 owner
    owner.getLifecycle().addObserver(wrapper);
}

可以看到 observe 方法裏把我們傳遞的 observer 用 LifecycleBoundObserver 包裝了起來，並且存入了 mObservers ，並且跟 owner 進行了關聯。

並且做了兩個特殊處理：

忽視處於 DESTROYED 的 owner 的註冊行爲；
將一個 Observer 同時綁定兩個 owner 的行爲視爲非法操作，也即一個 Observer 只能綁定一個 owner，而 owner 可以有多個 Observer；

這裏出現了幾個新的類 LifecycleBoundObserver 、ObserverWrapper 來看看。

2.2 LifecycleBoundObserver

class LifecycleBoundObserver extends ObserverWrapper implements GenericLifecycleObserver {
    @NonNull final LifecycleOwner mOwner;

    LifecycleBoundObserver(@NonNull LifecycleOwner owner, Observer<T> observer) {
        super(observer);
        mOwner = owner;
    }

    @Override
    boolean shouldBeActive() {
        // 判斷 owner 當前的狀態是否是至少 STARTED
        return mOwner.getLifecycle().getCurrentState().isAtLeast(STARTED);
    }

    @Override
    public void onStateChanged(LifecycleOwner source, Lifecycle.Event event) {
        //生命週期改變，如果是 DESTROYED 就自動解除
        if (mOwner.getLifecycle().getCurrentState() == DESTROYED) {
            removeObserver(mObserver);
            return;
        }
        //ObserverWrapper.activeStateChanged
        activeStateChanged(shouldBeActive());
    }

    @Override
    boolean isAttachedTo(LifecycleOwner owner) {
        return mOwner == owner;
    }

    @Override
    void detachObserver() {
        mOwner.getLifecycle().removeObserver(this);
    }
}

**ObserverWrapper **:

private abstract class ObserverWrapper {
    final Observer<T> mObserver;
    boolean mActive;
    int mLastVersion = START_VERSION;

    ObserverWrapper(Observer<T> observer) {
        mObserver = observer;
    }
            //是否是 active 狀態
    abstract boolean shouldBeActive();

    boolean isAttachedTo(LifecycleOwner owner) {
        return false;
    }

    void detachObserver() {
    }

    void activeStateChanged(boolean newActive) {
        if (newActive == mActive) {
            return;
        }
        // immediately set active state, so we'd never dispatch anything to inactive
        // owner
        mActive = newActive;
        boolean wasInactive = LiveData.this.mActiveCount == 0;
        LiveData.this.mActiveCount += mActive ? 1 : -1;
        if (wasInactive && mActive) {
            onActive();
        }
        if (LiveData.this.mActiveCount == 0 && !mActive) {
            onInactive();
        }
        //如果 active 狀態下，則發送數據更新通知
        if (mActive) {
            dispatchingValue(this);
        }
    }
}

仔細看下這兩個類其實就能解答疑問了。

LifecycleBoundObserver 是抽象類 ObserverWrapper 的子類，重寫了 shouldBeActive() 方法，在 owner 處於至少是 STARTED 的狀態下認爲是 active 狀態；並且它也實現了 GenericLifecycleObserver 接口，可以監聽 lifecycle 回調，並且在 onStateChanged() 方法裏處理了生命週期改變的事件，當接收到 DESTROYED 的事件會自動解除跟 owner 的綁定，並且將下個流程交給了 activeStateChanged() 。

到這裏【2.1】、【2.3】的問題已經有了答案：

【2.1】答：LifeData 在 observe 方法中用 LifecycleBoundObserver 包裝了 observer ，並且通過它綁定了owner。
【2.3】答：LifecycleBoundObserver 在 onStateChanged() 方法裏處理了生命週期改變的事件，當接收到 DESTROYED 的事件會自動解除跟 owner 的綁定。

這裏需要注意的是，當我們調用 observe() 註冊後，由於綁定了 owner，所以在 active 的情況下，LiveData 如果有數據，則 Observer 會立馬接受到該數據修改的通知。

此時的流程是:

observe-->
onStateChanged-->
activeStateChanged-->
dispatchingValue-->
considerNotify-->
onChanged

可以稱之爲生命週期改變觸發的流程，另外還有一種流程是 postValue&setValue 觸發的流程，共兩種。

2.3 activeStateChanged(boolean)

在 activeStateChanged() 方法裏，處理了 onActive() 跟 onInactive() 回調的相關邏輯處理，並且調用了dispatchingValue(this) 。（MediatorLiveData 用到了 onActive() 跟 onInactive() 有興趣自行了解，這裏不展開）

接下去探索 dispatchingValue 。

2.4 dispatchingValue(ObserverWrapper) 分析

private void dispatchingValue(@Nullable ObserverWrapper initiator) {
    //如果正在分發則直接返回
    if (mDispatchingValue) {
        //標記分發失效
        mDispatchInvalidated = true;
        return;
    }
    //標記分發開始
    mDispatchingValue = true;
    do {
        mDispatchInvalidated = false;
        //生命週期改變調用的方法 initiator 不爲 null
        if (initiator != null) {
            considerNotify(initiator);
            initiator = null;
        } else {
            //postValue/setValue 方法調用 傳遞的 initiator 爲 null
            for (Iterator<Map.Entry<Observer<T>, ObserverWrapper>> iterator =
                    mObservers.iteratorWithAdditions(); iterator.hasNext(); ) {
                considerNotify(iterator.next().getValue());
                if (mDispatchInvalidated) {
                    break;
                }
            }
        }
    } while (mDispatchInvalidated);
    //標記分發結束
    mDispatchingValue = false;
}

considerNotify(ObserverWrapper) 方法:

private void considerNotify(ObserverWrapper observer) {
    //檢查狀態 確保不會分發給 inactive 的 observer
    if (!observer.mActive) {
        return;
    }
    // Check latest state b4 dispatch. Maybe it changed state but we didn't get the event yet.
    //
    // we still first check observer.active to keep it as the entrance for events. So even if
    // the observer moved to an active state, if we've not received that event, we better not
    // notify for a more predictable notification order.
    if (!observer.shouldBeActive()) {
        observer.activeStateChanged(false);
        return;
    }
    //setValue 會增加 version ,初始 version 爲-1
    if (observer.mLastVersion >= mVersion) {
        return;
    }
    observer.mLastVersion = mVersion;
    //noinspection unchecked
    observer.mObserver.onChanged((T) mData);
}

可以看到 dispatchingValue 正是分發事件邏輯的處理方法，而 considerNotify 方法則確保了只將最新的數據分發給 active 狀態下的 Observer 。

另外也可以看到 LiveData 引入了版本管理來管理數據（mData）以確保發送的數據總是最新的。（具體不多講）

dispatchingValue 這裏分兩種情況：

ObserverWrapper 不爲 null
ObserverWrapper 爲 null

需要着重講一下。

2.4.1 ObserverWrapper 不爲 null 的情況

上面提到過，LifecycleBoundObserver.onStateChanged 方法裏調用了 activeStateChanged ，而該方法調用dispatchingValue(this);傳入了 this ，也就是 LifecycleBoundObserver ，這時候不爲 null 。

也就是說生命週期改變觸發的流程就是這種情況，這種情況下，只會通知跟該 Owner 綁定的 Observer。

2.4.2 ObserverWrapper 爲 null 的情況

上面我也提前說了，除了生命週期改變觸發的流程外，還有 postValue&setValue 流程，來看下這倆方法。

private final Runnable mPostValueRunnable = new Runnable() {
    @Override
    public void run() {
        Object newValue;
        synchronized (mDataLock) {
            newValue = mPendingData;
            mPendingData = NOT_SET;
        }
        //noinspection unchecked
        //調用 setValue
        setValue((T) newValue);
    }
};

protected void postValue(T value) {
    boolean postTask;
    synchronized (mDataLock) {
        postTask = mPendingData == NOT_SET;
        mPendingData = value;
    }
    if (!postTask) {
        return;
    }
    ArchTaskExecutor.getInstance().postToMainThread(mPostValueRunnable);
}

@MainThread
protected void setValue(T value) {
    //必須在主線程調用 否則會 crash
    assertMainThread("setValue");
    mVersion++;//增加版本號
    mData = value;
    //傳入了 null
    dispatchingValue(null);
}

LiveData 的 postValue 方法其實就是把操作 post 到主線程，最後調用的還是 setValue 方法，注意 setValue 必須是在主線程調用。

並且可以看到** setValue 方法調用了 dispatchingValue 方法，並傳入了 null ，這個時候的流程則會通知 active 的mObservers**。

到這裏之前的剩下的所有疑問也都可以解答了。

LiveData 的兩個流程都會走到 dispatchingValue 處理分發通知邏輯，並且在分發通知前會判斷 owner 的狀態，再加上 LiveData 本身內部的版本管理，確保了只會發送最新的數據給 active 狀態下的 Observer。

**注意：**LiveData 對同時多次修改數據做了處理，如果同時多次修改，只會修改爲最新的數據。

3. 圖解 LiveData

3.1 LiveData 類圖

再看一遍類圖，回顧一下：

(圖2.LiveData 類圖)

3.2 LiveData 流程圖

Lifecycle 改變觸發流程：

(圖3.Lifecycle 改變觸發流程圖)

Lifecycle postValue/setValue 觸發流程：

(圖4.setValue 改變觸發流程圖)

4. LiveData tips and recipes

LiveData 還有很多其他相關知識，這裏列舉一些，更多實踐可以看一下【7.6】。

4.1 Sticky Event

LiveData 被訂閱時，如果之前已經更改過數據，並且當前 owner 爲 active 的狀態，activeStateChanged() 會被調用，也即會立馬通知到 Observer ，這樣其實就類似 EventBus 的 sticky event 的功能，需要注意的是，很多時候我們並不需要該功能。具體可以看一下【7.6】的處理。

4.2 AlwaysActiveObserver

默認情況下，LiveData 會跟 LicycleOwner 綁定，只在 active 狀態下更新，如若想要不管在什麼狀態下都能接收到數據的更改通知的話，怎麼辦？這時候需要使用 AlwaysActiveObserver ，改調用 observe 方法爲調用 LiveData.observeForever(Observer) 方法即可。

4.3 MediatorLiveData

LiveData 還有一個子類是 MediatorLiveData，它允許我們合併多個 LiveData，任何一個 LiveData 有更新就會發送通知。比如我們的數據來源有兩個，一個數據庫一個網絡，這時候我們會有兩個 DataSource，也就是兩個 LiveData，這個時候我們可以使用 MediatorLiveData 來 merge 這兩個 LiveData。

4.4 Transformations

Transformations 允許我們把一個 LiveData 進行處理，變化成另外一個 LiveData，目前支持 map 跟 switchMap 兩個方法，跟 RxJava 的操作類似。

比如，用 map 把一個 String 類型的 LiveData 轉換成 Integer 類型：

Transformations.map(liveString, new Function<String, Integer>() {
  @Override
  public Integer apply(final String input) {
    return Integer.valueOf(input);
  }
}).observe(this, new Observer<Integer>() {
  @Override
  public void onChanged(@Nullable final Integer integer) {

  }
});

4.4 LiveDataBus

EventBus 基於觀察者模式，LiveData 也是，所以 LiveData 可以被用來做成 LiveDataBus，有興趣可以搜索。

5. 知識點彙總

LiveData 的實現基於觀察者模式（reactive patterns）；
LiveData 跟 LifecycleOwner 綁定，能感知生命週期變化，並且只會在 LifecycleOwner 處於 Active 狀態（STARTED/RESUMED）下通知數據改變；如果數據改變發生在非 active 狀態，數據會變化，但是不發送通知，等 owner 回到 active 的狀態下，再發送通知；
如果想要一直收到通知，則需要用 observeForever() 方法；
LiveData 會自動在 DESTROYED 的狀態下移除 Observer ，取消訂閱，所以不用擔心內存泄露；
在 LifecycleOwner 處於 DESTROYED 的狀態下，不能訂閱；
postValue 方法其實最後調用了 setValue 只不過把操作放到主線程，適合在異步線程裏調用，setValue 必須在主線程裏調用；
如果同時多次調用 postValue 或 setValue 修改數據，只會修改成最新的那個數據，也即只會收到一次通知（set post混合調用則不一定）；
如果 LiveData 有數據，並且 owner 在 active 狀態下，那麼在訂閱的時候，會立馬收到一次通知；
一個 Observer 實例，只能綁定一個 LifecycleOwner，而一個 owner 可以綁定多個 Observer 實例；
LiveData 利用版本管理、綁定 Lifecycle 確保了只會發送最新的數據給 active 狀態下的 Observer；

6. 總結

LiveData 基於觀察者模式，並且可以感知生命週期，這使得我們使用 LiveData 既可以享受觀察者模式帶來的隔離數據與 UI 等強大的解耦能力，還可以享受感知生命週期帶來的巨大便利。並且還無需擔心內存泄露這個令人頭疼的問題。

我們可以使用 LiveData 非常輕鬆地做到一些非常高效的操作，如僅在 active 的狀態下刷新 UI，可以避免不必要的數據刷新。

顯而易見 LiveData 本身的優秀特性有着巨大的價值，利用好絕對是架構設計中的一大利器，另外 LiveData 配合 ViewModel 可以發揮更大的價值，機智的你一定已經知道下一篇文章講什麼了。

7. 參考與推薦

LiveData Overview : developer.android.com/topic/libra…
LiveData doc : developer.android.com/reference/a…
developer.android.com/reference/a…
developer.android.com/reference/a…
github.com/googlesampl…
github.com/googlesampl…

【AAC 系列三】深入理解架構組件：LiveData

0. 前言

1. LiveData 的基本使用

2. LiveData 的原理分析

3. 圖解 LiveData

4. LiveData tips and recipes

5. 知識點彙總

6. 總結

7. 參考與推薦

win11關閉自動檢測病毒刪文件

千兆寬帶實際網速能到達多少？

網易新聞客戶端Flutter混合開發實踐

Android 架構組件(一)

Glide源碼分析

Android SQLite -journal、-wal、-shm

What are the best practices for SQLite on Android?

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結