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

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

@TargetSE(PARAMETERSE) @RetentionSE(RUNTIMESE) @DocumentedSE public @interface CookieValue
メソッドパラメーターが HTTPCookie にバインドされていることを示すアノテーション。

メソッドパラメーターは、CookieEE 型または Cookie 値型（String、int など）として宣言できます。

spring-webmvc 5.3.x 以前では、Cookie の値は URL でデコードされることに注意してください。これは 6.0 で変更されますが、その間に、アプリケーションは CookieEE 型のパラメーターを宣言して生の値にアクセスすることもできます。

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

  • オプション要素のサマリー

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

  • 要素の詳細

    • value

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

    • name

      @AliasFor("value") StringSE name
      バインドする Cookie の名前。
      導入:
      4.2
      デフォルト:
      ""

    • required

      boolean required
      Cookie が必要かどうか。

      デフォルトは true で、リクエストに Cookie がない場合は例外がスローされます。リクエストに Cookie が存在しない場合に 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"