Android架構組件官方文檔02——LiveData

LiveData概述

LiveData是一個可觀察的數據持有者類。
與常規可觀察性不一樣,LiveData具備生命週期感知能力,這意味着它尊重其餘應用程序組件(例如活動,片斷或服務)的生命週期。
這種感知確保LiveData只更新處於活動生命週期狀態的應用程序組件觀察者。
注意:要將LiveData組件導入到Android項目中,請參閱向項目添加組件
若是觀察者的生命週期處於STARTEDRESUMED狀態,則LiveData會將Observer類表示的觀察者視爲活動狀態。
LiveData僅通知處於活躍狀態的觀察者更新。
未註冊觀看LiveData對象的非活躍期的觀察者不會收到有關更改的通知。html

您能夠註冊與實現LifecycleOwner接口的對象配對的觀察者。此關係容許在相應生命週期對象的狀態更改成DESTROYED時刪除觀察者。
這對於活動和片斷尤爲有用,由於它們能夠安全地觀察LiveData對象,而沒必要擔憂泄漏 - 在其生命週期被破壞時,活動和片斷會當即取消訂閱。android

有關如何使用LiveData的更多信息,請參閱使用LiveData對象數據庫

使用LiveData的優勢

使用LiveData提供如下優勢:
確保您的UI界面符合您UI數據狀態安全

LiveData遵循觀察者模式。
當生命週期狀態改變時,LiveData會通知Observer對象。
您能夠合併代碼以更新這些Observer對象中的UI。
每次應用程序數據更改時,您的觀察者均可以在每次更改時更新UI,而不是每次更新UI。
沒有內存泄漏
觀察者綁定到 Lifecycle對象,並在其相關生命週期被破壞後自行清理。

不會由於活動中止而崩潰網絡

若是觀察者的生命週期處於非活動狀態,例如在後退堆棧中的活動,則它不會收到任何LiveData事件。

沒有更多的手動聲明週期處理
UI組件只是觀察相關數據,不中止或恢復觀察。
LiveData自動管理全部這些,由於它在觀察時意識到相關的生命週期狀態更改。
始終保持最新的數據
若是生命週期變爲非活動狀態,它將在再次變爲活動狀態時收到最新數據。例如,後臺活動在返回到前臺後當即收到最新數據。
正確的配置更改
若是因爲配置更改(如設備旋轉)而從新建立活動或片斷,它會當即收到最新的可用數據。
共享資源
您可使用單例模式擴展LiveData對象以包裝系統服務,以便它們能夠在應用程序中共享。
LiveData對象鏈接到系統服務一次,而後任何須要該資源的觀察者均可以觀看LiveData對象。
有關更多信息,請參閱擴展LiveData。異步

使用LiveData對象

按照如下步驟操做LiveData對象:ide

  1. 建立一個LiveData實例來保存某種類型的數據。這一般在您的ViewModel類中完成。
  2. 建立一個Observer對象,該對象定義onChanged()方法,該方法控制LiveData對象保存的數據更改時發生的狀況。您一般在UI控制器中建立Observer對象,如活動或片斷。
  3. 使用observe()方法將Observer對象附加到LiveData對象。observe()方法使用LifecycleOwner對象。這將Observer對象訂閱到LiveData對象,以便通知其更改。您一般將Observer對象附加到UI控制器中,例如Activity或Fragment。
注意:您可使用observeForever(Observer)方法註冊一個沒有關聯的LifecycleOwner對象的觀察器。在這種狀況下,觀察者被認爲始終處於活動狀態,所以老是通知修改。您能夠刪除這些觀察者調用removeObserver(Observer)方法。

當您更新存儲在LiveData對象中的值時,只要附加的LifecycleOwner處於活動狀態,它就會觸發全部已註冊的觀察者。
LiveData容許UI控制器觀察者訂閱更新。當LiveData對象持有的數據更改時,UI會自動更新以做爲響應。函數

建立LiveData對象

LiveData是一個可用於任何數據的包裝器,包括實現集合的對象(如List)。LiveData對象一般存儲在ViewModel對象中,並經過getter方法訪問,如如下示例所示:post

public class NameViewModel extends ViewModel {

// Create a LiveData with a String
private MutableLiveData<String> mCurrentName;

    public MutableLiveData<String> getCurrentName() {
        if (mCurrentName == null) {
            mCurrentName = new MutableLiveData<String>();
        }
        return mCurrentName;
    }

// Rest of the ViewModel...
}

最初,LiveData對象中的數據未設置。ui

注意:因爲如下緣由,請確保存儲更新 ViewModel對象中的UI的 LiveData對象,而不是活動或片斷:
  • 避免臃腫的活動和碎片。如今這些UI控制器負責顯示數據但不保存數據狀態。
  • LiveData實例與特定活動或片斷實例分離,並容許LiveData對象保留配置更改。

您能夠在ViewModel指南中瞭解更多關於ViewModel類的好處和用法。

觀察LiveData對象

