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

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

@TargetSE(PARAMETERSE) @RetentionSE(RUNTIMESE) @DocumentedSE public @interface PathVariable
メソッドパラメーターを URI テンプレート変数にバインドする必要があることを示すアノテーション。RequestMapping アノテーション付きハンドラーメソッドでサポートされます。

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

導入:
3.0
作成者:
Arjen Poutsma, Juergen Hoeller
関連事項:

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

    オプション要素
    修飾子と型
    オプションの要素
    説明
    StringSE
    name
    バインドするパス変数の名前。
    boolean
    required
    パス変数が必要かどうか。
    StringSE
    value
    name() のエイリアス。

  • 要素の詳細

    • value

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

    • name

      @AliasFor("value") StringSE name
      バインドするパス変数の名前。
      導入:
      4.3.3
      デフォルト:
      ""

    • required

      boolean required
      パス変数が必要かどうか。

      デフォルトは true で、受信リクエストにパス変数がない場合に例外がスローされます。この場合、null または Java 8 java.util.Optional を使用する場合は、これを false に切り替えます。たとえば、異なるリクエストに対応する ModelAttribute メソッドなどです。

      導入:
      4.3.3
      デフォルト:
      true