पेज वाली सूचियां दिखाएं

यह दस्तावेज़, पेजिंग लाइब्रेरी की खास जानकारी पर आधारित है. इसमें बताया गया है कि अपने ऐप्लिकेशन के यूज़र इंटरफ़ेस (यूआई) में, उपयोगकर्ताओं को जानकारी की सूचियां कैसे दिखाई जा सकती हैं. खास तौर पर, तब जब यह जानकारी बदलती है.

यूज़र इंटरफ़ेस (यूआई) को व्यू मॉडल से कनेक्ट करना

LiveData<PagedList> के इंस्टेंस को PagedListAdapter से कनेक्ट किया जा सकता है. इसके लिए, यहां दिया गया कोड स्निपेट देखें:

Kotlin

class ConcertActivity : AppCompatActivity() {
    private val adapter = ConcertAdapter()

    // Use the 'by viewModels()' Kotlin property delegate
    // from the activity-ktx artifact
    private val viewModel: ConcertViewModel by viewModels()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState);
        viewModel.concerts.observe(this, Observer { adapter.submitList(it) })
    }
}

Java

public class ConcertActivity extends AppCompatActivity {
    private ConcertAdapter adapter = new ConcertAdapter();
    private ConcertViewModel viewModel;

    @Override
    public void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        viewModel = new ViewModelProvider(this).get(ConcertViewModel.class);
        viewModel.concertList.observe(this, adapter::submitList);
    }
}

डेटा सोर्स, PagedList के नए इंस्टेंस उपलब्ध कराते हैं. इसलिए, गतिविधि इन ऑब्जेक्ट को अडैप्टर को भेजती है. PagedListAdapter को लागू करने से यह तय होता है कि अपडेट कैसे कैलकुलेट किए जाते हैं. साथ ही, यह पेजिंग और सूची में अंतर को अपने-आप मैनेज करता है. इसलिए, आपके ViewHolder को सिर्फ़ दिए गए किसी खास आइटम से बाइंड करना होगा:

Kotlin

class ConcertAdapter() :
        PagedListAdapter<Concert, ConcertViewHolder>(DIFF_CALLBACK) {
    override fun onBindViewHolder(holder: ConcertViewHolder, position: Int) {
        val concert: Concert? = getItem(position)

        // Note that "concert" is a placeholder if it's null.
        holder.bindTo(concert)
    }

    companion object {
        private val DIFF_CALLBACK = ... // See Implement the diffing callback section.
    }
}

Java

public class ConcertAdapter
        extends PagedListAdapter<Concert, ConcertViewHolder> {
    protected ConcertAdapter() {
        super(DIFF_CALLBACK);
    }

    @Override
    public void onBindViewHolder(@NonNull ConcertViewHolder holder,
            int position) {
        Concert concert = getItem(position);

        // Note that "concert" can be null if it's a placeholder.
        holder.bindTo(concert);
    }

    private static DiffUtil.ItemCallback<Concert> DIFF_CALLBACK
            = ... // See Implement the diffing callback section.
}

PagedListAdapter, PagedList.Callback ऑब्जेक्ट का इस्तेमाल करके, पेज लोड इवेंट को मैनेज करता है. जब उपयोगकर्ता स्क्रोल करता है, तब PagedListAdapter, PagedList.loadAround() को कॉल करता है, ताकि वह PagedList को हिंट दे सके कि उसे DataSource से कौनसे आइटम फ़ेच करने चाहिए.

डिफ़िंग कॉलबैक लागू करना

यहां दिए गए सैंपल में, areContentsTheSame() को मैन्युअल तरीके से लागू करने का तरीका बताया गया है. यह काम के ऑब्जेक्ट फ़ील्ड की तुलना करता है:

Kotlin

private val DIFF_CALLBACK = object : DiffUtil.ItemCallback<Concert>() {
    // The ID property identifies when items are the same.
    override fun areItemsTheSame(oldItem: Concert, newItem: Concert) =
            oldItem.id == newItem.id

    // If you use the "==" operator, make sure that the object implements
    // .equals(). Alternatively, write custom data comparison logic here.
    override fun areContentsTheSame(
            oldItem: Concert, newItem: Concert) = oldItem == newItem
}

Java

private static DiffUtil.ItemCallback<Concert> DIFF_CALLBACK =
        new DiffUtil.ItemCallback<Concert>() {

    @Override
    public boolean areItemsTheSame(Concert oldItem, Concert newItem) {
        // The ID property identifies when items are the same.
        return oldItem.getId() == newItem.getId();
    }

    @Override
    public boolean areContentsTheSame(Concert oldItem, Concert newItem) {
        // Don't use the "==" operator here. Either implement and use .equals(),
        // or write custom data comparison logic here.
        return oldItem.equals(newItem);
    }
};