在大多數狀況下,出於如下緣由,應用程序組件的onCreate()方法是開始觀察LiveData對象的正確位置:

  1. 確保系統不會從Activity或fragment的onResume()方法進行多餘的調用。
  2. 確保Activity或Fragment具備一旦它變爲活動狀態便可顯示的數據。只要應用程序組件處於STARTED狀態,它就會從它所觀察的LiveData對象中接收最新的值。這隻會在設置要觀察的LiveData對象時纔會發生。

一般,LiveData僅在數據更改時傳遞更新,而且僅傳遞給活動觀察者。此行爲的一個例外是,觀察者在從非活動狀態變爲活動狀態時也會收到更新。此外,若是觀察者第二次從非激活狀態變爲激活狀態,則只有在自上一次變爲活動狀態以來該值發生變化時纔會收到更新。

如下示例代碼說明了如何開始觀察LiveData對象:

public class NameActivity extends AppCompatActivity {

    private NameViewModel mModel;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // Other code to setup the activity...

        // Get the ViewModel.
        mModel = ViewModelProviders.of(this).get(NameViewModel.class);


        // Create the observer which updates the UI.
        final Observer<String> nameObserver = new Observer<String>() {
            @Override
            public void onChanged(@Nullable final String newName) {
                // Update the UI, in this case, a TextView.
                mNameTextView.setText(newName);
            }
        };

        // Observe the LiveData, passing in this activity as the LifecycleOwner and the observer.
        mModel.getCurrentName().observe(this, nameObserver);
    }
}

使用nameObserver做爲參數傳遞observe()後,當即調用onChanged(),以提供存儲在mCurrentName中的最新值。若是LiveData對象未在mCurrentName中設置值,則不調用onChanged()。

更新LiveData對象

LiveData沒有公開可用的方法來更新存儲的數據。MutableLiveData類公開公開setValue(T)postValue(T)方法,若是須要編輯存儲在LiveData對象中的值,則必須使用這些方法。一般在ViewModel中使用MutableLiveData,而後ViewModel只向觀察者公開不可變的LiveData對象。
在創建觀察者關係後,能夠更新LiveData對象的值,如如下示例所示,當用戶點擊按鈕時觸發全部觀察者:

mButton.setOnClickListener(new OnClickListener() {
    @Override
    public void onClick(View v) {
        String anotherName = "John Doe";
        mModel.getCurrentName().setValue(anotherName);
    }
});

在示例中調用setValue(T)會致使觀察者用值John Doe調用它們的onChanged()方法。該示例顯示按鈕按下,但setValue()或postValue()可能因多種緣由被調用來更新mName,包括響應網絡請求或數據庫加載完成;在全部狀況下,調用setValue()或postValue()都會觸發觀察者並更新UI。

注意:您必須調用setValue(T)方法來更新主線程中的LiveData對象。若是代碼在工做線程中執行,則可使用postValue(T)方法更新LiveData對象。

與Room一塊兒使用LiveData

Room持久性庫支持返回LiveData對象的可觀察查詢。可觀察查詢是做爲數據庫訪問對象(DAO)的一部分寫入的。

當更新數據庫時,會生成全部必要的代碼以更新LiveData對象。生成的代碼在須要時在後臺線程上異步運行查詢。這種模式對於保持UI中顯示的數據與存儲在數據庫中的數據保持同步頗有用。您能夠在Room持久庫指南中閱讀關於Room和DAO的更多信息。

擴展LiveData

若是觀察者的生命週期處於STARTEDRESUMED狀態,則LiveData將認爲觀察者處於活動狀態。如下示例代碼說明了如何擴展LiveData類:

public class StockLiveData extends LiveData<BigDecimal> {
    private StockManager mStockManager;

    private SimplePriceListener mListener = new SimplePriceListener() {
        @Override
        public void onPriceChanged(BigDecimal price) {
            setValue(price);
        }
    };

    public StockLiveData(String symbol) {
        mStockManager = new StockManager(symbol);
    }

    @Override
    protected void onActive() {
        mStockManager.requestPriceUpdates(mListener);
    }

    @Override
    protected void onInactive() {
        mStockManager.removeUpdates(mListener);
    }
}

本示例中的價格監聽器的實現包括如下重要方法:

  • 當LiveData對象具備處於活躍期的觀察者時,將調用onActive()方法。這意味着您須要開始觀察此方法的價格更新。
  • 當LiveData對象沒有任何active期間的觀察者時,將調用onInactive()方法。因爲沒有觀察員在監聽,所以沒有理由保持鏈接到StockManager服務。
  • setValue(T)方法更新LiveData實例的值並通知任何活躍的觀察者有關更改。

您可使用StockLiveData類以下所示:

public class MyFragment extends Fragment {
    @Override
    public void onActivityCreated(Bundle savedInstanceState) {
        super.onActivityCreated(savedInstanceState);
        LiveData<BigDecimal> myPriceListener = ...;
        myPriceListener.observe(this, price -> {
            // Update the UI.
        });
    }
}

observe()方法將把實現了LifecycleOwner實例的Fragment做爲第一個參數傳遞。這樣作表示此觀察者被綁定到與全部者關聯的生命週期對象,這意味着:

  • 若是生命週期對象不處於活躍狀態,則即便值發生更改,也不會調用觀察者。
  • 生命週期對象被銷燬後,觀察者被自動刪除。t

