パッケージ org.springframework.web.bind.annotation

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

@TargetSE(PARAMETERSE) @RetentionSE(RUNTIMESE) @DocumentedSE public @interface RequestHeader
メソッドパラメーターを Web リクエストヘッダーにバインドする必要があることを示すアノテーション。

Spring MVC および Spring WebFlux のアノテーション付きハンドラーメソッドでサポートされています。

メソッドパラメーターが Map<String, String>SE、MultiValueMap<String, String>、HttpHeaders の場合、マップにはすべてのヘッダー名と値が入力されます。

導入:
3.0
作成者:
Juergen Hoeller, Sam Brannen
関連事項:

  • オプション要素の概要

    オプション要素
    修飾子と型
    オプションの要素
    説明
    StringSE
    defaultValue
    フォールバックとして使用するデフォルト値。
    StringSE
    name
    バインドするリクエストヘッダーの名前。
    boolean
    required
    ヘッダーが必要かどうか。
    StringSE
    value
    name() のエイリアス。

  • 要素の詳細

    • value

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

    • name

      @AliasFor("value") StringSE name
      バインドするリクエストヘッダーの名前。
      導入:
      4.2
      デフォルト:
      ""

    • required

      boolean required
      ヘッダーが必要かどうか。

      デフォルトは true で、リクエストにヘッダーがない場合は例外がスローされます。リクエストにヘッダーが存在しない場合に null 値を使用する場合は、false に切り替えます。

      または、defaultValue() を指定します。これにより、このフラグが暗黙的に false に設定されます。

      デフォルト:
      true

    • defaultValue

      StringSE defaultValue
      フォールバックとして使用するデフォルト値。

      デフォルト値を指定すると、required() が false に暗黙的に設定されます。

      デフォルト:
      "\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n"