パッケージ org.springframework.messaging.handler.annotation

アノテーションインターフェース Payload

@TargetSE({PARAMETERSE,METHODSE}) @RetentionSE(RUNTIMESE) @DocumentedSE public @interface Payload
メソッドパラメーターをメッセージのペイロードにバインドするアノテーション。ペイロードをメソッド呼び出しに関連付けるためにも使用できます。ペイロードは、MessageConverter を介して渡され、特定の MIME 型を持つ直列化された形式から、ターゲットメソッドパラメーターに一致するオブジェクトに変換されます。
導入:
4.0
作成者:
Rossen Stoyanchev, Sam Brannen

  • オプション要素の概要

    オプション要素
    修飾子と型
    オプションの要素
    説明
    StringSE
    expression
    ペイロードオブジェクトに対してルートコンテキストとして評価される SpEL 式。
    boolean
    required
    ペイロードコンテンツが必要かどうか。
    StringSE
    value
    expression() のエイリアス。

  • 要素の詳細

    • value

      @AliasFor("expression") StringSE value
      expression() のエイリアス。
      デフォルト:
      ""

    • expression

      @AliasFor("value") StringSE expression
      ペイロードオブジェクトに対してルートコンテキストとして評価される SpEL 式。

      この属性は、処理されるメッセージのペイロードとして非プリミティブオブジェクトが含まれているか、直列化された形式であり、メッセージ変換が必要かどうかによって、サポートされる場合とサポートされない場合があります。

      この属性は、次の場合にはサポートされていません:

      • STOMP over WebSocket メッセージ
      • RSocket インターフェースクライアント
      導入:
      4.2
      デフォルト:
      ""

    • required

      boolean required
      ペイロードコンテンツが必要かどうか。

      デフォルトは true で、ペイロードがない場合は例外が発生します。ペイロードがない場合に null を渡すには、false に切り替えます。

      デフォルト:
      true