LiveData對象支持生命週期意味着您能夠在多個Activity,Fragment和Service之間共享它們。爲了保持示例簡單,您能夠按以下方式將LiveData類實現爲單例:

public class StockLiveData extends LiveData<BigDecimal> {
    private static StockLiveData sInstance;
    private StockManager mStockManager;

    private SimplePriceListener mListener = new SimplePriceListener() {
        @Override
        public void onPriceChanged(BigDecimal price) {
            setValue(price);
        }
    };

    @MainThread
    public static StockLiveData get(String symbol) {
        if (sInstance == null) {
            sInstance = new StockLiveData(symbol);
        }
        return sInstance;
    }

    private StockLiveData(String symbol) {
        mStockManager = new StockManager(symbol);
    }

    @Override
    protected void onActive() {
        mStockManager.requestPriceUpdates(mListener);
    }

    @Override
    protected void onInactive() {
        mStockManager.removeUpdates(mListener);
    }
}

您能夠再Fragment中使用它,以下所示:

public class MyFragment extends Fragment {
    @Override
    public void onActivityCreated(Bundle savedInstanceState) {
        StockLiveData.get(getActivity()).observe(this, price -> {
            // Update the UI.
        });
    }
}

多個Fragment和Activity能夠觀察MyPriceListener實例。若是LiveData只有一個或多個可見並處於活動狀態,則LiveData僅鏈接到系統服務。

轉換LiveData

您可能但願在LiveData更改成觀察者以前更改存儲在LiveData對象中的,或者您可能須要基於另外一個LiveData實例的值返回不一樣的LiveData實例。Lifecycle軟件包提供Transformations類,其中包括支持這些場景的幫助方法。
Transformations.map()
在存儲在LiveData對象中的值上使用函數,並向下遊傳播結果。

LiveData<User> userLiveData = ...;
LiveData<String> userName = Transformations.map(userLiveData, user -> {
    user.name + " " + user.lastName
});

Transformations.switchMap()

與map()相似,將函數應用於存儲在LiveData對象中的值,並展開並向下遊分派結果。傳遞給switchMap()的函數必須返回一個LiveData對象,以下例所示:

private LiveData<User> getUser(String id) {
  ...;
}

LiveData<String> userId = ...;
LiveData<User> user = Transformations.switchMap(userId, id -> getUser(id) );

您可使用轉換方法在觀察者的生命週期中傳遞信息。除非觀察者正在觀察返回的LiveData對象,不然不會計算轉換。因爲轉換是懶加載的,所以與生命週期相關的行爲會隱式傳遞,而不須要額外的顯式調用或依賴關係。

若是您認爲您須要ViewModel對象中的Lifecycle對象,則轉換多是更好的解決方案。例如,假設您有一個接受地址並返回該地址的郵政編碼的UI組件。您能夠爲此組件實現native的ViewModel,如如下示例代碼所示:

class MyViewModel extends ViewModel {
    private final PostalCodeRepository repository;
    public MyViewModel(PostalCodeRepository repository) {
       this.repository = repository;
    }

    private LiveData<String> getPostalCode(String address) {
       // DON'T DO THIS
       return repository.getPostCode(address);
    }
}

在這種狀況下,postalCode是public的和fina的,由於該字段永遠不會改變。postalCode字段定義爲addressInput的轉換,這意味着addressInput發生更改時將調用repository.getPostCode()方法。若是存在活動觀察者,那麼這是真實的,若是在repository.getPostCode()被調用時沒有活躍的觀察者,則在添加觀察者以前不進行計算。

該機制容許版本較低的應用程序建立按需延遲計算的LiveData對象。ViewModel對象能夠輕鬆得到對LiveData對象的引用,而後在其上定義轉換規則。

建立新的轉換

有十幾種不一樣的特定轉換可能在您的應用中頗有用,但它們不是默認提供的。要實現本身的轉換,您可使用MediatorLiveData類,它監聽其餘LiveData對象並處理它們發出的事件。MediatorLiveData將其狀態正確傳播到源LiveData對象。要了解有關此模式的更多信息,請參閱Transformations類的參考文檔。

合併多個LiveData源

MediatorLiveDataLiveData的一個子類,容許您合併多個LiveData源。MediatorLiveData對象的觀察者隨後會在任何原始LiveData源對象更改時觸發。

例如,若是您的UI中有一個可從本地數據庫或網絡更新的LiveData對象,則能夠將如下資源添加到MediatorLiveData對象:

  • 與存儲在數據庫中的數據關聯的LiveData對象。
  • 與從網絡訪問的數據關聯的LiveData對象。

您的活動只需觀察MediatorLiveData對象便可從兩個來源接收更新。有關詳細示例,請參閱應用程序體系結構指南的附錄:展現網絡狀態部分

其餘資源

有關在Snackbar消息,導航事件和其餘事件中使用LiveData的其餘信息,請閱讀此文章

相關文章
相關標籤/搜索