轉換資料串流

使用分頁資料時，通常必須在資料載入時轉換資料串流。例如，您可能需要篩選項目清單，或是將項目轉換為其他類型，才能在使用者介面中顯示。資料串流轉換的另一個常見用途是新增清單分隔符。

一般而言，如果直接將轉換套用至資料串流，您就可以將存放區建構和使用者介面建構分開。

套用基本轉換

由於 PagingData 會封裝在回應串流中，因此您可以從載入資料到顯示資料這段期間，逐步對資料套用轉換作業。

為了將轉換套用至串流中的每個 PagingData 物件，請將轉換放入串流的 map() 作業中：

Kotlin

pager.flow // Type is Flow<PagingData<User>>.
  // Map the outer stream so that the transformations are applied to
  // each new generation of PagingData.
  .map { pagingData ->
    // Transformations in this block are applied to the items
    // in the paged data.
}

Java

PagingRx.getFlowable(pager) // Type is Flowable<PagingData<User>>.
  // Map the outer stream so that the transformations are applied to
  // each new generation of PagingData.
  .map(pagingData -> {
    // Transformations in this block are applied to the items
    // in the paged data.
  });

Java

// Map the outer stream so that the transformations are applied to
// each new generation of PagingData.
Transformations.map(
  // Type is LiveData<PagingData<User>>.
  PagingLiveData.getLiveData(pager),
  pagingData -> {
    // Transformations in this block are applied to the items
    // in the paged data.
  });

轉換資料

資料串流最基本的作業就是將資料轉換為不同類型。取得 PagingData 物件的存取權後，您就能在 PagingData 物件中分頁清單上的個別項目執行 map() 作業。

其中一個常見的用途是將網路或資料庫層物件對應至使用者介面層專用的物件。下列範例說明如何套用此類對應作業：

Kotlin

pager.flow // Type is Flow<PagingData<User>>.
  .map { pagingData ->
    pagingData.map { user -> UiModel(user) }
  }

Java

// Type is Flowable<PagingData<User>>.
PagingRx.getFlowable(pager)
  .map(pagingData ->
    pagingData.map(UiModel.UserModel::new)
  )

Java

Transformations.map(
  // Type is LiveData<PagingData<User>>.
  PagingLiveData.getLiveData(pager),
  pagingData ->
    pagingData.map(UiModel.UserModel::new)
)

另一個常見的資料轉換是透過使用者輸入內容 (例如查詢字串)，將其轉換成要求輸出內容並顯示。設定時，您需要監聽及擷取使用者的查詢輸入內容、執行要求，以及將查詢結果推送回使用者介面。

您可以使用串流 API 監聽查詢輸入內容。請將串流參考資料保留在 ViewModel。使用者介面層不應直接存取；而會定義函式，以通知使用者查詢的 ViewModel。

Kotlin

private val queryFlow = MutableStateFlow("")

fun onQueryChanged(query: String) {
  queryFlow.value = query
}

Java

private BehaviorSubject<String> querySubject = BehaviorSubject.create("");

public void onQueryChanged(String query) {
  queryFlow.onNext(query)
}

Java

private MutableLiveData<String> queryLiveData = new MutableLiveData("");

public void onQueryChanged(String query) {
  queryFlow.setValue(query)
}

資料串流中的查詢值變更時，您可以執行作業，將查詢值轉換成所需的資料類型，並將結果回傳至使用者介面層。特定轉換函式取決於所用語言和架構，但都能提供類似的功能。

Kotlin

val querySearchResults = queryFlow.flatMapLatest { query ->
  // The database query returns a Flow which is output through
  // querySearchResults
  userDatabase.searchBy(query)
}

Java

Observable<User> querySearchResults =
  querySubject.switchMap(query -> userDatabase.searchBy(query));

Java

LiveData<User> querySearchResults = Transformations.switchMap(
  queryLiveData,
  query -> userDatabase.searchBy(query)
);

