Alibaba Cloud SDK:Retry mechanism

リトライメカニズムの無効化

リトライメカニズムはデフォルトで無効になっています。 明示的に無効にするには、クライアントまたはリクエストレベルでリトライポリシーを none に設定します。

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

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

リトライポリシー

SDK は、3 種類のリトライ条件をサポートしています。

1. 例外の指定

2. HTTP ステータスコードの指定

3. HTTP レスポンスヘッダーの指定

これら 3 つの条件は独立しています。 いずれかの条件が満たされると、SDK はリクエストをリトライするか、リトライを停止します。 リトライをトリガーするポリシーと、リトライを制限するポリシーを作成できます。

次の例では、リトライをトリガーまたは制限するポリシーを設定する方法を示します：

• リトライポリシーコレクションの作成：

  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 = RetryPolicy.builder()
                  .maxNumberOfRetries(3) // 最大リトライ回数。
                  .maxDelayTimeMillis(20 * 1000) // 最大リトライ遅延時間 (ミリ秒) 。各リトライ試行の待機時間の上限です。待機時間がこの値を超えると、リクエストは失敗します。
                  .retryConditions(retryConditions) // リトライをトリガーするために使用されるポリシー。
                  .throttlingConditions(throttlingConditions) // リトライを制限するために使用されるポリシー。
                  .build();

リトライ間隔は、エクスポネンシャルバックオフアルゴリズムを使用して計算されます。 EqualJitter アルゴリズムは、各リトライ前の待機時間を決定します。

リトライ条件の高度な設定

次のセクションでは、3 つの組み込み条件タイプについて詳しく説明します：

1. StatusCodeCondition

   1. 整数のコレクションを格納します。 SDK は、各整数を返された HTTP ステータスコードと比較して、リトライをトリガーするか制限するかを決定します。

2. ExceptionsCondition

   1. 例外のコレクションを格納します。 SDK は、各例外を呼び出し中にスローされた例外と比較して、リトライをトリガーするか制限するかを決定します。

3. HeadersCondition

   1. 複雑な構造を持つマップを格納します。 マップキーはレスポンスヘッダーキーと一致し、値は Pattern (com.aliyuncs.policy.retry.pattern.Pattern) インターフェイスを使用して評価されます。 このパターンは、レスポンスヘッダーの値に特定の文字列が含まれているか、特定の値と等しいかを確認します。

   2. AliyunThrottlingPattern と SimplePattern の 2 つのパターンがサポートされています。 AliyunThrottlingPattern は、Alibaba Cloud が提供するスロットリングポリシーを適用します。 詳細については、「スロットリングポリシーに基づく高度なバックオフメカニズム」をご参照ください。 SimplePattern は、値が等しいかどうかを確認します。

   3. Pattern インターフェイスをカスタマイズするには、次の 3 つのメソッドを実装します：

      1. meetState()：ルールに一致した場合に true を返します。

      2. escapeTime()：エスケープ時間をミリ秒単位で返します。 このメソッドは、リトライ制限ポリシーにのみ適用されます。 戻り値が -1 でない場合、リトライは永続的に制限されるのではなく、指定された期間一時停止されます。 SDK は、エスケープ時間が経過するまで待ってからリトライします。 この値が最大リトライ間隔を超えると、リクエストはただちに失敗します。

      3. readFormHeadersContent(String content)：ヘッダーから値を解析して割り当てます。 SimplePattern の実装を直接再利用できます。

4. カスタム条件

   1. カスタム条件を作成するには、次の 2 つのメソッドを持つ RetryCondition インターフェイスを実装します：

      1. meetState(RetryPolicyContext var1)：コンテキストに基づいてリトライ条件が満たされているかどうかを評価します。

      2. escapeTime(RetryPolicyContext var1)：エスケープ時間を計算します。 このメソッドは制限ポリシーにのみ適用されます。 トリガーポリシーの場合は -1 を返します。