使用 AWS SDK for Java 2.x 處理分頁結果

當回應物件太大而無法在單一回應中傳回時，許多 AWS 操作會傳回分頁結果。在 AWS SDK for Java 1.0 中，回應包含您用來擷取結果下一頁的權杖。相反地， AWS SDK for Java 2.x 具有自動調適方法，可進行多次服務呼叫，以自動取得下一頁的結果。您只需編寫處理結果的程式碼即可。Autopagination 同時適用於同步和非同步用戶端。

注意

這些程式碼片段假設您了解使用 SDK 的基本概念，並已使用單一登入存取來設定您的環境。

同步分頁

下列範例示範同步分頁方法來列出儲存 Amazon S3 貯體中的物件。

反覆瀏覽頁面

第一個範例示範使用 listRes paginator 物件、ListObjectsV2Iterable執行個體，以 stream方法反覆瀏覽所有回應頁面。程式碼會在回應頁面上串流，將回應串流轉換為S3Object內容串流，然後處理 Amazon S3 物件的內容。

下列匯入適用於此同步分頁區段中的所有範例。



import java.io.IOException;
import java.nio.ByteBuffer;
import java.util.Random;

import software.amazon.awssdk.core.waiters.WaiterResponse;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.paginators.ListObjectsV2Iterable;
import software.amazon.awssdk.core.sync.RequestBody;
import software.amazon.awssdk.services.s3.model.S3Exception;
import software.amazon.awssdk.services.s3.model.PutObjectRequest;
import software.amazon.awssdk.services.s3.model.ListObjectsV2Request;
import software.amazon.awssdk.services.s3.model.ListObjectsV2Response;
import software.amazon.awssdk.services.s3.model.S3Object;
import software.amazon.awssdk.services.s3.model.GetObjectRequest;
import software.amazon.awssdk.services.s3.model.DeleteObjectRequest;
import software.amazon.awssdk.services.s3.model.DeleteBucketRequest;
import software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest;
import software.amazon.awssdk.services.s3.model.CreateMultipartUploadResponse;
import software.amazon.awssdk.services.s3.model.CompletedMultipartUpload;
import software.amazon.awssdk.services.s3.model.CreateBucketRequest;
import software.amazon.awssdk.services.s3.model.CompletedPart;
import software.amazon.awssdk.services.s3.model.CreateBucketConfiguration;
import software.amazon.awssdk.services.s3.model.UploadPartRequest;
import software.amazon.awssdk.services.s3.model.CompleteMultipartUploadRequest;
import software.amazon.awssdk.services.s3.waiters.S3Waiter;
import software.amazon.awssdk.services.s3.model.HeadBucketRequest;
import software.amazon.awssdk.services.s3.model.HeadBucketResponse;


        ListObjectsV2Request listReq = ListObjectsV2Request.builder()
            .bucket(bucketName)
            .maxKeys(1)
            .build();

        ListObjectsV2Iterable listRes = s3.listObjectsV2Paginator(listReq);
        // Process response pages
        listRes.stream()
            .flatMap(r -> r.contents().stream())
            .forEach(content -> System.out
                .println(" Key: " + content.key() + " size = " + content.size()));

請參閱 on GitHub 的完整範例。

反覆運算物件

以下範例示範如何逐一查看回應傳回的物件，而非回應的頁面。ListObjectsV2Iterable 類別contents方法會傳回 SdkIterable，提供數種處理基礎內容元素的方法。

使用串流

下列程式碼片段會在回應內容上使用 stream方法，以反覆執行分頁項目集合。


        // Helper method to work with paginated collection of items directly.
        listRes.contents().stream()
            .forEach(content -> System.out
                .println(" Key: " + content.key() + " size = " + content.size()));

請參閱 on GitHub 的完整範例。

使用 for-each 迴圈

由於 SdkIterable擴展了Iterable介面，因此您可以像任何一樣處理內容Iterable。下列程式碼片段使用標準for-each迴圈來反覆查看回應的內容。


        for (S3Object content : listRes.contents()) {
            System.out.println(" Key: " + content.key() + " size = " + content.size());
        }

請參閱 on GitHub 的完整範例。

手動分頁

