รวบรวมข้อมูลที่แบ่งหน้า

เอกสารนี้ต่อยอดมาจากภาพรวมของไลบรารี Paging โดยจะพูดถึงวิธีปรับแต่งโซลูชันการโหลดข้อมูลของแอปให้ตรงกับความต้องการด้านสถาปัตยกรรมของแอป

สร้างรายการที่สังเกตได้

โดยปกติแล้ว โค้ด UI จะสังเกตออบเจ็กต์ LiveData<PagedList> (หรือหากคุณใช้ RxJava2 จะเป็นออบเจ็กต์ Flowable<PagedList> หรือ Observable<PagedList>) ซึ่งอยู่ใน ViewModel ของแอป ออบเจ็กต์ที่สังเกตได้นี้จะสร้างการเชื่อมต่อระหว่างการนำเสนอและเนื้อหาของข้อมูลรายการของแอป

หากต้องการสร้างออบเจ็กต์ PagedList ที่สังเกตได้เหล่านี้ ให้ส่งอินสแตนซ์ของ DataSource.Factory ไปยังออบเจ็กต์ LivePagedListBuilder หรือ RxPagedListBuilder ออบเจ็กต์ DataSource จะโหลดหน้าเว็บสำหรับ PagedList รายการเดียว คลาส Factory จะสร้างอินสแตนซ์ใหม่ของ PagedList เพื่อตอบสนองต่อการอัปเดตเนื้อหา เช่น การทำให้ตารางฐานข้อมูลใช้งานไม่ได้และการรีเฟรชเครือข่าย ไลบรารี Room Persistence สามารถจัดหาออบเจ็กต์ DataSource.Factory ให้คุณได้ หรือคุณจะสร้างขึ้นเองก็ได้

ข้อมูลโค้ดต่อไปนี้แสดงวิธีสร้างอินสแตนซ์ใหม่ของ LiveData<PagedList> ในคลาส ViewModel ของแอปโดยใช้ความสามารถในการสร้าง DataSource.Factory ของ Room

ConcertDao

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

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();
}

ConcertViewModel

Kotlin

// The Int type argument corresponds to a PositionalDataSource object.
val myConcertDataSource : DataSource.Factory<Int, Concert> =
       concertDao.concertsByDate()

val concertList = myConcertDataSource.toLiveData(pageSize = 50)

Java

// The Integer type argument corresponds to a PositionalDataSource object.
DataSource.Factory<Integer, Concert> myConcertDataSource =
       concertDao.concertsByDate();

LiveData<PagedList<Concert>> concertList =
        LivePagedListBuilder(myConcertDataSource, /* page size */ 50).build();

กำหนดการกำหนดค่าการเพจจิ้งของคุณเอง

หากต้องการกำหนดค่า LiveData<PagedList> เพิ่มเติมสำหรับกรณีขั้นสูง คุณยังกำหนดค่าการแบ่งหน้าของคุณเองได้ด้วย โดยเฉพาะอย่างยิ่ง คุณสามารถกำหนดแอตทริบิวต์ต่อไปนี้ได้

  • ขนาดหน้า: จำนวนรายการในแต่ละหน้า
  • ระยะทางในการดึงข้อมูลล่วงหน้า: เมื่อพิจารณาจากรายการที่มองเห็นได้รายการสุดท้ายใน UI ของแอป จำนวนรายการที่อยู่นอกเหนือรายการสุดท้ายนี้ที่ไลบรารีการแบ่งหน้าควรพยายามดึงข้อมูลล่วงหน้า ค่านี้ควรมากกว่าขนาดหน้าเว็บหลายเท่า
  • การแสดงตัวยึดตำแหน่ง: กำหนดว่า UI จะแสดงตัวยึดตำแหน่งสำหรับรายการที่ยังโหลดไม่เสร็จหรือไม่ ดูการพูดคุยเกี่ยวกับประโยชน์และข้อเสียของการใช้ตัวยึดตำแหน่งได้ที่หัวข้อวิธีระบุตัวยึดตำแหน่งใน UI

