ภาพรวมไลบรารี Paging 2 เป็นส่วนหนึ่งของ Android Jetpack
ไลบรารีเพจจิ้งช่วยให้คุณโหลดและแสดงข้อมูลจำนวนเล็กน้อยได้ทีละส่วน การโหลดข้อมูลบางส่วนตามต้องการจะช่วยลดการใช้แบนด์วิดท์เครือข่ายและทรัพยากรระบบ
คู่มือนี้แสดงตัวอย่างแนวคิดหลายรายการของไลบรารี พร้อมภาพรวมวิธีการทำงาน หากต้องการดูตัวอย่างที่เสร็จสมบูรณ์เกี่ยวกับวิธีการทำงานของไลบรารีนี้ ให้ลองใช้ Codelab และตัวอย่างจากส่วนแหล่งข้อมูลเพิ่มเติม
ตั้งค่า
หากต้องการนำเข้าคอมโพเนนต์ Paging ไปยังแอป Android ให้เพิ่มทรัพยากร Dependency ต่อไปนี้ลงในไฟล์ build.gradle ของแอป
Groovy
dependencies { def paging_version = "2.1.2" implementation "androidx.paging:paging-runtime:$paging_version" // For Kotlin use paging-runtime-ktx // alternatively - without Android dependencies for testing testImplementation "androidx.paging:paging-common:$paging_version" // For Kotlin use paging-common-ktx // optional - RxJava support implementation "androidx.paging:paging-rxjava2:$paging_version" // For Kotlin use paging-rxjava2-ktx }
Kotlin
dependencies { val paging_version = "2.1.2" implementation("androidx.paging:paging-runtime:$paging_version") // For Kotlin use paging-runtime-ktx // alternatively - without Android dependencies for testing testImplementation("androidx.paging:paging-common:$paging_version") // For Kotlin use paging-common-ktx // optional - RxJava support implementation("androidx.paging:paging-rxjava2:$paging_version") // For Kotlin use paging-rxjava2-ktx }
สถาปัตยกรรมของไลบรารี
ส่วนนี้จะอธิบายและแสดงองค์ประกอบหลักของไลบรารีการแบ่งหน้า
PagedList
องค์ประกอบหลักของไลบรารีเพจจิ้งคือคลาส PagedList ซึ่งจะโหลดข้อมูลของแอปเป็นกลุ่มๆ หรือหน้า เมื่อต้องการข้อมูลเพิ่มเติม ระบบจะแบ่งหน้าข้อมูลลงในออบเจ็กต์ PagedList ที่มีอยู่ หากข้อมูลที่โหลดมีการเปลี่ยนแปลง ระบบจะส่งอินสแตนซ์ใหม่ของ PagedList ไปยังตัวยึดข้อมูลที่ได้รับอนุญาตให้สังเกตพฤติกรรมผู้ใช้ได้ที่สังเกตได้จาก LiveData หรือออบเจ็กต์ที่ใช้ RxJava2 เมื่อสร้างออบเจ็กต์ PagedList แล้ว UI ของแอปจะแสดงเนื้อหาของออบเจ็กต์เหล่านั้น โดยยังคงเคารพวงจรของตัวควบคุม UI
ข้อมูลโค้ดต่อไปนี้แสดงวิธีกำหนดค่าโมเดลมุมมองของแอปเพื่อโหลดและแสดงข้อมูลโดยใช้ตัวยึด LiveData ของออบเจ็กต์ PagedList
Kotlin
class ConcertViewModel(concertDao: ConcertDao) : ViewModel() {
val concertList: LiveData<PagedList<Concert>> =
concertDao.concertsByDate().toLiveData(pageSize = 50)
}
Java
public class ConcertViewModel extends ViewModel {
private ConcertDao concertDao;
public final LiveData<PagedList<Concert>> concertList;
// Creates a PagedList object with 50 items per page.
public ConcertViewModel(ConcertDao concertDao) {
this.concertDao = concertDao;
concertList = new LivePagedListBuilder<>(
concertDao.concertsByDate(), 50).build();
}
}
ข้อมูล
PagedList แต่ละอินสแตนซ์จะโหลดสแนปชอตล่าสุดของข้อมูลแอปจากออบเจ็กต์ DataSource ที่เกี่ยวข้อง ข้อมูลจะไหลจากแบ็กเอนด์หรือฐานข้อมูลของแอปไปยังออบเจ็กต์ PagedList
ตัวอย่างต่อไปนี้ใช้ไลบรารี Room Persistence เพื่อจัดระเบียบข้อมูลของแอป แต่หากต้องการจัดเก็บข้อมูลโดยใช้วิธีอื่น คุณก็จัดเตรียมโรงงานแหล่งข้อมูลของคุณเองได้เช่นกัน
Kotlin
@Dao
interface ConcertDao {
// The Int type parameter tells Room to use a PositionalDataSource object.
@Query("SELECT * FROM concerts ORDER BY date DESC")
fun concertsByDate(): DataSource.Factory<Int, Concert>
}
Java
@Dao
public interface ConcertDao {
// The Integer type parameter tells Room to use a
// PositionalDataSource object.
@Query("SELECT * FROM concerts ORDER BY date DESC")
DataSource.Factory<Integer, Concert> concertsByDate();
}
ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีโหลดข้อมูลลงในออบเจ็กต์ PagedList ได้ที่คำแนะนำเกี่ยวกับวิธีโหลดข้อมูลที่มีการแบ่งหน้า
UI
คลาส PagedList จะทำงานร่วมกับ PagedListAdapter เพื่อโหลดรายการลงใน RecyclerView คลาสเหล่านี้ทำงานร่วมกันเพื่อดึงข้อมูลและแสดงเนื้อหาขณะที่โหลด ดึงข้อมูลเนื้อหาที่อยู่นอกมุมมองล่วงหน้า และทำให้การเปลี่ยนแปลงเนื้อหาเคลื่อนไหว
ดูข้อมูลเพิ่มเติมได้ที่คำแนะนำเกี่ยวกับวิธีแสดงรายการที่มีการแบ่งหน้า
รองรับสถาปัตยกรรมข้อมูลที่แตกต่างกัน
ไลบรารี Paging รองรับสถาปัตยกรรมข้อมูลต่อไปนี้
- แสดงจากเซิร์ฟเวอร์แบ็กเอนด์เท่านั้น
- จัดเก็บไว้ในฐานข้อมูลในอุปกรณ์เท่านั้น
- การรวมแหล่งข้อมูลอื่นๆ โดยใช้ฐานข้อมูลในอุปกรณ์เป็นแคช
รูปที่ 1 แสดงวิธีการไหลของข้อมูลในสถานการณ์สถาปัตยกรรมแต่ละแบบ ในกรณีของโซลูชันเฉพาะเครือข่ายหรือเฉพาะฐานข้อมูล ข้อมูลจะส่งไปยังโมเดล UI ของแอปโดยตรง หากคุณใช้แนวทางแบบผสม ข้อมูลจะไหลจากเซิร์ฟเวอร์แบ็กเอนด์ไปยังฐานข้อมูลในอุปกรณ์ แล้วจึงไปยังโมเดล UI ของแอป ปลายทางของกระแสข้อมูลแต่ละรายการจะไม่มีข้อมูลให้โหลดเป็นครั้งคราว ซึ่งเมื่อถึงจุดนั้น ปลายทางจะขอข้อมูลเพิ่มเติมจากคอมโพเนนต์ที่ให้ข้อมูล ตัวอย่างเช่น เมื่อฐานข้อมูลในอุปกรณ์ไม่มีข้อมูลแล้ว ก็จะขอข้อมูลเพิ่มเติมจากเซิร์ฟเวอร์
ส่วนที่เหลือของส่วนนี้จะให้คำแนะนำในการกำหนดค่ากรณีการใช้งานการไหลของข้อมูลแต่ละกรณี
เครือข่ายเท่านั้น
หากต้องการแสดงข้อมูลจากเซิร์ฟเวอร์แบ็กเอนด์ ให้ใช้ Retrofit API เวอร์ชันซิงโครนัสเพื่อโหลดข้อมูลลงในDataSourceออบเจ็กต์ที่กำหนดเอง
ฐานข้อมูลเท่านั้น
ตั้งค่า RecyclerView เพื่อสังเกตพื้นที่เก็บข้อมูลในเครื่อง โดยควรใช้ไลบรารี Room Persistence ด้วยวิธีนี้ เมื่อใดก็ตามที่มีการแทรกหรือแก้ไขข้อมูลในฐานข้อมูลของแอป การเปลี่ยนแปลงเหล่านี้จะแสดงใน RecyclerView ที่แสดงข้อมูลนี้โดยอัตโนมัติ
เครือข่ายและฐานข้อมูล
หลังจากเริ่มสังเกตฐานข้อมูลแล้ว คุณสามารถฟังเมื่อฐานข้อมูลไม่มีข้อมูลโดยใช้ PagedList.BoundaryCallback จากนั้นคุณสามารถดึงข้อมูลรายการเพิ่มเติมจากเครือข่ายและแทรกลงในฐานข้อมูลได้ หาก UI ของคุณกำลังสังเกตฐานข้อมูลอยู่ คุณก็ไม่ต้องดำเนินการใดๆ เพิ่มเติม
จัดการข้อผิดพลาดเกี่ยวกับเครือข่าย
เมื่อใช้เครือข่ายเพื่อดึงข้อมูลหรือแบ่งหน้าข้อมูลที่คุณแสดงโดยใช้ไลบรารี Paging สิ่งสำคัญคืออย่าถือว่าเครือข่าย "พร้อมใช้งาน" หรือ "ไม่พร้อมใช้งาน" ตลอดเวลา เนื่องจากการเชื่อมต่อจำนวนมากไม่ต่อเนื่องหรือไม่เสถียร
- เซิร์ฟเวอร์บางเครื่องอาจไม่ตอบสนองต่อคำขอเครือข่าย
- อุปกรณ์อาจเชื่อมต่อกับเครือข่ายที่ช้าหรือมีสัญญาณอ่อน
แต่แอปควรตรวจสอบคำขอแต่ละรายการเพื่อหาข้อผิดพลาดและกู้คืนอย่างราบรื่นที่สุดในกรณีที่เครือข่ายไม่พร้อมใช้งาน เช่น คุณสามารถระบุปุ่ม "ลองอีกครั้ง" ให้ผู้ใช้เลือกได้หากขั้นตอนการรีเฟรชข้อมูลไม่ทำงาน หากเกิดข้อผิดพลาดระหว่างขั้นตอนการแบ่งหน้าข้อมูล คุณควรลองส่งคำขอแบ่งหน้าอีกครั้งโดยอัตโนมัติ
อัปเดตแอปที่มีอยู่
หากแอปใช้ข้อมูลจากฐานข้อมูลหรือแหล่งที่มาของแบ็กเอนด์อยู่แล้ว คุณสามารถอัปเกรดเป็นฟังก์ชันการทำงานที่ไลบรารี Paging มีให้ได้โดยตรง ส่วนนี้จะแสดงวิธีอัปเกรดแอปที่มีการออกแบบทั่วไปอยู่แล้ว
โซลูชันการเรียกใช้ที่กำหนดเอง
หากคุณใช้ฟังก์ชันการทำงานที่กำหนดเองเพื่อโหลดชุดย่อยของข้อมูลขนาดเล็กจากแหล่งข้อมูลของแอป คุณสามารถแทนที่ตรรกะนี้ด้วยตรรกะจากคลาส PagedList ได้ อินสแตนซ์ของ PagedList มีการเชื่อมต่อในตัวกับแหล่งข้อมูลทั่วไป อินสแตนซ์เหล่านี้ยังมีอะแดปเตอร์สำหรับออบเจ็กต์ RecyclerView ที่คุณอาจรวมไว้ใน UI ของแอปด้วย
ข้อมูลที่โหลดโดยใช้รายการแทนหน้าเว็บ
หากคุณใช้รายการในหน่วยความจำเป็นโครงสร้างข้อมูลสำรองสำหรับอะแดปเตอร์ของ UI ให้พิจารณาตรวจสอบการอัปเดตข้อมูลโดยใช้คลาส PagedList หากจำนวนรายการในลิสต์อาจมีขนาดใหญ่ อินสแตนซ์ของ PagedList สามารถใช้ LiveData<PagedList> หรือ Observable<List> เพื่อส่งการอัปเดตข้อมูลไปยัง UI ของแอป ซึ่งจะช่วยลดเวลาในการโหลดและการใช้งานหน่วยความจำ ยิ่งไปกว่านั้น การแทนที่ออบเจ็กต์ List ด้วยออบเจ็กต์ PagedList ในแอปไม่จำเป็นต้องทำการเปลี่ยนแปลงโครงสร้าง UI หรือตรรกะการอัปเดตข้อมูลของแอป
เชื่อมโยงเคอร์เซอร์ข้อมูลกับมุมมองรายการโดยใช้ CursorAdapter
แอปของคุณอาจใช้ CursorAdapter เพื่อเชื่อมโยงข้อมูลจาก Cursor กับ ListView ในกรณีนี้ โดยปกติแล้วคุณจะต้องย้ายข้อมูลจาก ListView ไปยัง RecyclerView เป็นคอนเทนเนอร์ UI รายการของแอป จากนั้นแทนที่คอมโพเนนต์ Cursor ด้วย Room หรือ PositionalDataSource โดยขึ้นอยู่กับว่าอินสแตนซ์ของ Cursor เข้าถึงฐานข้อมูล SQLite หรือไม่
ในบางสถานการณ์ เช่น เมื่อทำงานกับอินสแตนซ์ของ Spinner คุณจะต้องระบุเฉพาะตัวอะแดปเตอร์เท่านั้น จากนั้นไลบรารีจะนำข้อมูลที่โหลดไว้ในอะแดปเตอร์นั้นมาแสดงให้คุณเห็น ในสถานการณ์เหล่านี้ ให้เปลี่ยนประเภทข้อมูลของอะแดปเตอร์เป็น LiveData<PagedList> แล้วรวมรายการนี้ไว้ในออบเจ็กต์ ArrayAdapter ก่อนที่จะพยายามให้คลาสไลบรารีขยายรายการเหล่านี้ใน UI
โหลดเนื้อหาแบบอะซิงโครนัสโดยใช้ AsyncListUtil
หากคุณใช้ออบเจ็กต์ AsyncListUtil เพื่อโหลดและแสดงกลุ่มข้อมูลแบบอะซิงโครนัส ไลบรารี Paging จะช่วยให้การโหลดข้อมูลง่ายขึ้น ดังนี้
- ข้อมูลของคุณไม่จำเป็นต้องเป็นข้อมูลตำแหน่ง ไลบรารี Paging ช่วยให้คุณโหลดข้อมูลจากแบ็กเอนด์ได้โดยตรงโดยใช้คีย์ที่เครือข่ายให้มา
- ข้อมูลของคุณอาจมีขนาดใหญ่จนนับไม่ถ้วน เมื่อใช้ไลบรารีเพจจิ้ง คุณจะโหลดข้อมูลลงในหน้าต่างๆ ได้จนกว่าจะไม่มีข้อมูลเหลืออยู่
- คุณจะสังเกตข้อมูลได้ง่ายขึ้น ไลบรารีการแบ่งหน้าสามารถแสดงข้อมูลที่ ViewModel ของแอปเก็บไว้ในโครงสร้างข้อมูลที่สังเกตได้
ตัวอย่างฐานข้อมูล
ข้อมูลโค้ดต่อไปนี้แสดงวิธีต่างๆ ที่เป็นไปได้ในการทำให้ทุกส่วนทำงานร่วมกัน
การสังเกตข้อมูลที่มีการแบ่งหน้าโดยใช้ LiveData
ข้อมูลโค้ดต่อไปนี้แสดงองค์ประกอบทั้งหมดที่ทำงานร่วมกัน เมื่อมีการเพิ่ม นำออก หรือเปลี่ยนแปลงกิจกรรมคอนเสิร์ตในฐานข้อมูล เนื้อหาใน RecyclerView จะได้รับการอัปเดตโดยอัตโนมัติและมีประสิทธิภาพ ดังนี้
Kotlin
@Dao
interface ConcertDao {
// The Int type parameter tells Room to use a PositionalDataSource
// object, with position-based loading under the hood.
@Query("SELECT * FROM concerts ORDER BY date DESC")
fun concertsByDate(): DataSource.Factory<Int, Concert>
}
class ConcertViewModel(concertDao: ConcertDao) : ViewModel() {
val concertList: LiveData<PagedList<Concert>> =
concertDao.concertsByDate().toLiveData(pageSize = 50)
}
class ConcertActivity : AppCompatActivity() {
public override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// Use the 'by viewModels()' Kotlin property delegate
// from the activity-ktx artifact
val viewModel: ConcertViewModel by viewModels()
val recyclerView = findViewById(R.id.concert_list)
val adapter = ConcertAdapter()
viewModel.concertList.observe(this, PagedList(adapter::submitList))
recyclerView.setAdapter(adapter)
}
}
class ConcertAdapter() :
PagedListAdapter<Concert, ConcertViewHolder>(DIFF_CALLBACK) {
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 = object :
DiffUtil.ItemCallback<Concert>() {
// Concert details may have changed if reloaded from the database,
// but ID is fixed.
override fun areItemsTheSame(oldConcert: Concert,
newConcert: Concert) = oldConcert.id == newConcert.id
override fun areContentsTheSame(oldConcert: Concert,
newConcert: Concert) = oldConcert == newConcert
}
}
}
Java
@Dao
public interface ConcertDao {
// The Integer type parameter tells Room to use a PositionalDataSource
// object, with position-based loading under the hood.
@Query("SELECT * FROM concerts ORDER BY date DESC")
DataSource.Factory<Integer, Concert> concertsByDate();
}
public class ConcertViewModel extends ViewModel {
private ConcertDao concertDao;
public final LiveData<PagedList<Concert>> concertList;
public ConcertViewModel(ConcertDao concertDao) {
this.concertDao = concertDao;
concertList = new LivePagedListBuilder<>(
concertDao.concertsByDate(), /* page size */ 50).build();
}
}
public class ConcertActivity extends AppCompatActivity {
@Override
public void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
ConcertViewModel viewModel =
new ViewModelProvider(this).get(ConcertViewModel.class);
RecyclerView recyclerView = findViewById(R.id.concert_list);
ConcertAdapter adapter = new ConcertAdapter();
viewModel.concertList.observe(this, adapter::submitList);
recyclerView.setAdapter(adapter);
}
}
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);
if (concert != null) {
holder.bindTo(concert);
} else {
// Null defines a placeholder item - PagedListAdapter automatically
// invalidates this row when the actual object is loaded from the
// database.
holder.clear();
}
}
private static DiffUtil.ItemCallback<Concert> DIFF_CALLBACK =
new DiffUtil.ItemCallback<Concert>() {
// Concert details may have changed if reloaded from the database,
// but ID is fixed.
@Override
public boolean areItemsTheSame(Concert oldConcert, Concert newConcert) {
return oldConcert.getId() == newConcert.getId();
}
@Override
public boolean areContentsTheSame(Concert oldConcert,
Concert newConcert) {
return oldConcert.equals(newConcert);
}
};
}
การสังเกตข้อมูลที่มีการแบ่งหน้าโดยใช้ RxJava2
หากต้องการใช้ RxJava2 แทน LiveData คุณสามารถสร้างออบเจ็กต์ Observable หรือ Flowable แทนได้ ดังนี้
Kotlin
class ConcertViewModel(concertDao: ConcertDao) : ViewModel() {
val concertList: Observable<PagedList<Concert>> =
concertDao.concertsByDate().toObservable(pageSize = 50)
}
Java
public class ConcertViewModel extends ViewModel {
private ConcertDao concertDao;
public final Observable<PagedList<Concert>> concertList;
public ConcertViewModel(ConcertDao concertDao) {
this.concertDao = concertDao;
concertList = new RxPagedListBuilder<>(
concertDao.concertsByDate(), /* page size */ 50)
.buildObservable();
}
}
จากนั้นคุณจะเริ่มและหยุดสังเกตข้อมูลได้โดยใช้โค้ดในข้อมูลโค้ดต่อไปนี้
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()
private val disposable = CompositeDisposable()
public override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val recyclerView = findViewById(R.id.concert_list)
recyclerView.setAdapter(adapter)
}
override fun onStart() {
super.onStart()
disposable.add(viewModel.concertList
.subscribe(adapter::submitList)))
}
override fun onStop() {
super.onStop()
disposable.clear()
}
}
Java
public class ConcertActivity extends AppCompatActivity {
private ConcertAdapter adapter = new ConcertAdapter();
private ConcertViewModel viewModel;
private CompositeDisposable disposable = new CompositeDisposable();
@Override
public void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
RecyclerView recyclerView = findViewById(R.id.concert_list);
viewModel = new ViewModelProvider(this).get(ConcertViewModel.class);
recyclerView.setAdapter(adapter);
}
@Override
protected void onStart() {
super.onStart();
disposable.add(viewModel.concertList
.subscribe(adapter.submitList(flowableList)
));
}
@Override
protected void onStop() {
super.onStop();
disposable.clear();
}
}
โค้ดสำหรับ ConcertDao และ ConcertAdapter จะเหมือนกันสำหรับโซลูชันที่ใช้ RxJava2 เช่นเดียวกับโซลูชันที่ใช้ LiveData
แสดงความคิดเห็น
แชร์ความคิดเห็นและไอเดียของคุณกับเราผ่านแหล่งข้อมูลต่อไปนี้
- Issue Tracker

- รายงานปัญหาเพื่อให้เราแก้ไขข้อบกพร่องได้
แหล่งข้อมูลเพิ่มเติม
ดูข้อมูลเพิ่มเติมเกี่ยวกับไลบรารี Paging ได้ที่แหล่งข้อมูลต่อไปนี้
ตัวอย่าง
Codelab
วิดีโอ
- Android Jetpack: manage infinite lists with RecyclerView and Paging (Google I/O '18)
- Android Jetpack: เพจจิ้ง
แนะนำสำหรับคุณ
- หมายเหตุ: ข้อความลิงก์จะแสดงเมื่อ JavaScript ปิดอยู่
- ย้ายข้อมูลไปยัง Paging 3
- แสดงรายการแบบแบ่งหน้า
- รวบรวมข้อมูลที่มีการแบ่งหน้า