Основные понятия и реализация Jetpack Compose
При работе с данными, разбитыми на страницы, часто требуется преобразовывать поток данных по мере его загрузки. Например, вам может потребоваться отфильтровать список элементов или преобразовать элементы в другой тип, прежде чем представлять их в пользовательском интерфейсе. Ещё один распространенный вариант использования преобразования потока данных – добавление разделителей списков.
В более общем плане применение преобразований непосредственно к потоку данных позволяет вам разделить конструкции репозитория и конструкции пользовательского интерфейса.
Предполагается, что вы знакомы с основами использования библиотеки Paging.
Примените базовые преобразования
Поскольку PagingData инкапсулируется в реактивный поток, вы можете применять операции преобразования к данным постепенно между загрузкой данных и их представлением.
Чтобы применить преобразования к каждому объекту PagingData в потоке, поместите преобразования в операцию map() в потоке:
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, вы можете выполнить операцию map() для каждого элемента в списке страниц в объекте PagingData.
Один из распространенных примеров использования – сопоставление объекта сетевого уровня или уровня базы данных с объектом, который используется на уровне интерфейса. В примере ниже показано, как применить этот тип операции с картой:
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 о запросе пользователя.
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) }
Когда значение запроса изменяется в потоке данных, вы можете выполнять операции по преобразованию значения запроса в желаемый тип данных и возвращать результат на уровень пользовательского интерфейса. Конкретная функция преобразования зависит от используемого языка и фреймворка, но все они предоставляют схожие возможности.
Java
Observable<User> querySearchResults = querySubject.switchMap(query -> userDatabase.searchBy(query));
Java
LiveData<User> querySearchResults = Transformations.switchMap( queryLiveData, query -> userDatabase.searchBy(query) );
Использование таких операций, как flatMapLatest или switchMap, гарантирует, что в интерфейсе будут показаны только последние результаты. Если пользователь изменит запрос до завершения операции с базой данных, эти операции отбросят результаты старого запроса и немедленно запустят новый поиск.
Введите фильтр
Ещё одна распространённая операция – фильтрация. Вы можете фильтровать данные на основе критериев пользователя или удалять данные из интерфейса, если они должны быть скрыты на основе других критериев.
Эти операции фильтрации необходимо поместить в вызов map(), поскольку фильтр применяется к объекту PagingData. После того, как данные будут отфильтрованы из PagingData, новый экземпляр PagingData передается на уровень пользовательского интерфейса для отображения.
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.
There are three steps involved in inserting separators into your paged list:
- Преобразуйте модель пользовательского интерфейса, чтобы разместить элементы-разделители.
- Преобразуйте поток данных, чтобы динамически добавлять разделители между загрузкой и показом данных.
- Обновите интерфейс, чтобы обрабатывать элементы-разделители.
Преобразование модели пользовательского интерфейса
Библиотека Paging вставляет разделители списка в RecyclerView как фактические элементы списка, но элементы-разделители должны отличаться от элементов данных в списке, чтобы их можно было привязать к другому типу ViewHolder с отдельным пользовательским интерфейсом. Решение состоит в том, чтобы создать изолированный класс Kotlin с подклассами, представляющими ваши данные и разделители. Вы также можете создать базовый класс, который будет расширен классом элемента списка и классом разделителя.
Предположим, вы хотите добавить разделители в постраничный список элементов User. В следующем фрагменте кода показано, как создать базовый класс, экземплярами которого могут быть объекты UserModel или SeparatorModel.
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; } } }
Преобразование потока данных
Преобразования должны применяться к потоку данных после его загрузки и до показа. Преобразования должны выполнять следующие действия:
- Преобразуйте загруженные элементы списка, чтобы отразить новый тип базового элемента.
- Используйте метод
PagingData.insertSeparators(), чтобы добавить разделители.
Подробнее о базовых преобразованиях…
В примере ниже показаны операции преобразования, которые позволяют обновить поток PagingData<User> до потока PagingData<UiModel> с добавленными разделителями.
Java
// Map outer stream, so you can perform transformations on each // paging generation. PagingRx.getFlowable(pager).map(pagingData -> { // First convert items in stream to UiModel.UserModel. PagingData<UiModel> uiModelPagingData = pagingData.map( UiModel.UserModel::new); // Insert UiModel.SeparatorModel, which produces PagingData of // generic type UiModel. return PagingData.insertSeparators(uiModelPagingData, (@Nullable UiModel before, @Nullable UiModel after) -> { if (before == null) { return new UiModel.SeparatorModel("HEADER"); } else if (after == null) { return new UiModel.SeparatorModel("FOOTER"); } else if (shouldSeparate(before, after)) { return new UiModel.SeparatorModel("BETWEEN ITEMS " + before.toString() + " AND " + after.toString()); } else { // Return null to avoid adding a separator between two // items. return null; } }); });
Java
// Map outer stream, so you can perform transformations on each // paging generation. Transformations.map(PagingLiveData.getLiveData(pager), pagingData -> { // First convert items in stream to UiModel.UserModel. PagingData<UiModel> uiModelPagingData = pagingData.map( UiModel.UserModel::new); // Insert UiModel.SeparatorModel, which produces PagingData of // generic type UiModel. return PagingData.insertSeparators(uiModelPagingData, (@Nullable UiModel before, @Nullable UiModel after) -> { if (before == null) { return new UiModel.SeparatorModel("HEADER"); } else if (after == null) { return new UiModel.SeparatorModel("FOOTER"); } else if (shouldSeparate(before, after)) { return new UiModel.SeparatorModel("BETWEEN ITEMS " + before.toString() + " AND " + after.toString()); } else { // Return null to avoid adding a separator between two // items. return null; } }); });
Как обрабатывать разделители в интерфейсе
Последний шаг — изменить пользовательский интерфейс, чтобы он поддерживал тип элемента-разделителя.
Создайте макет и держатель представления для элементов-разделителей и измените адаптер списка, чтобы использовать RecyclerView.ViewHolder в качестве типа держателя представления, чтобы он мог обрабатывать более одного типа держателя представления. Вы также можете определить общий базовый класс, который расширяют классы держателей представлений элементов и разделителей.
В адаптер списка также необходимо внести следующие изменения:
- Добавьте в методы
onCreateViewHolder()иonBindViewHolder()варианты для элементов списка, которые являются разделителями. - Реализуйте новый компаратор.
Java
class UiModelAdapter extends PagingDataAdapter<UiModel, RecyclerView.ViewHolder> { UiModelAdapter() { super(new UiModelComparator(), Dispatchers.getMain(), Dispatchers.getDefault()); } @NonNull @Override public RecyclerView.ViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) { if (viewType == R.layout.item) { return new UserModelViewHolder(parent); } else { return new SeparatorModelViewHolder(parent); } } @Override public int getItemViewType(int position) { // Use peek over getItem to avoid triggering page fetch / drops, since // recycling views is not indicative of the user's current scroll position. UiModel item = peek(position); if (item instanceof UiModel.UserModel) { return R.layout.item; } else if (item instanceof UiModel.SeparatorModel) { return R.layout.separator_item; } else { throw new IllegalStateException("Unknown view"); } } @Override public void onBindViewHolder(@NonNull RecyclerView.ViewHolder holder, int position) { if (holder instanceOf UserModelViewHolder) { UserModel userModel = (UserModel) getItem(position); ((UserModelViewHolder) holder).bind(userModel); } else { SeparatorModel separatorModel = (SeparatorModel) getItem(position); ((SeparatorModelViewHolder) holder).bind(separatorModel); } } } class UiModelComparator extends DiffUtil.ItemCallback<UiModel> { @Override public boolean areItemsTheSame(@NonNull UiModel oldItem, @NonNull UiModel newItem) { boolean isSameRepoItem = oldItem instanceof UserModel && newItem instanceof UserModel && ((UserModel) oldItem).getId().equals(((UserModel) newItem).getId()); boolean isSameSeparatorItem = oldItem instanceof SeparatorModel && newItem instanceof SeparatorModel && ((SeparatorModel) oldItem).getDescription().equals( ((SeparatorModel) newItem).getDescription()); return isSameRepoItem || isSameSeparatorItem; } @Override public boolean areContentsTheSame(@NonNull UiModel oldItem, @NonNull UiModel newItem) { return oldItem.equals(newItem); } }
Java
class UiModelAdapter extends PagingDataAdapter<UiModel, RecyclerView.ViewHolder> { UiModelAdapter() { super(new UiModelComparator(), Dispatchers.getMain(), Dispatchers.getDefault()); } @NonNull @Override public RecyclerView.ViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) { if (viewType == R.layout.item) { return new UserModelViewHolder(parent); } else { return new SeparatorModelViewHolder(parent); } } @Override public int getItemViewType(int position) { // Use peek over getItem to avoid triggering page fetch / drops, since // recycling views is not indicative of the user's current scroll position. UiModel item = peek(position); if (item instanceof UiModel.UserModel) { return R.layout.item; } else if (item instanceof UiModel.SeparatorModel) { return R.layout.separator_item; } else { throw new IllegalStateException("Unknown view"); } } @Override public void onBindViewHolder(@NonNull RecyclerView.ViewHolder holder, int position) { if (holder instanceOf UserModelViewHolder) { UserModel userModel = (UserModel) getItem(position); ((UserModelViewHolder) holder).bind(userModel); } else { SeparatorModel separatorModel = (SeparatorModel) getItem(position); ((SeparatorModelViewHolder) holder).bind(separatorModel); } } } class UiModelComparator extends DiffUtil.ItemCallback<UiModel> { @Override public boolean areItemsTheSame(@NonNull UiModel oldItem, @NonNull UiModel newItem) { boolean isSameRepoItem = oldItem instanceof UserModel && newItem instanceof UserModel && ((UserModel) oldItem).getId().equals(((UserModel) newItem).getId()); boolean isSameSeparatorItem = oldItem instanceof SeparatorModel && newItem instanceof SeparatorModel && ((SeparatorModel) oldItem).getDescription().equals( ((SeparatorModel) newItem).getDescription()); return isSameRepoItem || isSameSeparatorItem; } @Override public boolean areContentsTheSame(@NonNull UiModel oldItem, @NonNull UiModel newItem) { return oldItem.equals(newItem); } }
Избегайте дублирования работы
Одна из основных проблем, которых следует избегать, – выполнение приложением ненужных действий. Получение данных – это ресурсоемкая операция, а их преобразование может занять много времени. После того как данные загружены и подготовлены к показу в интерфейсе, их следует сохранить на случай, если произойдет изменение конфигурации и интерфейс потребуется создать заново.
Операция cachedIn() кеширует результаты всех преобразований, которые происходят до нее. Поэтому cachedIn() должен быть последним вызовом в ViewModel.
Java
// CoroutineScope helper provided by the lifecycle-viewmodel-ktx artifact. CoroutineScope viewModelScope = ViewModelKt.getViewModelScope(viewModel); PagingRx.cachedIn( // Type is Flowable<PagingData<User>>. PagingRx.getFlowable(pager) .map(pagingData -> pagingData .filter(user -> !user.isHiddenFromUi()) .map(UiModel.UserModel::new)), viewModelScope); }
Java
// CoroutineScope helper provided by the lifecycle-viewmodel-ktx artifact. CoroutineScope viewModelScope = ViewModelKt.getViewModelScope(viewModel); PagingLiveData.cachedIn( Transformations.map( // Type is LiveData<PagingData<User>>. PagingLiveData.getLiveData(pager), pagingData -> pagingData .filter(user -> !user.isHiddenFromUi()) .map(UiModel.UserModel::new)), viewModelScope);
Дополнительную информацию об использовании cachedIn() с потоком PagingData можно найти в статье Как настроить поток PagingData.
Рекомендуем
- Примечание. Текст ссылки показывается, когда JavaScript отключен.
- Загрузка и отображение данных с разбивкой по страницам
- Как протестировать реализацию Paging
- Управление состояниями загрузки и их представление