หากต้องการควบคุมเวลาที่ไลบรารีเพจจิ้งโหลดรายการจากฐานข้อมูลของแอปได้มากขึ้น ให้ส่งออบเจ็กต์ Executor ที่กำหนดเองไปยัง LivePagedListBuilder ดังที่แสดงในข้อมูลโค้ดต่อไปนี้

ConcertViewModel

Kotlin

val myPagingConfig = Config(
        pageSize = 50,
        prefetchDistance = 150,
        enablePlaceholders = true
)

// The Int type argument corresponds to a PositionalDataSource object.
val myConcertDataSource : DataSource.Factory<Int, Concert> =
        concertDao.concertsByDate()

val concertList = myConcertDataSource.toLiveData(
        pagingConfig = myPagingConfig,
        fetchExecutor = myExecutor
)

Java

PagedList.Config myPagingConfig = new PagedList.Config.Builder()
        .setPageSize(50)
        .setPrefetchDistance(150)
        .setEnablePlaceholders(true)
        .build();

// The Integer type argument corresponds to a PositionalDataSource object.
DataSource.Factory<Integer, Concert> myConcertDataSource =
        concertDao.concertsByDate();

LiveData<PagedList<Concert>> concertList =
        new LivePagedListBuilder<>(myConcertDataSource, myPagingConfig)
            .setFetchExecutor(myExecutor)
            .build();

เลือกประเภทแหล่งข้อมูลที่ถูกต้อง

คุณควรเชื่อมต่อกับแหล่งข้อมูลที่จัดการโครงสร้างข้อมูลต้นทางได้ดีที่สุด ดังนี้

  • ใช้ PageKeyedDataSource หากหน้าเว็บที่คุณโหลดฝังคีย์ถัดไปหรือก่อนหน้า เช่น หากคุณกำลังดึงข้อมูลโพสต์โซเชียลมีเดียจากเครือข่าย คุณอาจต้องส่งโทเค็น nextPage จากการโหลดหนึ่งไปยังการโหลดครั้งถัดไป
  • ใช้ ItemKeyedDataSource หากต้องการใช้ข้อมูลจากรายการ N เพื่อดึงข้อมูลรายการ N+1 เช่น หากคุณกำลังดึงข้อมูลความคิดเห็นที่เป็นชุดข้อความสำหรับแอปการสนทนา คุณอาจต้องส่งรหัสของความคิดเห็นล่าสุดเพื่อรับเนื้อหาของความคิดเห็นถัดไป
  • ใช้ PositionalDataSource หากต้องการดึงข้อมูลหน้าเว็บจากตำแหน่งใดก็ได้ที่คุณเลือกใน Datastore คลาสนี้รองรับการขอชุดรายการข้อมูลโดยเริ่มจากตำแหน่งใดก็ได้ที่คุณเลือก ตัวอย่างเช่น คำขออาจแสดงรายการข้อมูล 50 รายการโดยเริ่มจากตำแหน่ง 1500

แจ้งเตือนเมื่อข้อมูลไม่ถูกต้อง

เมื่อใช้ไลบรารี Paging ชั้นข้อมูลจะแจ้งเตือนชั้นอื่นๆ ของแอปเมื่อตารางหรือแถวไม่มีการอัปเดต โดยเรียกใช้ invalidate() จากคลาส DataSource ที่คุณเลือกไว้สำหรับแอป

สร้างแหล่งข้อมูลของคุณเอง

หากใช้โซลูชันข้อมูลผลิตภัณฑ์ในพื้นที่ที่กำหนดเอง หรือหากโหลดข้อมูลจากเครือข่ายโดยตรง คุณสามารถใช้คลาสย่อย DataSource รายการใดรายการหนึ่งได้ ข้อมูลโค้ดต่อไปนี้แสดงแหล่งข้อมูลที่คีย์จากเวลาเริ่มต้นของคอนเสิร์ตหนึ่งๆ

Kotlin

