AWS SDK for Java
開発者ガイド

非同期プログラミング

同期または非同期のいずれかのメソッドを使用して、AWS のサービスのオペレーションを呼び出すことができます。同期メソッドは、クライアントがサービスからレスポンスを受信するまで、スレッドの実行をブロックします。非同期メソッドはすぐに応答を返し、レスポンスを待機せずに呼び出しスレッドに制御を戻します。

非同期メソッドはレスポンスが可能になる前に応答を返すため、準備ができたらレスポンスを得るための手段が必要になります。AWS SDK for Java には、Future オブジェクトコールバックメソッドの 2 つがあります。

Java Future

AWS SDK for Java の非同期メソッドは、将来の非同期オペレーションの結果を含む Future オブジェクトを返します。

Future isDone() メソッドを呼び出し、サービスが既に応答オブジェクトを提供したかどうかを確認します。レスポンスの準備が整うと、Future get() メソッドを呼び出して応答オブジェクトを取得できます。このメカニズムを使用して、アプリケーションで他の動作を続行しながら、定期的に非同期オペレーションの結果をポーリングできます。

次の例では、Lambda 関数を呼び出して InvokeResult オブジェクトを保持できる Future を受け取る非同期オペレーションを示します。InvokeResult オブジェクトは、isDone()true になった後に限り取得されます。

import com.amazonaws.services.lambda.AWSLambdaAsyncClient; import com.amazonaws.services.lambda.model.InvokeRequest; import com.amazonaws.services.lambda.model.InvokeResult; import java.nio.ByteBuffer; import java.util.concurrent.Future; import java.util.concurrent.ExecutionException; public class InvokeLambdaFunctionAsync { public static void main(String[] args) { String function_name = "HelloFunction"; String function_input = "{\"who\":\"AWS SDK for Java\"}"; AWSLambdaAsync lambda = AWSLambdaAsyncClientBuilder.defaultClient(); InvokeRequest req = new InvokeRequest() .withFunctionName(function_name) .withPayload(ByteBuffer.wrap(function_input.getBytes())); Future<InvokeResult> future_res = lambda.invokeAsync(req); System.out.print("Waiting for future"); while (future_res.isDone() == false) { System.out.print("."); try { Thread.sleep(1000); } catch (InterruptedException e) { System.err.println("\nThread.sleep() was interrupted!"); System.exit(1); } } try { InvokeResult res = future_res.get(); if (res.getStatusCode() == 200) { System.out.println("\nLambda function returned:"); ByteBuffer response_payload = res.getPayload(); System.out.println(new String(response_payload.array())); } else { System.out.format("Received a non-OK response from AWS: %d\n", res.getStatusCode()); } } catch (InterruptedException | ExecutionException e) { System.err.println(e.getMessage()); System.exit(1); } System.exit(0); } }

非同期コールバック

Java Future オブジェクトを使用して非同期リクエストのステータスをモニタリングすることに加え、SDK には AsyncHandler インターフェイスを使用するクラスを実装することができます。AsyncHandler では、リクエストがどのように完了したかに応じて呼び出される 2 つのメソッド、onSuccess および onError が提供されます。

コールバックインターフェイスアプローチの主な利点は、リクエストがいつ完了したかを調べるために Future オブジェクトをポーリングする必要がなくなることです。コードによってすぐに次のアクティビティを開始でき、また SDK に依存してハンドラを適時に呼び出すことができます。

import com.amazonaws.services.lambda.AWSLambdaAsync; import com.amazonaws.services.lambda.AWSLambdaAsyncClientBuilder; import com.amazonaws.services.lambda.model.InvokeRequest; import com.amazonaws.services.lambda.model.InvokeResult; import com.amazonaws.handlers.AsyncHandler; import java.nio.ByteBuffer; import java.util.concurrent.Future; public class InvokeLambdaFunctionCallback { private class AsyncLambdaHandler implements AsyncHandler<InvokeRequest, InvokeResult> { public void onSuccess(InvokeRequest req, InvokeResult res) { System.out.println("\nLambda function returned:"); ByteBuffer response_payload = res.getPayload(); System.out.println(new String(response_payload.array())); System.exit(0); } public void onError(Exception e) { System.out.println(e.getMessage()); System.exit(1); } } public static void main(String[] args) { String function_name = "HelloFunction"; String function_input = "{\"who\":\"AWS SDK for Java\"}"; AWSLambdaAsync lambda = AWSLambdaAsyncClientBuilder.defaultClient(); InvokeRequest req = new InvokeRequest() .withFunctionName(function_name) .withPayload(ByteBuffer.wrap(function_input.getBytes())); Future<InvokeResult> future_res = lambda.invokeAsync(req, new AsyncLambdaHandler()); System.out.print("Waiting for async callback"); while (!future_res.isDone() && !future_res.isCancelled()) { // perform some other tasks... try { Thread.sleep(1000); } catch (InterruptedException e) { System.err.println("Thread.sleep() was interrupted!"); System.exit(0); } System.out.print("."); } } }

ベストプラクティス

コールバックの実行

AsyncHandler の実装は、非同期クライアントが所有するスレッドプール内で実行されます。素早く実行される短いコードが AsyncHandler 実装内で最も適しています。ハンドラメソッド内の長期実行コードまたはブロックコードにより、非同期クライアントが使用するスレッドプールの競合が起こり、クライアントのリクエスト実行が妨げられる場合があります。コールバックで始める必要がある長期実行タスクがある場合は、コールバックを新しいスレッドで、またはアプリケーションが管理するスレッドプールで実行します。

スレッドプールの構成

AWS SDK for Java の非同期クライアントでは、ほとんどのアプリケーションで動作するデフォルトスレッドプールを利用できます。スレッドプールの管理方法をさらに制御するために、カスタムの ExecutorService を実装し、AWS SDK for Java の非同期クライアントに渡すことができます。

たとえば、カスタムの ThreadFactory を使用する ExecutorService 実装を提供し、プールのスレッドの命名方法を制御したり、スレッドの使用に関する追加情報のログを記録したりできます。

Amazon S3 非同期アクセス

SDK の TransferManager クラスは、Amazon S3 で非同期操作をするためのサポートを提供します。TransferManager は、非同期アップロードおよびダウンロードを管理して、転送の進行状況の詳細レポートを提供し、異なるイベントへのコールバックをサポートします。