आपके अडैप्टर में आइटम की तुलना करने की परिभाषा शामिल होती है. इसलिए, नया PagedList ऑब्जेक्ट लोड होने पर, अडैप्टर इन आइटम में हुए बदलावों का अपने-आप पता लगा लेता है. इस वजह से, अडैप्टर आपके RecyclerView ऑब्जेक्ट में आइटम के असरदार ऐनिमेशन ट्रिगर करता है.

अलग तरह के अडैप्टर का इस्तेमाल करके अंतर करना

अगर आपको PagedListAdapter से इनहेरिट नहीं करना है, जैसे कि ऐसी लाइब्रेरी का इस्तेमाल करते समय जो अपना अडैप्टर उपलब्ध कराती है, तो भी Paging Library अडैप्टर के डिफ़िंग फ़ंक्शन का इस्तेमाल किया जा सकता है. इसके लिए, आपको सीधे AsyncPagedListDiffer ऑब्जेक्ट के साथ काम करना होगा.

अपने यूज़र इंटरफ़ेस (यूआई) में प्लेसहोल्डर उपलब्ध कराना

अगर आपको ऐप्लिकेशन का डेटा फ़ेच होने से पहले, यूज़र इंटरफ़ेस (यूआई) में कोई सूची दिखानी है, तो उपयोगकर्ताओं को प्लेसहोल्डर सूची के आइटम दिखाए जा सकते हैं. PagedList इस मामले को हैंडल करता है. इसके लिए, वह सूची के आइटम के डेटा को null के तौर पर दिखाता है. ऐसा तब तक होता है, जब तक डेटा लोड नहीं हो जाता.

प्लेसहोल्डर के ये फ़ायदे हैं:

  • स्क्रोलबार के लिए सहायता: PagedList, PagedListAdapter को सूची में मौजूद आइटम की संख्या उपलब्ध कराता है. इस जानकारी की मदद से, अडैप्टर एक स्क्रोलबार बनाता है. इससे सूची का पूरा साइज़ दिखता है. नए पेज लोड होने पर, स्क्रोलबार जंप नहीं करता, क्योंकि आपकी सूची का साइज़ नहीं बदलता.
  • लोडिंग स्पिनर की ज़रूरत नहीं है: सूची का साइज़ पहले से पता होने की वजह से, उपयोगकर्ताओं को यह बताने की ज़रूरत नहीं है कि और आइटम लोड हो रहे हैं. प्लेसहोल्डर से ही यह जानकारी मिल जाती है.

हालांकि, प्लेसहोल्डर के लिए सहायता जोड़ने से पहले, इन ज़रूरी शर्तों को ध्यान में रखें:

  • गिने जा सकने वाले डेटासेट की ज़रूरत होती है: रूम परसिस्टेंस लाइब्रेरी से DataSource के इंस्टेंस, अपने आइटम को बेहतर तरीके से गिन सकते हैं. हालांकि, अगर कस्टम लोकल स्टोरेज सलूशन या सिर्फ़ नेटवर्क वाले डेटा आर्किटेक्चर का इस्तेमाल किया जा रहा है, तो यह तय करना महंगा या नामुमकिन हो सकता है कि आपके डेटासेट में कितने आइटम हैं.
  • अनलोड किए गए आइटम को दिखाने के लिए, अडैप्टर की ज़रूरत होती है: अडैप्टर या प्रज़ेंटेशन मैकेनिज़्म, जिसका इस्तेमाल इनफ़्लेशन के लिए सूची तैयार करने के लिए किया जाता है, उसे सूची के खाली आइटम को हैंडल करना होगा. उदाहरण के लिए, डेटा को ViewHolder से बाइंड करते समय, आपको अनलोड किए गए डेटा को दिखाने के लिए डिफ़ॉल्ट वैल्यू देनी होंगी.
  • एक ही साइज़ के आइटम व्यू की ज़रूरत होती है: अगर सूची के आइटम के साइज़ उनके कॉन्टेंट के हिसाब से बदल सकते हैं, जैसे कि सोशल नेटवर्किंग अपडेट, तो आइटम के बीच क्रॉसफ़ेडिंग अच्छी नहीं लगती. हमारा सुझाव है कि इस मामले में प्लेसहोल्डर बंद कर दें.

सुझाव/राय दें या शिकायत करें

इन संसाधनों के ज़रिए, अपने सुझाव, शिकायत या राय और आइडिया हमारे साथ शेयर करें:

समस्या को ट्रैक करने वाला टूल
समस्याओं की शिकायत करें, ताकि हम बग ठीक कर सकें.

अन्य संसाधन

पेजिंग लाइब्रेरी के बारे में ज़्यादा जानने के लिए, यहां दिए गए संसाधन देखें.

सैंपल

कोडलैब

वीडियो