पेज वाले डेटा के साथ काम करते समय, आपको डेटा स्ट्रीम को लोड करते समय अक्सर उसे ट्रांसफ़ॉर्म करना पड़ता है. उदाहरण के लिए, हो सकता है कि आपको आइटम की सूची को फ़िल्टर करना पड़े या उन्हें यूज़र इंटरफ़ेस (यूआई) में दिखाने से पहले, किसी दूसरे टाइप में बदलना पड़े. डेटा स्ट्रीम में बदलाव करने के लिए, सूची के सेपरेटर जोड़ना एक आम तरीका है.
आम तौर पर, डेटा स्ट्रीम पर सीधे तौर पर ट्रांसफ़ॉर्मेशन लागू करने से, आपको अपनी डेटा कलेक्शन और यूज़र इंटरफ़ेस कलेक्शन को अलग-अलग रखने में मदद मिलती है.
इस पेज पर यह माना गया है कि आपको पेजिंग लाइब्रेरी के बुनियादी इस्तेमाल के बारे में पता है.
बुनियादी ट्रांसफ़ॉर्मेशन लागू करना
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) )
डेटा को बदलने का एक और सामान्य तरीका है, उपयोगकर्ता से कोई इनपुट लेना, जैसे कि क्वेरी स्ट्रिंग और उसे डिसप्ले करने के लिए अनुरोध के आउटपुट में बदलना. इसे सेट अप करने के लिए, उपयोगकर्ता की क्वेरी को सुनना और कैप्चर करना, अनुरोध करना, और क्वेरी का नतीजा यूज़र इंटरफ़ेस (यूआई) पर वापस भेजना ज़रूरी है.
स्ट्रीम एपीआई का इस्तेमाल करके, क्वेरी इनपुट को सुना जा सकता है. स्ट्रीम का रेफ़रंस, अपने 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
जैसे ऑपरेशन का इस्तेमाल करने से यह पक्का होता है कि यूज़र इंटरफ़ेस (यूआई) पर सिर्फ़ नए नतीजे दिखाए जाएं. अगर उपयोगकर्ता, डेटाबेस ऑपरेशन पूरा होने से पहले अपनी क्वेरी का इनपुट बदलता है, तो ये ऑपरेशन पुरानी क्वेरी के नतीजों को खारिज कर देते हैं और तुरंत नई खोज शुरू कर देते हैं.
डेटा फ़िल्टर करना
फ़िल्टर करना एक और सामान्य ऑपरेशन है. उपयोगकर्ता की शर्तों के आधार पर डेटा को फ़िल्टर किया जा सकता है. इसके अलावा, अगर डेटा को किसी दूसरी शर्त के आधार पर छिपाना है, तो उसे यूज़र इंटरफ़ेस (यूआई) से हटाया जा सकता है.
आपको इन फ़िल्टर ऑपरेशन को map()
कॉल के अंदर रखना होगा, क्योंकि फ़िल्टर PagingData
ऑब्जेक्ट पर लागू होता है. 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()) )
सूची में सेपरेटर जोड़ना
पेजिंग लाइब्रेरी, डाइनैमिक सूची के सेपरेटर के साथ काम करती है. सीधे तौर पर डेटा स्ट्रीम में RecyclerView
सूची के आइटम के तौर पर सेपरेटर डालकर, सूची को पढ़ने में आसान बनाया जा सकता है. इस वजह से, सेपरेटर, सभी सुविधाओं वाले ViewHolder
ऑब्जेक्ट होते हैं. इनमें इंटरैक्टिविटी, सुलभता फ़ोकस, और View
की अन्य सभी सुविधाएं काम करती हैं.
पेज वाली सूची में सेपरेटर डालने के लिए, ये तीन चरण अपनाएं:
- सेपरेटर आइटम को शामिल करने के लिए, यूज़र इंटरफ़ेस (यूआई) मॉडल को बदलें.
- डेटा स्ट्रीम को बदलकर, डेटा लोड करने और उसे दिखाने के बीच डाइनैमिक तौर पर सेपरेटर जोड़ें.
- सेपरेटर आइटम को मैनेज करने के लिए, यूज़र इंटरफ़ेस (यूआई) को अपडेट करें.
यूज़र इंटरफ़ेस (यूआई) मॉडल को बदलना
पेजिंग लाइब्रेरी, 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; } } }
डेटा स्ट्रीम में बदलाव करना
डेटा स्ट्रीम को लोड करने के बाद और उसे दिखाने से पहले, आपको उस पर ट्रांसफ़ॉर्मेशन लागू करने होंगे. ट्रांसफ़ॉर्मेशन में ये काम होने चाहिए:
- लोड किए गए सूची आइटम को नए बेस आइटम टाइप के हिसाब से बदलें.
- सेपरेटर जोड़ने के लिए,
PagingData.insertSeparators()
वाला तरीका इस्तेमाल करें.
ट्रांसफ़ॉर्मेशन ऑपरेशन के बारे में ज़्यादा जानने के लिए, बुनियादी ट्रांसफ़ॉर्मेशन लागू करना लेख पढ़ें.
नीचे दिए गए उदाहरण में, PagingData<User>
स्ट्रीम को PagingData<UiModel>
स्ट्रीम में बदलने के लिए, ट्रांसफ़ॉर्मेशन ऑपरेशन दिखाए गए हैं. इसमें सेपरेटर भी जोड़े गए हैं:
Kotlin
pager.flow.map { pagingData: PagingData<User> -> // Map outer stream, so you can perform transformations on // each paging generation. pagingData .map { user -> // Convert items in stream to UiModel.UserModel. UiModel.UserModel(user) } .insertSeparators<UiModel.UserModel, UiModel> { before, after -> when { before == null -> UiModel.SeparatorModel("HEADER") after == null -> UiModel.SeparatorModel("FOOTER") shouldSeparate(before, after) -> UiModel.SeparatorModel( "BETWEEN ITEMS $before AND $after" ) // Return null to avoid adding a separator between two items. else -> null } } }
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()
तरीकों में केस जोड़ें. - नया तुलना करने वाला टूल लागू करें.
Kotlin
class UiModelAdapter : PagingDataAdapter<UiModel, RecyclerView.ViewHolder>(UiModelComparator) { override fun onCreateViewHolder( parent: ViewGroup, viewType: Int ) = when (viewType) { R.layout.item -> UserModelViewHolder(parent) else -> SeparatorModelViewHolder(parent) } override fun getItemViewType(position: Int) { // Use peek over getItem to avoid triggering page fetch / drops, since // recycling views is not indicative of the user's current scroll position. return when (peek(position)) { is UiModel.UserModel -> R.layout.item is UiModel.SeparatorModel -> R.layout.separator_item null -> throw IllegalStateException("Unknown view") } } override fun onBindViewHolder( holder: RecyclerView.ViewHolder, position: Int ) { val item = getItem(position) if (holder is UserModelViewHolder) { holder.bind(item as UserModel) } else if (holder is SeparatorModelViewHolder) { holder.bind(item as SeparatorModel) } } } object UiModelComparator : DiffUtil.ItemCallback<UiModel>() { override fun areItemsTheSame( oldItem: UiModel, newItem: UiModel ): Boolean { val isSameRepoItem = oldItem is UiModel.UserModel && newItem is UiModel.UserModel && oldItem.id == newItem.id val isSameSeparatorItem = oldItem is UiModel.SeparatorModel && newItem is UiModel.SeparatorModel && oldItem.description == newItem.description return isSameRepoItem || isSameSeparatorItem } override fun areContentsTheSame( oldItem: UiModel, newItem: UiModel ) = oldItem == 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); } }
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 में आखिरी कॉल होना चाहिए.
Kotlin
pager.flow // Type is Flow<PagingData<User>>. .map { pagingData -> pagingData.filter { user -> !user.hiddenFromUi } .map { user -> UiModel.UserModel(user) } } .cachedIn(viewModelScope)
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);
PagingData
की स्ट्रीम के साथ cachedIn()
का इस्तेमाल करने के बारे में ज़्यादा जानने के लिए, PagingData की स्ट्रीम सेट अप करना देखें.
अन्य संसाधन
पेजिंग लाइब्रेरी के बारे में ज़्यादा जानने के लिए, यहां दिए गए अन्य संसाधन देखें:
कोडलैब
आपके लिए सुझाव
- ध्यान दें: JavaScript बंद होने पर लिंक टेक्स्ट दिखता है
- पेज किए गए डेटा को लोड और दिखाना
- पेजिंग लागू करने की जांच करना
- लोड होने की स्थिति मैनेज करना और दिखाना