转换数据流

当您处理分页数据时，通常需要在加载数据时转换数据流。例如，您可能需要过滤项目列表，或者在将项目呈现在 UI 中之前将其转换为其他类型。数据流转换的另一个常见用例是添加列表分隔符。

更一般地，直接将转换应用于数据流可让您保持存储库构造和 UI 构造的独立性。

应用基本转换

由于 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() 操作。

一个常见的用例是将网络或数据库层对象映射到 UI 层中专门使用的对象。以下示例演示了如何应用这种映射操作。

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)
)

另一个常见的数据转换是将用户的输入（例如查询字符串）转换为要显示的请求输出。设置此功能需要监听并捕获用户的查询输入，执行请求，并将查询结果推回到 UI。

您可以使用流 API 监听查询输入。将流引用保留在您的 ViewModel 中。UI 层不应直接访问它；相反，定义一个函数来通知 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)
}

当数据流中的查询值发生变化时，您可以执行操作将查询值转换为所需的数据类型，并将结果返回到 UI 层。具体的转换函数取决于所使用的语言和框架，但它们都提供类似的功能。

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 等操作可确保只将最新结果返回到 UI。如果用户在数据库操作完成之前更改了查询输入，这些操作会丢弃旧查询的结果并立即启动新搜索。

过滤数据

另一个常见的操作是过滤。您可以根据用户提供的条件过滤数据，或者如果数据根据其他条件应隐藏，则将其从 UI 中移除。

您需要将这些过滤操作放在 map() 调用中，因为过滤器应用于 PagingData 对象。一旦数据从 PagingData 中过滤掉，新的 PagingData 实例将传递给 UI 层进行显示。

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 提供的所有其他功能。

在分页列表中插入分隔符涉及三个步骤：

转换 UI 模型以适应分隔符项。
转换数据流以在加载数据和呈现数据之间动态添加分隔符。
更新 UI 以处理分隔符项。

转换 UI 模型

Paging 库将列表分隔符作为实际列表项插入到 RecyclerView 中，但分隔符项必须与列表中的数据项区分开来，才能将它们绑定到具有不同 UI 的不同 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;
    }
  }
}