Alibaba Cloud SDK:再試行メカニズム

コアライブラリ aliyun-java-sdk-core V4.6.0 以降では、再試行メカニズムがサポートされており、スロットリングポリシーに基づく高度なバックオフスキームが提供されています。詳細については、「スロットリングポリシーに基づく高度なバックオフメカニズム」をご参照ください。次の Maven 依存関係を追加する必要があります。

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-core</artifactId>
    <version>4.6.0</version>
</dependency>

// クライアントの再試行ポリシーを指定して、再試行メカニズムを無効にします。
client.setSysRetryPolicy(RetryPolicy.none());

// リクエストの再試行ポリシーを指定します。リクエストの再試行ポリシー設定は、クライアントの再試行ポリシー設定よりも優先されます。
request.setSysRetryPolicy(RetryPolicy.none());

Set<RetryCondition> retryConditions = new HashSet<RetryCondition>();

// 条件の例
// 再試行をトリガーするステータスコードを指定します。次の例では、ステータスコード 500 または 501 が返されたときに再試行が実行されます。
Set<Integer> statusCodes = new HashSet<Integer>();
statusCodes.add(500); // http ステータスコード
statusCodes.add(501); // http ステータスコード
// 再試行をトリガーするために使用されるポリシーにステータスコード設定を追加します。
retryConditions.add(StatusCodeCondition.create(statusCodes));

// 再試行をトリガーする例外を指定します。次の例では、SocketTimeoutException または IOException がスローされたときに再試行が実行されます。
Set<Class<?  extends Exception>> exceptions = new HashSet<Class<?  extends Exception>>();
exceptions.add(SocketTimeoutException.class); // 例外
exceptions.add(IOException.class); // 例外
// 再試行をトリガーするために使用されるポリシーに例外設定を追加します。
retryConditions.add(ExceptionsCondition.create(exceptions));

Set<RetryCondition> throttlingConditions = new HashSet<RetryCondition>();

// 条件の例
// 再試行を制限するステータスコードを指定します。次の例では、ステータスコード 429 が返されたときに再試行が禁止されます。
Set<Integer> code = new HashSet<Integer>();
code.add(429); // 再試行を制限する HTTP ステータスコードを指定します。この例では、ステータスコード 429 が返された場合、再試行は禁止されます。
// 再試行を制限するために使用されるポリシーにステータスコード設定を追加します。
throttlingConditions.add(StatusCodeCondition.create(code));

RetryPolicy retryPolicy = RetryPolicy.builder()
                .maxNumberOfRetries(3) // 最大再試行回数。
                .maxDelayTimeMillis(20 * 1000) // 最大再試行間隔。単位：ミリ秒。指定された時間を超えると、再試行は実行されません。
                .retryConditions(retryConditions) // 再試行をトリガーするために使用されるポリシー。
                . .throttlingConditions(throttlingConditions) // 再試行を制限するために使用されるポリシー。
                .build();

サンプルコード：

package com.aliyun.sample;

import com.aliyuncs.CommonRequest;
import com.aliyuncs.CommonResponse;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.exceptions.ThrottlingException;
import com.aliyuncs.policy.retry.RetryPolicy;
import com.aliyuncs.policy.retry.conditions.ExceptionsCondition;
import com.aliyuncs.policy.retry.conditions.RetryCondition;
import com.aliyuncs.policy.retry.conditions.StatusCodeCondition;
import com.aliyuncs.profile.DefaultProfile;

import java.io.IOException;
import java.net.SocketTimeoutException;
import java.util.HashSet;
import java.util.Set;

public class Sample {
    public static void main(String[] args) {
        // DefaultAcsClient インスタンスを作成し、インスタンスを初期化します。
        DefaultProfile profile = DefaultProfile.getProfile(
                // リージョン ID。
                "cn-hangzhou",
                // 環境変数から Resource Access Management (RAM) ユーザーの AccessKey ID を取得します。
                System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
                // 環境変数から RAM ユーザーの AccessKey Secret を取得します。
                System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        IAcsClient client = new DefaultAcsClient(profile);
        // クライアントの再試行ポリシーを指定します。
        client.setSysRetryPolicy(RetryPolicy.none());
        // 操作を呼び出します。この例では、CommonRequest が使用されています。Alibaba Cloud サービスの SDK にカプセル化された操作を呼び出す場合は、<APIName>Request を使用します。
        CommonRequest request = new CommonRequest();
        // リクエストの再試行ポリシーを指定します。リクエストの再試行ポリシー設定は、クライアントの再試行ポリシー設定よりも優先されます。
        // デフォルトの再試行ポリシーを使用し、高度なバックオフメカニズムを有効にします。
        // request.setSysRetryPolicy(RetryPolicy.defaultRetryPolicy(true));
        
        // カスタム再試行ポリシーを使用します。
        // 再試行をトリガーするステータスコードを指定します。
        Set<RetryCondition> retryConditions = new HashSet<RetryCondition>();
        Set<Integer> statusCodes = new HashSet<Integer>();
        statusCodes.add(500); // http ステータスコード
        statusCodes.add(501); // http ステータスコード
        retryConditions.add(StatusCodeCondition.create(statusCodes));

        // 再試行をトリガーする例外を指定します。
        Set<Class<?  extends Exception>> exceptions = new HashSet<Class<?  extends Exception>>();
        exceptions.add(SocketTimeoutException.class); // 例外
        exceptions.add(IOException.class); // 例外
        retryConditions.add(ExceptionsCondition.create(exceptions));

        // 再試行を制限するステータスコードを指定します。
        Set<RetryCondition> throttlingConditions = new HashSet<RetryCondition>();
        Set<Integer> code = new HashSet<Integer>();
        code.add(429); // 再試行を制限する HTTP ステータスコードを指定します。この例では、ステータスコード 429 が返された場合、再試行は禁止されます。
        throttlingConditions.add(StatusCodeCondition.create(code));

        RetryPolicy retryPolicy = RetryPolicy.builder()
                .maxNumberOfRetries(3) // 最大再試行回数。
                .maxDelayTimeMillis(20 * 1000) // 最大再試行間隔。間隔を超えると、再試行は実行されません。
                .retryConditions(retryConditions) // 再試行をトリガーするために使用されるポリシー。
                .enableAliyunThrottlingControl(true) // スロットリング制御のために Alibaba Cloud によって提供されるスロットリングポリシーを有効にします。
                .throttlingConditions(throttlingConditions) // 再試行を制限するための独自のポリシーを記述できます。
                .build();
        request.setSysRetryPolicy(retryPolicy);

        try {
            // 操作を呼び出します。この例では、CommonRequest が使用されています。Alibaba Cloud サービスの SDK にカプセル化された操作を呼び出す場合は、<APIName>Request を使用します。
            CommonResponse response = client.getCommonResponse(request);
            System.out.println(response.getData());
        } catch (ServerException e) {
            e.printStackTrace();
        } catch (ClientException e) {
            e.printStackTrace();
            if (ThrottlingException.class.isAssignableFrom(e.getCause().getClass())) {
                // スロットリング例外は ClientException にカプセル化されています。
            }
        }
    }
}