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


@TargetSE(PARAMETERSE) @RetentionSE(RUNTIMESE) @DocumentedSE public @interface SessionAttribute
メソッドパラメーターをセッション属性にバインドするためのアノテーション。

主な動機は、オプション / 必須チェックとターゲットメソッドパラメーター型へのキャストを使用して、既存の永続的なセッション属性(ユーザー認証オブジェクトなど)への便利なアクセスを提供することです。

セッション属性の追加または削除が必要なユースケースでは、org.springframework.web.context.request.WebRequest または jakarta.servlet.http.HttpSession をコントローラーメソッドに挿入することを検討してください。

コントローラーのワークフローの一部としてセッションでモデル属性を一時的に保存する場合は、代わりに SessionAttributes の使用を検討してください。

導入:
4.3
作成者:
Rossen Stoyanchev
関連事項:
  • オプション要素のサマリー

    オプション要素
    修飾子と型
    オプションの要素
    説明
    バインドするセッション属性の名前。
    boolean
    セッション属性が必要かどうか。
    name() のエイリアス。
  • 要素の詳細

    • value

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

      @AliasFor("value") StringSE name
      バインドするセッション属性の名前。

      デフォルトの名前は、メソッドのパラメーター名から推測されます。

      デフォルト:
      ""
    • required

      boolean required
      セッション属性が必要かどうか。

      デフォルトは true で、属性がセッションにないか、セッションがない場合に例外がスローされます。属性が存在しない場合に null または Java 8 java.util.Optional を使用する場合は、これを false に切り替えます。

      デフォルト:
      true