如果您的使用案例有需要，也可以使用手動分頁。使用回應物件中的下一個符記以進行後續請求。下列範例使用while迴圈。


        ListObjectsV2Request listObjectsReqManual = ListObjectsV2Request.builder()
            .bucket(bucketName)
            .maxKeys(1)
            .build();

        boolean done = false;
        while (!done) {
            ListObjectsV2Response listObjResponse = s3.listObjectsV2(listObjectsReqManual);
            for (S3Object content : listObjResponse.contents()) {
                System.out.println(content.key());
            }

            if (listObjResponse.nextContinuationToken() == null) {
                done = true;
            }

            listObjectsReqManual = listObjectsReqManual.toBuilder()
                .continuationToken(listObjResponse.nextContinuationToken())
                .build();
        }

請參閱 on GitHub 的完整範例。

非同步分頁

下列範例示範列出 DynamoDB 資料表的非同步分頁方法。

在資料表名稱的頁面上迭代

下列兩個範例使用非同步 DynamoDB 用戶端，呼叫 listTablesPaginator方法並請求取得 ListTablesPublisher。 ListTablesPublisher實作兩個介面，提供許多處理回應的選項。我們將探討每個界面的方法。

使用 `Subscriber`

下列程式碼範例示範如何使用實作的org.reactivestreams.Publisher介面來處理分頁結果ListTablesPublisher。若要進一步了解被動串流模型，請參閱被動 Streams GitHub 儲存庫。

下列匯入適用於此非同步分頁區段中的所有範例。


import io.reactivex.rxjava3.core.Flowable;
import org.reactivestreams.Subscriber;
import org.reactivestreams.Subscription;
import reactor.core.publisher.Flux;
import software.amazon.awssdk.core.async.SdkPublisher;
import software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient;
import software.amazon.awssdk.services.dynamodb.model.ListTablesRequest;
import software.amazon.awssdk.services.dynamodb.model.ListTablesResponse;
import software.amazon.awssdk.services.dynamodb.paginators.ListTablesPublisher;

import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

下列程式碼會取得ListTablesPublisher執行個體。


        // Creates a default client with credentials and region loaded from the
        // environment.
        final DynamoDbAsyncClient asyncClient = DynamoDbAsyncClient.create();

        ListTablesRequest listTablesRequest = ListTablesRequest.builder().limit(3).build();
        ListTablesPublisher publisher = asyncClient.listTablesPaginator(listTablesRequest);

下列程式碼使用的匿名實作org.reactivestreams.Subscriber來處理每個頁面的結果。

onSubscribe 方法會呼叫 Subscription.request 方法以啟動向發佈者請求資料。必須呼叫這個方法，才能開始從發佈者取得資料。

訂閱者onNext的方法透過存取所有資料表名稱並列印每個資料表名稱來處理回應頁面。處理頁面後，會向發佈者請求另一個頁面。此方法會重複呼叫，直到擷取所有頁面為止。

如果擷取資料時發生錯誤，會觸發 onError 方法。最後，所有頁面都已請求完，會呼叫 onComplete 方法。


        // A Subscription represents a one-to-one life-cycle of a Subscriber subscribing
        // to a Publisher.
        publisher.subscribe(new Subscriber<ListTablesResponse>() {
            // Maintain a reference to the subscription object, which is required to request
            // data from the publisher.
            private Subscription subscription;

            @Override
            public void onSubscribe(Subscription s) {
                subscription = s;
                // Request method should be called to demand data. Here we request a single
                // page.
                subscription.request(1);
            }

            @Override
            public void onNext(ListTablesResponse response) {
                response.tableNames().forEach(System.out::println);
                // After you process the current page, call the request method to signal that
                // you are ready for next page.
                subscription.request(1);
            }

            @Override
            public void onError(Throwable t) {
                // Called when an error has occurred while processing the requests.
            }

            @Override
            public void onComplete() {
                // This indicates all the results are delivered and there are no more pages
                // left.
            }
        });

請參閱 on GitHub 的完整範例。

使用 `Consumer`

ListTablesPublisher 實作的SdkPublisher介面具有一種subscribe方法，其採用 Consumer並傳回 CompletableFuture<Void>。