使用 flatMapLatest 或 switchMap 等作業可以確保只有最新的結果回傳至使用者介面。如果使用者在資料庫作業完成前變更了查詢輸入內容，這些作業就會捨棄舊查詢的結果，並立即啟動新的搜尋。

篩選資料

另一個常見作業是篩選。您可以根據使用者的條件篩選資料，也可以從使用者介面移除系統根據其他條件隱藏的資料。

由於篩選條件會套用至 PagingData 物件，因此您必須將這些篩選作業放置於 map() 呼叫內。資料從 PagingData 中濾除後，系統會將新的 PagingData 執行個體傳遞至使用者介面層來顯示。

Kotlin

pager.flow // Type is Flow<PagingData<User>>.
  .map { pagingData ->
    pagingData.filter { user -> !user.hiddenFromUi }
  }

Java

// Type is Flowable<PagingData<User>>.
PagingRx.getFlowable(pager)
  .map(pagingData ->
    pagingData.filter(user -> !user.isHiddenFromUi())
  )
}

Java

Transformations.map(
  // Type is LiveData<PagingData<User>>.
  PagingLiveData.getLiveData(pager),
  pagingData ->
    pagingData.filter(user -> !user.isHiddenFromUi())
)

新增清單分隔符

Paging 程式庫支援動態清單分隔符。您可將分隔符直接插入資料串流做為 RecyclerView 清單項目，藉此提升清單可讀性。因此，分隔符為功能完整的 ViewHolder 物件，可提供互動性、無障礙功能焦點，以及 View 提供的所有其他功能。

下列是將分隔符插入分頁清單中的三個步驟：

轉換使用者介面模型以符合分隔符項目。
轉換資料串流，在資料載入和呈現資料之間動態新增分隔符。
更新使用者介面來處理分隔符項目。

轉換使用者介面模型

Paging 程式庫將清單分隔符插入至 RecyclerView 中做為實際清單項目，但分隔符項目必須和清單中的資料項目有區別，才能將這些項目繫結至具有不同使用者介面的不同 ViewHolder 類型。方法是建立 Kotlin 封閉類別搭配子類別，來代表您的資料和分隔符。或者，您也可以建立由清單項目類別和分隔符類別擴充的基本類別。

假設您想將分隔符新增至 User 項目的分頁清單。下列程式碼片段說明如何建立基本類別，其中執行個體可以是 UserModel 或 SeparatorModel：

Kotlin

sealed class UiModel {
  class UserModel(val id: String, val label: String) : UiModel() {
    constructor(user: User) : this(user.id, user.label)
  }

  class SeparatorModel(val description: String) : UiModel()
}

Java

class UiModel {
  private UiModel() {}

  static class UserModel extends UiModel {
    @NonNull
    private String mId;
    @NonNull
    private String mLabel;

    UserModel(@NonNull String id, @NonNull String label) {
      mId = id;
      mLabel = label;
    }

    UserModel(@NonNull User user) {
      mId = user.id;
      mLabel = user.label;
    }

    @NonNull
    public String getId() {
      return mId;
    }

    @NonNull
    public String getLabel() {
      return mLabel;
      }
    }

    static class SeparatorModel extends UiModel {
    @NonNull
    private String mDescription;

    SeparatorModel(@NonNull String description) {
      mDescription = description;
    }

    @NonNull
    public String getDescription() {
      return mDescription;
    }
  }
}

Java

class UiModel {
  private UiModel() {}

  static class UserModel extends UiModel {
    @NonNull
    private String mId;
    @NonNull
    private String mLabel;

    UserModel(@NonNull String id, @NonNull String label) {
      mId = id;
      mLabel = label;
    }

    UserModel(@NonNull User user) {
      mId = user.id;
      mLabel = user.label;
    }

    @NonNull
    public String getId() {
      return mId;
    }

    @NonNull
    public String getLabel() {
      return mLabel;
      }
    }

    static class SeparatorModel extends UiModel {
    @NonNull
    private String mDescription;

    SeparatorModel(@NonNull String description) {
      mDescription = description;
    }

    @NonNull
    public String getDescription() {
      return mDescription;
    }
  }
}