class ConcertTimeDataSource() :
        ItemKeyedDataSource<Date, Concert>() {
    override fun getKey(item: Concert) = item.startTime

    override fun loadInitial(
            params: LoadInitialParams<Date>,
            callback: LoadInitialCallback<Concert>) {
        val items = fetchItems(params.requestedInitialKey,
                params.requestedLoadSize)
        callback.onResult(items)
    }

    override fun loadAfter(
            params: LoadParams<Date>,
            callback: LoadCallback<Concert>) {
        val items = fetchItemsAfter(
            date = params.key,
            limit = params.requestedLoadSize)
        callback.onResult(items)
    }
}

Java

public class ConcertTimeDataSource
        extends ItemKeyedDataSource<Date, Concert> {
    @NonNull
    @Override
    public Date getKey(@NonNull Concert item) {
        return item.getStartTime();
    }

    @Override
    public void loadInitial(@NonNull LoadInitialParams<Date> params,
            @NonNull LoadInitialCallback<Concert> callback) {
        List<Concert> items =
            fetchItems(params.key, params.requestedLoadSize);
        callback.onResult(items);
    }

    @Override
    public void loadAfter(@NonNull LoadParams<Date> params,
            @NonNull LoadCallback<Concert> callback) {
        List<Concert> items =
            fetchItemsAfter(params.key, params.requestedLoadSize);
        callback.onResult(items);
    }
}

จากนั้นคุณสามารถโหลดข้อมูลที่กำหนดเองนี้ลงในออบเจ็กต์ PagedList ได้โดยการสร้างคลาสย่อยที่เป็นรูปธรรมของ DataSource.Factory ข้อมูลโค้ดต่อไปนี้แสดงวิธีสร้างอินสแตนซ์ใหม่ของแหล่งข้อมูลที่กำหนดเองซึ่งกำหนดไว้ในข้อมูลโค้ดก่อนหน้า

Kotlin

class ConcertTimeDataSourceFactory :
        DataSource.Factory<Date, Concert>() {
    val sourceLiveData = MutableLiveData<ConcertTimeDataSource>()
    var latestSource: ConcertDataSource?
    override fun create(): DataSource<Date, Concert> {
        latestSource = ConcertTimeDataSource()
        sourceLiveData.postValue(latestSource)
        return latestSource
    }
}

Java

public class ConcertTimeDataSourceFactory
        extends DataSource.Factory<Date, Concert> {
    private MutableLiveData<ConcertTimeDataSource> sourceLiveData =
            new MutableLiveData<>();

    private ConcertDataSource latestSource;

    @Override
    public DataSource<Date, Concert> create() {
        latestSource = new ConcertTimeDataSource();
        sourceLiveData.postValue(latestSource);
        return latestSource;
    }
}

พิจารณาวิธีการทำงานของการอัปเดตเนื้อหา

เมื่อสร้างออบเจ็กต์ PagedList ที่สังเกตได้ ให้พิจารณาวิธีการทำงานของการอัปเดตเนื้อหา หากคุณโหลดข้อมูลจากฐานข้อมูล Room โดยตรง ระบบจะพุชการอัปเดตไปยัง UI ของแอปโดยอัตโนมัติ

เมื่อใช้ API เครือข่ายที่มีการแบ่งหน้า โดยปกติแล้วคุณจะมีการโต้ตอบของผู้ใช้ เช่น "ปัดเพื่อรีเฟรช" ซึ่งทำหน้าที่เป็นสัญญาณสำหรับการทำให้ DataSource ที่คุณใช้ล่าสุดใช้งานไม่ได้ จากนั้นคุณจะขออินสแตนซ์ใหม่ของแหล่งข้อมูลนั้น ข้อมูลโค้ดต่อไปนี้แสดงลักษณะการทำงานนี้

Kotlin

class ConcertActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        // ...
        concertTimeViewModel.refreshState.observe(this, Observer {
            // Shows one possible way of triggering a refresh operation.
            swipeRefreshLayout.isRefreshing =
                    it == MyNetworkState.LOADING
        })
        swipeRefreshLayout.setOnRefreshListener {
            concertTimeViewModel.invalidateDataSource()
        }
    }
}