來自此界面subscribe的方法可用於簡單的使用案例，而 org.reactivestreams.Subscriber可能太多額外負荷。由於下列程式碼會耗用每個頁面，因此會呼叫每個頁面上tableNames的方法。此tableNames方法會傳回使用 forEach方法處理的 DynamoDB 資料表名稱java.util.List的。


        // Use a Consumer for simple use cases.
        CompletableFuture<Void> future = publisher.subscribe(
                response -> response.tableNames()
                        .forEach(System.out::println));

請參閱 on GitHub 的完整範例。

在資料表名稱上反覆運算

以下範例示範如何逐一查看回應傳回的物件，而非回應的頁面。類似於先前與其contents方法一起顯示的同步 Amazon S3 範例，DynamoDB 非同步結果類別ListTablesPublisher具有與基礎項目集合互動的tableNames便利方法。tableNames 方法的傳回類型是 SdkPublisher，可用於在所有頁面上請求項目。

使用 `Subscriber`

下列程式碼會取得資料表名稱基礎集合SdkPublisher的。


        // Create a default client with credentials and region loaded from the
        // environment.
        final DynamoDbAsyncClient asyncClient = DynamoDbAsyncClient.create();

        ListTablesRequest listTablesRequest = ListTablesRequest.builder().limit(3).build();
        ListTablesPublisher listTablesPublisher = asyncClient.listTablesPaginator(listTablesRequest);
        SdkPublisher<String> publisher = listTablesPublisher.tableNames();

下列程式碼使用的匿名實作org.reactivestreams.Subscriber來處理每個頁面的結果。

訂閱者onNext的方法會處理集合的個別元素。在這種情況下，這是資料表名稱。處理資料表名稱後，會從發佈者請求另一個資料表名稱。在擷取所有資料表名稱之前，重複呼叫此方法。


        // Use a Subscriber.
        publisher.subscribe(new Subscriber<String>() {
            private Subscription subscription;

            @Override
            public void onSubscribe(Subscription s) {
                subscription = s;
                subscription.request(1);
            }

            @Override
            public void onNext(String tableName) {
                System.out.println(tableName);
                subscription.request(1);
            }

            @Override
            public void onError(Throwable t) {
            }

            @Override
            public void onComplete() {
            }
        });

請參閱 on GitHub 的完整範例。

使用 `Consumer`

下列範例使用 subscribe的方法SdkPublisher，需要 Consumer來處理每個項目。


        // Use a Consumer.
        CompletableFuture<Void> future = publisher.subscribe(System.out::println);
        future.get();

請參閱 on GitHub 的完整範例。

使用第三方程式庫

您可以使用其他第三方程式庫，而非實作自訂的訂閱者。此範例示範 RxJava 的使用，但任何實作被動串流介面的程式庫都可以使用。如需該程式庫的詳細資訊，請參閱 RxJava 上的 GitHub wiki 頁面。

若要使用該程式庫，請將其新增做為相依性。如果使用 Maven，範例會顯示要使用的 POM 程式碼片段。

POM項目


<dependency>
      <groupId>io.reactivex.rxjava3</groupId>
      <artifactId>rxjava</artifactId>
      <version>3.1.6</version>
</dependency>

Code


        DynamoDbAsyncClient asyncClient = DynamoDbAsyncClient.create();
        ListTablesPublisher publisher = asyncClient.listTablesPaginator(ListTablesRequest.builder()
                .build());

        // The Flowable class has many helper methods that work with
        // an implementation of an org.reactivestreams.Publisher.
        List<String> tables = Flowable.fromPublisher(publisher)
                .flatMapIterable(ListTablesResponse::tableNames)
                .toList()
                .blockingGet();
        System.out.println(tables);

請參閱 on GitHub 的完整範例。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

使用 SDK 功能

資源狀態的輪詢

使用 AWS SDK for Java 2.x 處理分頁結果

注意

同步分頁

反覆瀏覽頁面

反覆運算物件

使用串流

使用 for-each 迴圈

手動分頁

非同步分頁

在資料表名稱的頁面上迭代

使用 Subscriber

使用 Consumer

在資料表名稱上反覆運算

使用 Subscriber

使用 Consumer

使用第三方程式庫

使用 `Subscriber`

使用 `Consumer`

使用 `Subscriber`

使用 `Consumer`