クラス RepublishMessageRecoverer

java.lang.ObjectSE
org.springframework.amqp.rabbit.retry.RepublishMessageRecoverer
実装済みのインターフェース一覧:
MessageRecoverer
既知の直属サブクラス
RepublishMessageRecovererWithConfirms
public class RepublishMessageRecoverer extends ObjectSE implements MessageRecoverer
MessageRecoverer の実装では、例外メッセージとスタックトレース (includeStackTrace(boolean) でオプトインされている場合) をメッセージヘッダーに格納して、回復したメッセージを指定された交換所に再発行します。 "x-exception-message" と X_EXCEPTION_STACKTRACE です。

ルーティングキーが指定されていない場合、メッセージの元のルーティングキーに setErrorRoutingKeyPrefix(String) (デフォルトの "error." ) がプレフィックスとして付けられ、名前で指定された交換にメッセージを発行するために使用されます。何も設定されていない場合は、テンプレートのデフォルトの交換に発行されます。

導入:
1.3
作成者:
James Carr, Gary Russell, Artem Bilan, Rene Choi

  • フィールドの詳細

  • コンストラクターの詳細

    • RepublishMessageRecoverer

      public RepublishMessageRecoverer(AmqpTemplate errorTemplate)
      提供されたテンプレートを使用してインスタンスを作成します。
      パラメーター:
      errorTemplate - テンプレート。

    • RepublishMessageRecoverer

      public RepublishMessageRecoverer(AmqpTemplate errorTemplate, StringSE errorExchange)
      提供されたプロパティでインスタンスを作成します。
      パラメーター:
      errorTemplate - テンプレート。
      errorExchange - 交換。

    • RepublishMessageRecoverer

      public RepublishMessageRecoverer(AmqpTemplate errorTemplate, @Nullable StringSE errorExchange, @Nullable StringSE errorRoutingKey)
      指定されたプロパティでインスタンスを作成します。交換キーまたはルーティングキーが null の場合、テンプレートのデフォルトが使用されます。
      パラメーター:
      errorTemplate - テンプレート。
      errorExchange - 交換。
      errorRoutingKey - ルーティングキー。

    • RepublishMessageRecoverer

      public RepublishMessageRecoverer(AmqpTemplate errorTemplate, @Nullable Expression errorExchange, @Nullable Expression errorRoutingKey)
      指定されたプロパティでインスタンスを作成します。交換キーまたはルーティングキーが null と評価された場合、テンプレートのデフォルトが使用されます。
      パラメーター:
      errorTemplate - テンプレート。
      errorExchange - メッセージに対して評価される交換式。
      errorRoutingKey - メッセージに対して評価されるルーティングキー。

  • 方法の詳細

    • errorRoutingKeyPrefix

      public RepublishMessageRecoverer errorRoutingKeyPrefix(StringSE errorRoutingKeyPrefix)
      送信ルーティングキーにプレフィックスを適用します。このプレフィックスは、元のメッセージルーティングキーにプレフィックスとして追加されます（コンストラクターで明示的なルーティングキーが指定されていない場合、プレフィックスは無視されます）。プレフィックスを付けない場合は、空の文字列（""）を使用します。
      パラメーター:
      errorRoutingKeyPrefix - プレフィックス (デフォルトは "error." )。
      戻り値:
      this。

    • frameMaxHeadroom

      public RepublishMessageRecoverer frameMaxHeadroom(int headroom)
      スタックトレースヘッダーの切り捨てを考慮するときに、ネゴシエートされた frame_max を削減する量を設定します。デフォルトは 20000 です。
      パラメーター:
      headroom - ヘッドルーム
      戻り値:
      this。
      導入:
      2.0.5

    • includeStackTrace

      public RepublishMessageRecoverer includeStackTrace(boolean includeStackTrace)
      true を設定すると、エラースタックトレースを含むヘッダーが追加されます。ネゴシエートされた frame_max から切り捨て制限を解決できない場合、スタックトレースは切り捨てられずに公開されます。
      パラメーター:
      includeStackTrace - true にエラーのスタックトレースを含むヘッダーを追加します。
      戻り値:
      this。
      導入:
      4.0.5

    • setErrorRoutingKeyPrefix

      public void setErrorRoutingKeyPrefix(StringSE errorRoutingKeyPrefix)
      パラメーター:
      errorRoutingKeyPrefix - プレフィックス (デフォルトは "error." )。
      関連事項:

    • getErrorRoutingKeyPrefix

      protected StringSE getErrorRoutingKeyPrefix()

    • setDeliveryMode

      public void setDeliveryMode(MessageDeliveryMode deliveryMode)
      メッセージに MessageDeliveryMode が設定されていない場合は、再発行するメッセージに設定する MessageDeliveryMode を指定します。
      パラメーター:
      deliveryMode - メッセージに設定する配信モード。
      導入:
      2.0

    • getDeliveryMode

      protected MessageDeliveryMode getDeliveryMode()

    • recover

      public void recover(Message message, @Nullable ThrowableSE cause)
      インターフェースからコピーされた説明: MessageRecoverer
      消費されましたが再試行がすべて失敗したメッセージのコールバック。
      次で指定:
      インターフェース MessageRecoverer 内の recover 
      パラメーター:
      message - 回復へのメッセージ
      cause - エラーの原因

    • doSend

      protected void doSend(@Nullable StringSE exchange, StringSE routingKey, Message message)
      メッセージを送信します。
      パラメーター:
      exchange - テンプレートのデフォルトを使用する場合は exchange または null。
      routingKey - ルーティングキー。
      message - メッセージ。
      導入:
      2.3.3

    • additionalHeaders

      protected @Nullable MapSE<? extends StringSE, ?> additionalHeaders(Message message, @Nullable ThrowableSE cause)
      サブクラスは、このメソッドをオーバーライドして、再発行されたメッセージにヘッダーを追加できます。
      パラメーター:
      message - 失敗したメッセージ。
      cause - 原因。
      戻り値:
      追加する追加ヘッダーの MapSE。

    • prefixedOriginalRoutingKey

      protected StringSE prefixedOriginalRoutingKey(Message message)
      このメソッドのデフォルトの動作は、受信したルーティングキーを routingKeyPrefix に追加することです。これは、ルーティングキーが null の場合にのみ呼び出されます。
      パラメーター:
      message - メッセージ。
      戻り値:
      ルーティングキー。

    • getStackTraceAsString

      protected StringSE getStackTraceAsString(ThrowableSE cause)
      スタックトレースの文字列表現を作成します。
      パラメーター:
      cause - スローアブル。
      戻り値:
      文字列。
      導入:
      2.4.8