class ConcertTimeViewModel(firstConcertStartTime: Date) : ViewModel() {
    val dataSourceFactory = ConcertTimeDataSourceFactory(firstConcertStartTime)
    val concertList: LiveData<PagedList<Concert>> =
            dataSourceFactory.toLiveData(
                pageSize = 50,
                fetchExecutor = myExecutor
            )

    fun invalidateDataSource() =
            dataSourceFactory.sourceLiveData.value?.invalidate()
}

Java

public class ConcertActivity extends AppCompatActivity {
    @Override
    public void onCreate(@Nullable Bundle savedInstanceState) {
        // ...
        viewModel.getRefreshState()
                .observe(this, new Observer<NetworkState>() {
            // Shows one possible way of triggering a refresh operation.
            @Override
            public void onChanged(@Nullable MyNetworkState networkState) {
                swipeRefreshLayout.isRefreshing =
                        networkState == MyNetworkState.LOADING;
            }
        };

        swipeRefreshLayout.setOnRefreshListener(new SwipeRefreshListener() {
            @Override
            public void onRefresh() {
                viewModel.invalidateDataSource();
            }
        });
    }
}

public class ConcertTimeViewModel extends ViewModel {
    private LiveData<PagedList<Concert>> concertList;
    private DataSource<Date, Concert> mostRecentDataSource;

    public ConcertTimeViewModel(Date firstConcertStartTime) {
        ConcertTimeDataSourceFactory dataSourceFactory =
                new ConcertTimeDataSourceFactory(firstConcertStartTime);
        mostRecentDataSource = dataSourceFactory.create();
        concertList = new LivePagedListBuilder<>(dataSourceFactory, 50)
                .setFetchExecutor(myExecutor)
                .build();
    }

    public void invalidateDataSource() {
        mostRecentDataSource.invalidate();
    }
}

ระบุการแมปข้อมูล

ไลบรารีเพจจิ้งจะรองรับการเปลี่ยนรูปแบบตามรายการและตามหน้าของรายการที่โหลดโดย DataSource

ในข้อมูลโค้ดต่อไปนี้ ระบบจะแมปชุดค่าผสมของชื่อคอนเสิร์ตและวันที่จัดคอนเสิร์ตกับสตริงเดียวที่มีทั้งชื่อและวันที่

Kotlin

class ConcertViewModel : ViewModel() {
    val concertDescriptions : LiveData<PagedList<String>>
        init {
            val concerts = database.allConcertsFactory()
                    .map { "${it.name} - ${it.date}" }
                    .toLiveData(pageSize = 50)
        }
}

Java

public class ConcertViewModel extends ViewModel {
    private LiveData<PagedList<String>> concertDescriptions;

    public ConcertViewModel(MyDatabase database) {
        DataSource.Factory<Integer, Concert> factory =
                database.allConcertsFactory().map(concert ->
                    concert.getName() + "-" + concert.getDate());
        concertDescriptions = new LivePagedListBuilder<>(
            factory, /* page size */ 50).build();
    }
}

ซึ่งจะเป็นประโยชน์หากคุณต้องการรวม แปลง หรือเตรียมรายการหลังจากโหลดแล้ว เนื่องจากงานนี้ดำเนินการใน Fetch Executor คุณจึงสามารถทำงานที่อาจมีค่าใช้จ่ายสูงได้ เช่น การอ่านจากดิสก์หรือการค้นหาฐานข้อมูลแยกต่างหาก

แสดงความคิดเห็น

แชร์ความคิดเห็นและไอเดียของคุณกับเราผ่านแหล่งข้อมูลต่อไปนี้

Issue Tracker
รายงานปัญหาเพื่อให้เราแก้ไขข้อบกพร่องได้

แหล่งข้อมูลเพิ่มเติม

ดูข้อมูลเพิ่มเติมเกี่ยวกับไลบรารี Paging ได้จากแหล่งข้อมูลต่อไปนี้

ตัวอย่าง

Codelab

วิดีโอ